| { |
| "version": "v1", |
| "schemas": { |
| "WmxSitemapContent": { |
| "id": "WmxSitemapContent", |
| "description": "Information about the various content types in the sitemap.", |
| "properties": { |
| "indexed": { |
| "format": "int64", |
| "description": "The number of URLs from the sitemap that were indexed (of the content type).", |
| "type": "string" |
| }, |
| "type": { |
| "description": "The specific type of content in this sitemap. For example: `web`.", |
| "type": "string", |
| "enum": [ |
| "WEB", |
| "IMAGE", |
| "VIDEO", |
| "NEWS", |
| "MOBILE", |
| "ANDROID_APP", |
| "PATTERN", |
| "IOS_APP", |
| "DATA_FEED_ELEMENT" |
| ], |
| "enumDescriptions": [ |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "Unsupported content type.", |
| "", |
| "Unsupported content type." |
| ] |
| }, |
| "submitted": { |
| "type": "string", |
| "format": "int64", |
| "description": "The number of URLs in the sitemap (of the content type)." |
| } |
| }, |
| "type": "object" |
| }, |
| "MobileFriendlyIssue": { |
| "id": "MobileFriendlyIssue", |
| "properties": { |
| "rule": { |
| "enum": [ |
| "MOBILE_FRIENDLY_RULE_UNSPECIFIED", |
| "USES_INCOMPATIBLE_PLUGINS", |
| "CONFIGURE_VIEWPORT", |
| "FIXED_WIDTH_VIEWPORT", |
| "SIZE_CONTENT_TO_VIEWPORT", |
| "USE_LEGIBLE_FONT_SIZES", |
| "TAP_TARGETS_TOO_CLOSE" |
| ], |
| "description": "Rule violated.", |
| "type": "string", |
| "enumDescriptions": [ |
| "Unknown rule. Sorry, we don't have any description for the rule that was broken.", |
| "Plugins incompatible with mobile devices are being used. [Learn more] (https://support.google.com/webmasters/answer/6352293#flash_usage).", |
| "Viewsport is not specified using the meta viewport tag. [Learn more] (https://support.google.com/webmasters/answer/6352293#viewport_not_configured).", |
| "Viewport defined to a fixed width. [Learn more] (https://support.google.com/webmasters/answer/6352293#fixed-width_viewport).", |
| "Content not sized to viewport. [Learn more] (https://support.google.com/webmasters/answer/6352293#content_not_sized_to_viewport).", |
| "Font size is too small for easy reading on a small screen. [Learn More] (https://support.google.com/webmasters/answer/6352293#small_font_size).", |
| "Touch elements are too close to each other. [Learn more] (https://support.google.com/webmasters/answer/6352293#touch_elements_too_close)." |
| ] |
| } |
| }, |
| "description": "Mobile-friendly issue.", |
| "type": "object" |
| }, |
| "SitemapsListResponse": { |
| "description": "List of sitemaps.", |
| "type": "object", |
| "id": "SitemapsListResponse", |
| "properties": { |
| "sitemap": { |
| "type": "array", |
| "description": "Contains detailed information about a specific URL submitted as a [sitemap](https://support.google.com/webmasters/answer/156184).", |
| "items": { |
| "$ref": "WmxSitemap" |
| } |
| } |
| } |
| }, |
| "ResourceIssue": { |
| "description": "Information about a resource with issue.", |
| "type": "object", |
| "id": "ResourceIssue", |
| "properties": { |
| "blockedResource": { |
| "description": "Describes a blocked resource issue.", |
| "$ref": "BlockedResource" |
| } |
| } |
| }, |
| "ApiDimensionFilterGroup": { |
| "description": "A set of dimension value filters to test against each row. Only rows that pass all filter groups will be returned. All results within a filter group are either AND'ed or OR'ed together, depending on the group type selected. All filter groups are AND'ed together.", |
| "properties": { |
| "filters": { |
| "type": "array", |
| "items": { |
| "$ref": "ApiDimensionFilter" |
| } |
| }, |
| "groupType": { |
| "enum": [ |
| "AND" |
| ], |
| "type": "string", |
| "enumDescriptions": [ |
| "" |
| ] |
| } |
| }, |
| "type": "object", |
| "id": "ApiDimensionFilterGroup" |
| }, |
| "RunMobileFriendlyTestResponse": { |
| "description": "Mobile-friendly test response, including mobile-friendly issues and resource issues.", |
| "type": "object", |
| "id": "RunMobileFriendlyTestResponse", |
| "properties": { |
| "resourceIssues": { |
| "type": "array", |
| "items": { |
| "$ref": "ResourceIssue" |
| }, |
| "description": "Information about embedded resources issues." |
| }, |
| "testStatus": { |
| "$ref": "TestStatus", |
| "description": "Final state of the test, can be either complete or an error." |
| }, |
| "mobileFriendlyIssues": { |
| "description": "List of mobile-usability issues.", |
| "items": { |
| "$ref": "MobileFriendlyIssue" |
| }, |
| "type": "array" |
| }, |
| "mobileFriendliness": { |
| "enumDescriptions": [ |
| "Internal error when running this test. Please try running the test again.", |
| "The page is mobile friendly.", |
| "The page is not mobile friendly." |
| ], |
| "type": "string", |
| "description": "Test verdict, whether the page is mobile friendly or not.", |
| "enum": [ |
| "MOBILE_FRIENDLY_TEST_RESULT_UNSPECIFIED", |
| "MOBILE_FRIENDLY", |
| "NOT_MOBILE_FRIENDLY" |
| ] |
| }, |
| "screenshot": { |
| "description": "Screenshot of the requested URL.", |
| "$ref": "Image" |
| } |
| } |
| }, |
| "Image": { |
| "type": "object", |
| "description": "Describe image data.", |
| "properties": { |
| "data": { |
| "format": "byte", |
| "type": "string", |
| "description": "Image data in format determined by the mime type. Currently, the format will always be \"image/png\", but this might change in the future." |
| }, |
| "mimeType": { |
| "type": "string", |
| "description": "The mime-type of the image data." |
| } |
| }, |
| "id": "Image" |
| }, |
| "WmxSitemap": { |
| "type": "object", |
| "id": "WmxSitemap", |
| "description": "Contains detailed information about a specific URL submitted as a [sitemap](https://support.google.com/webmasters/answer/156184).", |
| "properties": { |
| "path": { |
| "description": "The url of the sitemap.", |
| "type": "string" |
| }, |
| "warnings": { |
| "format": "int64", |
| "description": "Number of warnings for the sitemap. These are generally non-critical issues with URLs in the sitemaps.", |
| "type": "string" |
| }, |
| "lastDownloaded": { |
| "type": "string", |
| "format": "google-datetime", |
| "description": "Date & time in which this sitemap was last downloaded. Date format is in RFC 3339 format (yyyy-mm-dd)." |
| }, |
| "contents": { |
| "description": "The various content types in the sitemap.", |
| "items": { |
| "$ref": "WmxSitemapContent" |
| }, |
| "type": "array" |
| }, |
| "type": { |
| "description": "The type of the sitemap. For example: `rssFeed`.", |
| "enum": [ |
| "NOT_SITEMAP", |
| "URL_LIST", |
| "SITEMAP", |
| "RSS_FEED", |
| "ATOM_FEED", |
| "PATTERN_SITEMAP", |
| "OCEANFRONT" |
| ], |
| "type": "string", |
| "enumDescriptions": [ |
| "", |
| "", |
| "", |
| "", |
| "", |
| "Unsupported sitemap types.", |
| "" |
| ] |
| }, |
| "lastSubmitted": { |
| "format": "google-datetime", |
| "type": "string", |
| "description": "Date & time in which this sitemap was submitted. Date format is in RFC 3339 format (yyyy-mm-dd)." |
| }, |
| "isPending": { |
| "type": "boolean", |
| "description": "If true, the sitemap has not been processed." |
| }, |
| "errors": { |
| "type": "string", |
| "description": "Number of errors in the sitemap. These are issues with the sitemap itself that need to be fixed before it can be processed correctly.", |
| "format": "int64" |
| }, |
| "isSitemapsIndex": { |
| "description": "If true, the sitemap is a collection of sitemaps.", |
| "type": "boolean" |
| } |
| } |
| }, |
| "BlockedResource": { |
| "properties": { |
| "url": { |
| "type": "string", |
| "description": "URL of the blocked resource." |
| } |
| }, |
| "id": "BlockedResource", |
| "type": "object", |
| "description": "Blocked resource." |
| }, |
| "SitesListResponse": { |
| "id": "SitesListResponse", |
| "type": "object", |
| "description": "List of sites with access level information.", |
| "properties": { |
| "siteEntry": { |
| "type": "array", |
| "description": "Contains permission level information about a Search Console site. For more information, see [Permissions in Search Console](https://support.google.com/webmasters/answer/2451999).", |
| "items": { |
| "$ref": "WmxSite" |
| } |
| } |
| } |
| }, |
| "WmxSite": { |
| "id": "WmxSite", |
| "properties": { |
| "siteUrl": { |
| "description": "The URL of the site.", |
| "type": "string" |
| }, |
| "permissionLevel": { |
| "type": "string", |
| "enumDescriptions": [ |
| "", |
| "Owner has complete access to the site.", |
| "Full users can access all data, and perform most of the operations.", |
| "Restricted users can access most of the data, and perform some operations.", |
| "Unverified user has no access to site's data." |
| ], |
| "enum": [ |
| "SITE_PERMISSION_LEVEL_UNSPECIFIED", |
| "SITE_OWNER", |
| "SITE_FULL_USER", |
| "SITE_RESTRICTED_USER", |
| "SITE_UNVERIFIED_USER" |
| ], |
| "description": "The user's permission level for the site." |
| } |
| }, |
| "description": "Contains permission level information about a Search Console site. For more information, see [Permissions in Search Console](https://support.google.com/webmasters/answer/2451999).", |
| "type": "object" |
| }, |
| "ApiDataRow": { |
| "properties": { |
| "impressions": { |
| "type": "number", |
| "format": "double" |
| }, |
| "position": { |
| "type": "number", |
| "format": "double" |
| }, |
| "keys": { |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "ctr": { |
| "type": "number", |
| "format": "double" |
| }, |
| "clicks": { |
| "format": "double", |
| "type": "number" |
| } |
| }, |
| "id": "ApiDataRow", |
| "type": "object" |
| }, |
| "TestStatus": { |
| "id": "TestStatus", |
| "type": "object", |
| "properties": { |
| "status": { |
| "enumDescriptions": [ |
| "Internal error when running this test. Please try running the test again.", |
| "Inspection has completed without errors.", |
| "Inspection terminated in an error state. This indicates a problem in Google's infrastructure, not a user error. Please try again later.", |
| "Google can not access the URL because of a user error such as a robots.txt blockage, a 403 or 500 code etc. Please make sure that the URL provided is accessible by Googlebot and is not password protected." |
| ], |
| "enum": [ |
| "TEST_STATUS_UNSPECIFIED", |
| "COMPLETE", |
| "INTERNAL_ERROR", |
| "PAGE_UNREACHABLE" |
| ], |
| "description": "Status of the test.", |
| "type": "string" |
| }, |
| "details": { |
| "type": "string", |
| "description": "Error details if applicable." |
| } |
| }, |
| "description": "Final state of the test, including error details if necessary." |
| }, |
| "SearchAnalyticsQueryRequest": { |
| "type": "object", |
| "properties": { |
| "searchType": { |
| "description": "[Optional; Default is \\\"web\\\"] The search type to filter for.", |
| "enumDescriptions": [ |
| "", |
| "", |
| "" |
| ], |
| "type": "string", |
| "enum": [ |
| "WEB", |
| "IMAGE", |
| "VIDEO" |
| ] |
| }, |
| "dimensionFilterGroups": { |
| "type": "array", |
| "items": { |
| "$ref": "ApiDimensionFilterGroup" |
| }, |
| "description": "[Optional] Zero or more filters to apply to the dimension grouping values; for example, 'query contains \\\"buy\\\"' to see only data where the query string contains the substring \\\"buy\\\" (not case-sensitive). You can filter by a dimension without grouping by it." |
| }, |
| "rowLimit": { |
| "type": "integer", |
| "format": "int32", |
| "description": "[Optional; Default is 1000] The maximum number of rows to return. Must be a number from 1 to 25,000 (inclusive)." |
| }, |
| "endDate": { |
| "type": "string", |
| "description": "[Required] End date of the requested date range, in YYYY-MM-DD format, in PST (UTC - 8:00). Must be greater than or equal to the start date. This value is included in the range." |
| }, |
| "startRow": { |
| "description": "[Optional; Default is 0] Zero-based index of the first row in the response. Must be a non-negative number.", |
| "type": "integer", |
| "format": "int32" |
| }, |
| "startDate": { |
| "type": "string", |
| "description": " [Required] Start date of the requested date range, in YYYY-MM-DD format, in PST time (UTC - 8:00). Must be less than or equal to the end date. This value is included in the range." |
| }, |
| "aggregationType": { |
| "description": "[Optional; Default is \\\"auto\\\"] How data is aggregated. If aggregated by property, all data for the same property is aggregated; if aggregated by page, all data is aggregated by canonical URI. If you filter or group by page, choose AUTO; otherwise you can aggregate either by property or by page, depending on how you want your data calculated; see the help documentation to learn how data is calculated differently by site versus by page. **Note:** If you group or filter by page, you cannot aggregate by property. If you specify any value other than AUTO, the aggregation type in the result will match the requested type, or if you request an invalid type, you will get an error. The API will never change your aggregation type if the requested type is invalid.", |
| "enum": [ |
| "AUTO", |
| "BY_PROPERTY", |
| "BY_PAGE" |
| ], |
| "type": "string", |
| "enumDescriptions": [ |
| "", |
| "", |
| "" |
| ] |
| }, |
| "dimensions": { |
| "items": { |
| "enum": [ |
| "DATE", |
| "QUERY", |
| "PAGE", |
| "COUNTRY", |
| "DEVICE", |
| "SEARCH_APPEARANCE" |
| ], |
| "enumDescriptions": [ |
| "", |
| "", |
| "", |
| "", |
| "", |
| "" |
| ], |
| "type": "string" |
| }, |
| "type": "array", |
| "description": "[Optional] Zero or more dimensions to group results by. Dimensions are the group-by values in the Search Analytics page. Dimensions are combined to create a unique row key for each row. Results are grouped in the order that you supply these dimensions." |
| } |
| }, |
| "id": "SearchAnalyticsQueryRequest" |
| }, |
| "RunMobileFriendlyTestRequest": { |
| "type": "object", |
| "id": "RunMobileFriendlyTestRequest", |
| "description": "Mobile-friendly test request.", |
| "properties": { |
| "url": { |
| "description": "URL for inspection.", |
| "type": "string" |
| }, |
| "requestScreenshot": { |
| "description": "Whether or not screenshot is requested. Default is false.", |
| "type": "boolean" |
| } |
| } |
| }, |
| "SearchAnalyticsQueryResponse": { |
| "id": "SearchAnalyticsQueryResponse", |
| "description": "A list of rows, one per result, grouped by key. Metrics in each row are aggregated for all data grouped by that key either by page or property, as specified by the aggregation type parameter.", |
| "type": "object", |
| "properties": { |
| "responseAggregationType": { |
| "type": "string", |
| "enum": [ |
| "AUTO", |
| "BY_PROPERTY", |
| "BY_PAGE" |
| ], |
| "enumDescriptions": [ |
| "", |
| "", |
| "" |
| ], |
| "description": "How the results were aggregated." |
| }, |
| "rows": { |
| "items": { |
| "$ref": "ApiDataRow" |
| }, |
| "type": "array", |
| "description": "A list of rows grouped by the key values in the order given in the query." |
| } |
| } |
| }, |
| "ApiDimensionFilter": { |
| "id": "ApiDimensionFilter", |
| "description": "A filter test to be applied to each row in the data set, where a match can return the row. Filters are string comparisons, and values and dimension names are not case-sensitive. Individual filters are either AND'ed or OR'ed within their parent filter group, according to the group's group type. You do not need to group by a specified dimension to filter against it.", |
| "type": "object", |
| "properties": { |
| "dimension": { |
| "type": "string", |
| "enumDescriptions": [ |
| "", |
| "", |
| "", |
| "", |
| "" |
| ], |
| "enum": [ |
| "QUERY", |
| "PAGE", |
| "COUNTRY", |
| "DEVICE", |
| "SEARCH_APPEARANCE" |
| ] |
| }, |
| "operator": { |
| "type": "string", |
| "enumDescriptions": [ |
| "", |
| "", |
| "", |
| "" |
| ], |
| "enum": [ |
| "EQUALS", |
| "NOT_EQUALS", |
| "CONTAINS", |
| "NOT_CONTAINS" |
| ] |
| }, |
| "expression": { |
| "type": "string" |
| } |
| } |
| } |
| }, |
| "revision": "20200919", |
| "servicePath": "", |
| "discoveryVersion": "v1", |
| "batchPath": "batch", |
| "canonicalName": "Search Console", |
| "protocol": "rest", |
| "documentationLink": "https://developers.google.com/webmaster-tools/search-console-api/", |
| "ownerName": "Google", |
| "baseUrl": "https://searchconsole.googleapis.com/", |
| "rootUrl": "https://searchconsole.googleapis.com/", |
| "id": "searchconsole:v1", |
| "icons": { |
| "x32": "http://www.google.com/images/icons/product/search-32.gif", |
| "x16": "http://www.google.com/images/icons/product/search-16.gif" |
| }, |
| "description": "The Search Console API provides access to both Search Console data (verified users only) and to public information on an URL basis (anyone)", |
| "name": "searchconsole", |
| "parameters": { |
| "fields": { |
| "type": "string", |
| "description": "Selector specifying which fields to include in a partial response.", |
| "location": "query" |
| }, |
| "prettyPrint": { |
| "description": "Returns response with indentations and line breaks.", |
| "type": "boolean", |
| "default": "true", |
| "location": "query" |
| }, |
| "uploadType": { |
| "location": "query", |
| "type": "string", |
| "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." |
| }, |
| "alt": { |
| "description": "Data format for response.", |
| "location": "query", |
| "default": "json", |
| "enumDescriptions": [ |
| "Responses with Content-Type of application/json", |
| "Media download with context-dependent Content-Type", |
| "Responses with Content-Type of application/x-protobuf" |
| ], |
| "type": "string", |
| "enum": [ |
| "json", |
| "media", |
| "proto" |
| ] |
| }, |
| "key": { |
| "location": "query", |
| "type": "string", |
| "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." |
| }, |
| "quotaUser": { |
| "type": "string", |
| "location": "query", |
| "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." |
| }, |
| "upload_protocol": { |
| "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", |
| "location": "query", |
| "type": "string" |
| }, |
| "$.xgafv": { |
| "enum": [ |
| "1", |
| "2" |
| ], |
| "description": "V1 error format.", |
| "location": "query", |
| "type": "string", |
| "enumDescriptions": [ |
| "v1 error format", |
| "v2 error format" |
| ] |
| }, |
| "callback": { |
| "type": "string", |
| "description": "JSONP", |
| "location": "query" |
| }, |
| "oauth_token": { |
| "description": "OAuth 2.0 token for the current user.", |
| "type": "string", |
| "location": "query" |
| }, |
| "access_token": { |
| "description": "OAuth access token.", |
| "location": "query", |
| "type": "string" |
| } |
| }, |
| "title": "Google Search Console API", |
| "basePath": "", |
| "auth": { |
| "oauth2": { |
| "scopes": { |
| "https://www.googleapis.com/auth/webmasters.readonly": { |
| "description": "View Search Console data for your verified sites" |
| }, |
| "https://www.googleapis.com/auth/webmasters": { |
| "description": "View and manage Search Console data for your verified sites" |
| } |
| } |
| } |
| }, |
| "resources": { |
| "urlTestingTools": { |
| "resources": { |
| "mobileFriendlyTest": { |
| "methods": { |
| "run": { |
| "parameterOrder": [], |
| "parameters": {}, |
| "flatPath": "v1/urlTestingTools/mobileFriendlyTest:run", |
| "path": "v1/urlTestingTools/mobileFriendlyTest:run", |
| "request": { |
| "$ref": "RunMobileFriendlyTestRequest" |
| }, |
| "id": "searchconsole.urlTestingTools.mobileFriendlyTest.run", |
| "httpMethod": "POST", |
| "response": { |
| "$ref": "RunMobileFriendlyTestResponse" |
| }, |
| "description": "Runs Mobile-Friendly Test for a given URL." |
| } |
| } |
| } |
| } |
| }, |
| "searchanalytics": { |
| "methods": { |
| "query": { |
| "scopes": [ |
| "https://www.googleapis.com/auth/webmasters", |
| "https://www.googleapis.com/auth/webmasters.readonly" |
| ], |
| "description": "Query your data with filters and parameters that you define. Returns zero or more rows grouped by the row keys that you define. You must define a date range of one or more days. When date is one of the group by values, any days without data are omitted from the result list. If you need to know which days have data, issue a broad date range query grouped by date for any metric, and see which day rows are returned.", |
| "response": { |
| "$ref": "SearchAnalyticsQueryResponse" |
| }, |
| "id": "webmasters.searchanalytics.query", |
| "path": "webmasters/v3/sites/{siteUrl}/searchAnalytics/query", |
| "httpMethod": "POST", |
| "parameters": { |
| "siteUrl": { |
| "location": "path", |
| "type": "string", |
| "description": "The site's URL, including protocol. For example: `http://www.example.com/`.", |
| "required": true |
| } |
| }, |
| "parameterOrder": [ |
| "siteUrl" |
| ], |
| "flatPath": "webmasters/v3/sites/{siteUrl}/searchAnalytics/query", |
| "request": { |
| "$ref": "SearchAnalyticsQueryRequest" |
| } |
| } |
| } |
| }, |
| "sitemaps": { |
| "methods": { |
| "list": { |
| "scopes": [ |
| "https://www.googleapis.com/auth/webmasters", |
| "https://www.googleapis.com/auth/webmasters.readonly" |
| ], |
| "httpMethod": "GET", |
| "parameterOrder": [ |
| "siteUrl" |
| ], |
| "parameters": { |
| "siteUrl": { |
| "type": "string", |
| "location": "path", |
| "required": true, |
| "description": "The site's URL, including protocol. For example: `http://www.example.com/`." |
| }, |
| "sitemapIndex": { |
| "location": "query", |
| "description": " A URL of a site's sitemap index. For example: `http://www.example.com/sitemapindex.xml`.", |
| "type": "string" |
| } |
| }, |
| "description": " Lists the [sitemaps-entries](/webmaster-tools/v3/sitemaps) submitted for this site, or included in the sitemap index file (if `sitemapIndex` is specified in the request).", |
| "path": "webmasters/v3/sites/{siteUrl}/sitemaps", |
| "id": "webmasters.sitemaps.list", |
| "flatPath": "webmasters/v3/sites/{siteUrl}/sitemaps", |
| "response": { |
| "$ref": "SitemapsListResponse" |
| } |
| }, |
| "get": { |
| "parameterOrder": [ |
| "siteUrl", |
| "feedpath" |
| ], |
| "response": { |
| "$ref": "WmxSitemap" |
| }, |
| "httpMethod": "GET", |
| "path": "webmasters/v3/sites/{siteUrl}/sitemaps/{feedpath}", |
| "parameters": { |
| "feedpath": { |
| "location": "path", |
| "required": true, |
| "description": "The URL of the actual sitemap. For example: `http://www.example.com/sitemap.xml`.", |
| "type": "string" |
| }, |
| "siteUrl": { |
| "description": "The site's URL, including protocol. For example: `http://www.example.com/`.", |
| "required": true, |
| "location": "path", |
| "type": "string" |
| } |
| }, |
| "description": "Retrieves information about a specific sitemap.", |
| "id": "webmasters.sitemaps.get", |
| "flatPath": "webmasters/v3/sites/{siteUrl}/sitemaps/{feedpath}", |
| "scopes": [ |
| "https://www.googleapis.com/auth/webmasters", |
| "https://www.googleapis.com/auth/webmasters.readonly" |
| ] |
| }, |
| "delete": { |
| "parameterOrder": [ |
| "siteUrl", |
| "feedpath" |
| ], |
| "scopes": [ |
| "https://www.googleapis.com/auth/webmasters" |
| ], |
| "parameters": { |
| "feedpath": { |
| "required": true, |
| "type": "string", |
| "description": "The URL of the actual sitemap. For example: `http://www.example.com/sitemap.xml`.", |
| "location": "path" |
| }, |
| "siteUrl": { |
| "required": true, |
| "description": "The site's URL, including protocol. For example: `http://www.example.com/`.", |
| "location": "path", |
| "type": "string" |
| } |
| }, |
| "flatPath": "webmasters/v3/sites/{siteUrl}/sitemaps/{feedpath}", |
| "id": "webmasters.sitemaps.delete", |
| "description": "Deletes a sitemap from this site.", |
| "path": "webmasters/v3/sites/{siteUrl}/sitemaps/{feedpath}", |
| "httpMethod": "DELETE" |
| }, |
| "submit": { |
| "path": "webmasters/v3/sites/{siteUrl}/sitemaps/{feedpath}", |
| "description": "Submits a sitemap for a site.", |
| "httpMethod": "PUT", |
| "flatPath": "webmasters/v3/sites/{siteUrl}/sitemaps/{feedpath}", |
| "id": "webmasters.sitemaps.submit", |
| "scopes": [ |
| "https://www.googleapis.com/auth/webmasters" |
| ], |
| "parameterOrder": [ |
| "siteUrl", |
| "feedpath" |
| ], |
| "parameters": { |
| "feedpath": { |
| "description": "The URL of the actual sitemap. For example: `http://www.example.com/sitemap.xml`.", |
| "type": "string", |
| "required": true, |
| "location": "path" |
| }, |
| "siteUrl": { |
| "location": "path", |
| "required": true, |
| "description": "The site's URL, including protocol. For example: `http://www.example.com/`.", |
| "type": "string" |
| } |
| } |
| } |
| } |
| }, |
| "sites": { |
| "methods": { |
| "list": { |
| "response": { |
| "$ref": "SitesListResponse" |
| }, |
| "parameterOrder": [], |
| "description": " Lists the user's Search Console sites.", |
| "flatPath": "webmasters/v3/sites", |
| "scopes": [ |
| "https://www.googleapis.com/auth/webmasters", |
| "https://www.googleapis.com/auth/webmasters.readonly" |
| ], |
| "httpMethod": "GET", |
| "id": "webmasters.sites.list", |
| "parameters": {}, |
| "path": "webmasters/v3/sites" |
| }, |
| "delete": { |
| "path": "webmasters/v3/sites/{siteUrl}", |
| "parameters": { |
| "siteUrl": { |
| "required": true, |
| "description": "The URI of the property as defined in Search Console. **Examples:** `http://www.example.com/` or `sc-domain:example.com`.", |
| "type": "string", |
| "location": "path" |
| } |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/webmasters" |
| ], |
| "id": "webmasters.sites.delete", |
| "flatPath": "webmasters/v3/sites/{siteUrl}", |
| "parameterOrder": [ |
| "siteUrl" |
| ], |
| "httpMethod": "DELETE", |
| "description": " Removes a site from the set of the user's Search Console sites." |
| }, |
| "get": { |
| "parameterOrder": [ |
| "siteUrl" |
| ], |
| "description": " Retrieves information about specific site.", |
| "response": { |
| "$ref": "WmxSite" |
| }, |
| "httpMethod": "GET", |
| "parameters": { |
| "siteUrl": { |
| "type": "string", |
| "description": "The URI of the property as defined in Search Console. **Examples:** `http://www.example.com/` or `sc-domain:example.com`.", |
| "location": "path", |
| "required": true |
| } |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/webmasters", |
| "https://www.googleapis.com/auth/webmasters.readonly" |
| ], |
| "path": "webmasters/v3/sites/{siteUrl}", |
| "id": "webmasters.sites.get", |
| "flatPath": "webmasters/v3/sites/{siteUrl}" |
| }, |
| "add": { |
| "parameters": { |
| "siteUrl": { |
| "location": "path", |
| "type": "string", |
| "required": true, |
| "description": "The URL of the site to add." |
| } |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/webmasters" |
| ], |
| "flatPath": "webmasters/v3/sites/{siteUrl}", |
| "description": " Adds a site to the set of the user's sites in Search Console.", |
| "path": "webmasters/v3/sites/{siteUrl}", |
| "id": "webmasters.sites.add", |
| "httpMethod": "PUT", |
| "parameterOrder": [ |
| "siteUrl" |
| ] |
| } |
| } |
| } |
| }, |
| "mtlsRootUrl": "https://searchconsole.mtls.googleapis.com/", |
| "ownerDomain": "google.com", |
| "fullyEncodeReservedExpansion": true, |
| "version_module": true, |
| "kind": "discovery#restDescription" |
| } |
