{ "name": "searchconsole", "mtlsRootUrl": "https://searchconsole.mtls.googleapis.com/", "protocol": "rest", "servicePath": "", "version_module": true, "canonicalName": "Search Console", "title": "Google Search Console API", "baseUrl": "https://searchconsole.googleapis.com/", "fullyEncodeReservedExpansion": true, "resources": { "sitemaps": { "methods": { "list": { "path": "webmasters/v3/sites/{siteUrl}/sitemaps", "scopes": [ "https://www.googleapis.com/auth/webmasters", "https://www.googleapis.com/auth/webmasters.readonly" ], "httpMethod": "GET", "response": { "$ref": "SitemapsListResponse" }, "parameterOrder": [ "siteUrl" ], "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).", "flatPath": "webmasters/v3/sites/{siteUrl}/sitemaps", "parameters": { "sitemapIndex": { "description": " A URL of a site's sitemap index. For example: `http://www.example.com/sitemapindex.xml`.", "location": "query", "type": "string" }, "siteUrl": { "required": true, "description": "The site's URL, including protocol. For example: `http://www.example.com/`.", "location": "path", "type": "string" } }, "id": "webmasters.sitemaps.list" }, "get": { "parameterOrder": [ "siteUrl", "feedpath" ], "description": "Retrieves information about a specific sitemap.", "scopes": [ "https://www.googleapis.com/auth/webmasters", "https://www.googleapis.com/auth/webmasters.readonly" ], "path": "webmasters/v3/sites/{siteUrl}/sitemaps/{feedpath}", "response": { "$ref": "WmxSitemap" }, "httpMethod": "GET", "id": "webmasters.sitemaps.get", "flatPath": "webmasters/v3/sites/{siteUrl}/sitemaps/{feedpath}", "parameters": { "siteUrl": { "description": "The site's URL, including protocol. For example: `http://www.example.com/`.", "location": "path", "required": true, "type": "string" }, "feedpath": { "type": "string", "required": true, "description": "The URL of the actual sitemap. For example: `http://www.example.com/sitemap.xml`.", "location": "path" } } }, "submit": { "id": "webmasters.sitemaps.submit", "parameterOrder": [ "siteUrl", "feedpath" ], "description": "Submits a sitemap for a site.", "httpMethod": "PUT", "flatPath": "webmasters/v3/sites/{siteUrl}/sitemaps/{feedpath}", "parameters": { "siteUrl": { "type": "string", "required": true, "description": "The site's URL, including protocol. For example: `http://www.example.com/`.", "location": "path" }, "feedpath": { "type": "string", "description": "The URL of the actual sitemap. For example: `http://www.example.com/sitemap.xml`.", "location": "path", "required": true } }, "path": "webmasters/v3/sites/{siteUrl}/sitemaps/{feedpath}", "scopes": [ "https://www.googleapis.com/auth/webmasters" ] }, "delete": { "httpMethod": "DELETE", "flatPath": "webmasters/v3/sites/{siteUrl}/sitemaps/{feedpath}", "parameters": { "siteUrl": { "type": "string", "required": true, "description": "The site's URL, including protocol. For example: `http://www.example.com/`.", "location": "path" }, "feedpath": { "required": true, "description": "The URL of the actual sitemap. For example: `http://www.example.com/sitemap.xml`.", "location": "path", "type": "string" } }, "path": "webmasters/v3/sites/{siteUrl}/sitemaps/{feedpath}", "scopes": [ "https://www.googleapis.com/auth/webmasters" ], "id": "webmasters.sitemaps.delete", "parameterOrder": [ "siteUrl", "feedpath" ], "description": "Deletes a sitemap from the Sitemaps report. Does not stop Google from crawling this sitemap or the URLs that were previously crawled in the deleted sitemap." } } }, "urlInspection": { "resources": { "index": { "methods": { "inspect": { "path": "v1/urlInspection/index:inspect", "scopes": [ "https://www.googleapis.com/auth/webmasters", "https://www.googleapis.com/auth/webmasters.readonly" ], "httpMethod": "POST", "response": { "$ref": "InspectUrlIndexResponse" }, "parameterOrder": [], "description": "Index inspection.", "request": { "$ref": "InspectUrlIndexRequest" }, "flatPath": "v1/urlInspection/index:inspect", "parameters": {}, "id": "searchconsole.urlInspection.index.inspect" } } } } }, "sites": { "methods": { "list": { "parameterOrder": [], "description": " Lists the user's Search Console sites.", "httpMethod": "GET", "response": { "$ref": "SitesListResponse" }, "path": "webmasters/v3/sites", "scopes": [ "https://www.googleapis.com/auth/webmasters", "https://www.googleapis.com/auth/webmasters.readonly" ], "id": "webmasters.sites.list", "flatPath": "webmasters/v3/sites", "parameters": {} }, "add": { "id": "webmasters.sites.add", "parameterOrder": [ "siteUrl" ], "description": " Adds a site to the set of the user's sites in Search Console.", "path": "webmasters/v3/sites/{siteUrl}", "scopes": [ "https://www.googleapis.com/auth/webmasters" ], "httpMethod": "PUT", "flatPath": "webmasters/v3/sites/{siteUrl}", "parameters": { "siteUrl": { "required": true, "description": "The URL of the site to add.", "location": "path", "type": "string" } } }, "get": { "parameterOrder": [ "siteUrl" ], "description": " Retrieves information about specific site.", "path": "webmasters/v3/sites/{siteUrl}", "scopes": [ "https://www.googleapis.com/auth/webmasters", "https://www.googleapis.com/auth/webmasters.readonly" ], "httpMethod": "GET", "response": { "$ref": "WmxSite" }, "id": "webmasters.sites.get", "flatPath": "webmasters/v3/sites/{siteUrl}", "parameters": { "siteUrl": { "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, "type": "string" } } }, "delete": { "flatPath": "webmasters/v3/sites/{siteUrl}", "parameters": { "siteUrl": { "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, "type": "string" } }, "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/webmasters" ], "path": "webmasters/v3/sites/{siteUrl}", "id": "webmasters.sites.delete", "parameterOrder": [ "siteUrl" ], "description": " Removes a site from the set of the user's Search Console sites." } } }, "urlTestingTools": { "resources": { "mobileFriendlyTest": { "methods": { "run": { "id": "searchconsole.urlTestingTools.mobileFriendlyTest.run", "flatPath": "v1/urlTestingTools/mobileFriendlyTest:run", "parameters": {}, "request": { "$ref": "RunMobileFriendlyTestRequest" }, "parameterOrder": [], "description": "Runs Mobile-Friendly Test for a given URL.", "response": { "$ref": "RunMobileFriendlyTestResponse" }, "httpMethod": "POST", "path": "v1/urlTestingTools/mobileFriendlyTest:run" } } } } }, "searchanalytics": { "methods": { "query": { "request": { "$ref": "SearchAnalyticsQueryRequest" }, "flatPath": "webmasters/v3/sites/{siteUrl}/searchAnalytics/query", "parameters": { "siteUrl": { "type": "string", "description": "The site's URL, including protocol. For example: `http://www.example.com/`.", "location": "path", "required": true } }, "id": "webmasters.searchanalytics.query", "path": "webmasters/v3/sites/{siteUrl}/searchAnalytics/query", "scopes": [ "https://www.googleapis.com/auth/webmasters", "https://www.googleapis.com/auth/webmasters.readonly" ], "httpMethod": "POST", "response": { "$ref": "SearchAnalyticsQueryResponse" }, "parameterOrder": [ "siteUrl" ], "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." } } } }, "kind": "discovery#restDescription", "ownerName": "Google", "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" } } } }, "documentationLink": "https://developers.google.com/webmaster-tools/about", "parameters": { "alt": { "type": "string", "location": "query", "enum": [ "json", "media", "proto" ], "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "description": "Data format for response.", "default": "json" }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query" }, "uploadType": { "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query" }, "key": { "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.", "location": "query", "type": "string" }, "callback": { "type": "string", "description": "JSONP", "location": "query" }, "quotaUser": { "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.", "location": "query", "type": "string" }, "fields": { "description": "Selector specifying which fields to include in a partial response.", "location": "query", "type": "string" }, "prettyPrint": { "type": "boolean", "description": "Returns response with indentations and line breaks.", "default": "true", "location": "query" }, "$.xgafv": { "description": "V1 error format.", "enum": [ "1", "2" ], "enumDescriptions": [ "v1 error format", "v2 error format" ], "location": "query", "type": "string" }, "oauth_token": { "type": "string", "description": "OAuth 2.0 token for the current user.", "location": "query" }, "access_token": { "description": "OAuth access token.", "location": "query", "type": "string" } }, "version": "v1", "batchPath": "batch", "ownerDomain": "google.com", "id": "searchconsole:v1", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.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)", "basePath": "", "revision": "20260701", "discoveryVersion": "v1", "schemas": { "IndexStatusInspectionResult": { "type": "object", "properties": { "verdict": { "description": "High level verdict about whether the URL *is* indexed (indexed status), or *can be* indexed (live inspection).", "type": "string", "enumDescriptions": [ "Unknown verdict.", "Equivalent to \"Valid\" for the page or item in Search Console.", "Reserved, no longer in use.", "Equivalent to \"Error\" or \"Invalid\" for the page or item in Search Console.", "Equivalent to \"Excluded\" for the page or item in Search Console." ], "enum": [ "VERDICT_UNSPECIFIED", "PASS", "PARTIAL", "FAIL", "NEUTRAL" ] }, "sitemap": { "description": "Any sitemaps that this URL was listed in, as known by Google. Not guaranteed to be an exhaustive list, especially if Google did not discover this URL through a sitemap. Absent if no sitemaps were found.", "items": { "type": "string" }, "type": "array" }, "userCanonical": { "description": "The URL that your page or site [declares as canonical](https://developers.google.com/search/docs/advanced/crawling/consolidate-duplicate-urls?#define-canonical). If you did not declare a canonical URL, this field is absent.", "type": "string" }, "coverageState": { "description": "Could Google find and index the page. More details about page indexing appear in 'indexing_state'.", "type": "string" }, "pageFetchState": { "description": "Whether or not Google could retrieve the page from your server. Equivalent to [\"page fetch\"](https://support.google.com/webmasters/answer/9012289#index_coverage) in the URL inspection report.", "enumDescriptions": [ "Unknown fetch state.", "Successful fetch.", "Soft 404.", "Blocked by robots.txt.", "Not found (404).", "Blocked due to unauthorized request (401).", "Server error (5xx).", "Redirection error.", "Blocked due to access forbidden (403).", "Blocked due to other 4xx issue (not 403, 404).", "Internal error.", "Invalid URL." ], "enum": [ "PAGE_FETCH_STATE_UNSPECIFIED", "SUCCESSFUL", "SOFT_404", "BLOCKED_ROBOTS_TXT", "NOT_FOUND", "ACCESS_DENIED", "SERVER_ERROR", "REDIRECT_ERROR", "ACCESS_FORBIDDEN", "BLOCKED_4XX", "INTERNAL_CRAWL_ERROR", "INVALID_URL" ], "type": "string" }, "indexingState": { "description": "Whether or not the page blocks indexing through a noindex rule.", "enumDescriptions": [ "Unknown indexing status.", "Indexing allowed.", "Indexing not allowed, 'noindex' detected in 'robots' meta tag.", "Indexing not allowed, 'noindex' detected in 'X-Robots-Tag' http header.", "Reserved, no longer in use." ], "enum": [ "INDEXING_STATE_UNSPECIFIED", "INDEXING_ALLOWED", "BLOCKED_BY_META_TAG", "BLOCKED_BY_HTTP_HEADER", "BLOCKED_BY_ROBOTS_TXT" ], "type": "string" }, "lastCrawlTime": { "description": "Last time this URL was crawled by Google using the [primary crawler](https://support.google.com/webmasters/answer/7440203#primary_crawler). Absent if the URL was never crawled successfully.", "type": "string", "format": "google-datetime" }, "googleCanonical": { "type": "string", "description": "The URL of the page that Google selected as canonical. If the page was not indexed, this field is absent." }, "robotsTxtState": { "description": "Whether or not the page is blocked to Google by a robots.txt rule.", "enumDescriptions": [ "Unknown robots.txt state, typically because the page wasn't fetched or found, or because robots.txt itself couldn't be reached.", "Crawl allowed by robots.txt.", "Crawl blocked by robots.txt." ], "enum": [ "ROBOTS_TXT_STATE_UNSPECIFIED", "ALLOWED", "DISALLOWED" ], "type": "string" }, "referringUrls": { "description": "URLs that link to the inspected URL, directly and indirectly.", "items": { "type": "string" }, "type": "array" }, "crawledAs": { "description": "Primary crawler that was used by Google to crawl your site.", "type": "string", "enumDescriptions": [ "Unknown user agent.", "Desktop user agent.", "Mobile user agent." ], "enum": [ "CRAWLING_USER_AGENT_UNSPECIFIED", "DESKTOP", "MOBILE" ] } }, "id": "IndexStatusInspectionResult", "description": "Results of index status inspection for either the live page or the version in Google's index, depending on whether you requested a live inspection or not. For more information, see the [Index coverage report documentation](https://support.google.com/webmasters/answer/7440203)." }, "WmxSitemapContent": { "id": "WmxSitemapContent", "description": "Information about the various content types in the sitemap.", "type": "object", "properties": { "type": { "description": "The specific type of content in this sitemap. For example: `web`.", "enumDescriptions": [ "", "", "", "", "", "", "Unsupported content type.", "", "Unsupported content type." ], "enum": [ "WEB", "IMAGE", "VIDEO", "NEWS", "MOBILE", "ANDROID_APP", "PATTERN", "IOS_APP", "DATA_FEED_ELEMENT" ], "type": "string", "enumDeprecated": [ false, false, false, false, false, false, true, false, true ] }, "submitted": { "type": "string", "format": "int64", "description": "The number of URLs in the sitemap (of the content type)." }, "indexed": { "type": "string", "format": "int64", "description": "*Deprecated; do not use.*", "deprecated": true } } }, "Item": { "properties": { "name": { "description": "The user-provided name of this item.", "type": "string" }, "issues": { "description": "A list of zero or more rich result issues found for this instance.", "items": { "$ref": "RichResultsIssue" }, "type": "array" } }, "type": "object", "id": "Item", "description": "A specific rich result found on the page." }, "WmxSite": { "id": "WmxSite", "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", "properties": { "siteUrl": { "type": "string", "description": "The URL of the site." }, "permissionLevel": { "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" ], "type": "string", "description": "The user's permission level for the site." } } }, "AmpIssue": { "properties": { "issueMessage": { "type": "string", "description": "Brief description of this issue." }, "severity": { "description": "Severity of this issue: WARNING or ERROR.", "enumDescriptions": [ "Unknown severity.", "Warning.", "Error." ], "enum": [ "SEVERITY_UNSPECIFIED", "WARNING", "ERROR" ], "type": "string" } }, "type": "object", "id": "AmpIssue", "description": "AMP issue." }, "MobileUsabilityIssue": { "properties": { "issueType": { "description": "Mobile-usability issue type.", "enumDescriptions": [ "Unknown issue. 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#error-list).", "Viewport is not specified using the meta viewport tag. [Learn more] (https://support.google.com/webmasters/answer/6352293#viewport_not_configured#error-list).", "Viewport defined to a fixed width. [Learn more] (https://support.google.com/webmasters/answer/6352293#fixed-width_viewport#error-list).", "Content not sized to viewport. [Learn more] (https://support.google.com/webmasters/answer/6352293#content_not_sized_to_viewport#error-list).", "Font size is too small for easy reading on a small screen. [Learn More] (https://support.google.com/webmasters/answer/6352293#small_font_size#error-list).", "Touch elements are too close to each other. [Learn more] (https://support.google.com/webmasters/answer/6352293#touch_elements_too_close#error-list)." ], "enum": [ "MOBILE_USABILITY_ISSUE_TYPE_UNSPECIFIED", "USES_INCOMPATIBLE_PLUGINS", "CONFIGURE_VIEWPORT", "FIXED_WIDTH_VIEWPORT", "SIZE_CONTENT_TO_VIEWPORT", "USE_LEGIBLE_FONT_SIZES", "TAP_TARGETS_TOO_CLOSE" ], "type": "string" }, "message": { "type": "string", "description": "Additional information regarding the issue." }, "severity": { "description": "Not returned; reserved for future use.", "type": "string", "enumDescriptions": [ "Unknown severity.", "Warning.", "Error." ], "enum": [ "SEVERITY_UNSPECIFIED", "WARNING", "ERROR" ] } }, "type": "object", "id": "MobileUsabilityIssue", "description": "Mobile-usability issue." }, "ApiDimensionFilterGroup": { "id": "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": { "groupType": { "type": "string", "enumDescriptions": [ "" ], "enum": [ "AND" ] }, "filters": { "type": "array", "items": { "$ref": "ApiDimensionFilter" } } }, "type": "object" }, "DetectedItems": { "id": "DetectedItems", "description": "Rich Results items grouped by type.", "properties": { "richResultType": { "description": "Rich Results type", "type": "string" }, "items": { "type": "array", "description": "List of Rich Results items.", "items": { "$ref": "Item" } } }, "type": "object" }, "SearchAnalyticsQueryRequest": { "id": "SearchAnalyticsQueryRequest", "properties": { "type": { "description": "Optional. [Optional; Default is \\\"web\\\"] Type of report: search type, or either Discover or Gnews.", "type": "string", "enumDescriptions": [ "", "", "", "News tab in search.", "Discover.", "Google News (news.google.com or mobile app)." ], "enum": [ "WEB", "IMAGE", "VIDEO", "NEWS", "DISCOVER", "GOOGLE_NEWS" ] }, "searchType": { "enumDescriptions": [ "", "", "", "News tab in search.", "Discover.", "Google News (news.google.com or mobile app)." ], "enum": [ "WEB", "IMAGE", "VIDEO", "NEWS", "DISCOVER", "GOOGLE_NEWS" ], "type": "string", "description": "[Optional; Default is \\\"web\\\"] The search type to filter for." }, "dimensionFilterGroups": { "type": "array", "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.", "items": { "$ref": "ApiDimensionFilterGroup" } }, "dataState": { "description": "The data state to be fetched, can be full or all, the latter including full and partial data.", "enumDescriptions": [ "Default value, should not be used.", "Include full final data only, without partial.", "Include all data, full and partial.", "Include hourly data, full and partial. Required when grouping by HOUR." ], "enum": [ "DATA_STATE_UNSPECIFIED", "FINAL", "ALL", "HOURLY_ALL" ], "type": "string" }, "dimensions": { "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.", "items": { "type": "string", "enumDescriptions": [ "Group by date, which is returned in YYYY-MM-DD format, in PT time (UTC - 7:00/8:00).", "Group by query string.", "Group by page, a URI string.", "Group by country, specified by 3-letter country code ([ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)).", "Group by device type (DESKTOP, MOBILE and TABLET).", "Group by search result feature.", "Group by hour, which is returned in YYYY-MM-DDThh:mm:ss[+|-]hh:mm format (ISO-8601 extended offset date-time format) in PT time (UTC - 7:00/8:00). Data is available up to 10 days. Requires setting the dataState to HOURLY_ALL." ], "enum": [ "DATE", "QUERY", "PAGE", "COUNTRY", "DEVICE", "SEARCH_APPEARANCE", "HOUR" ] } }, "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" }, "rowLimit": { "description": "[Optional; Default is 1000] The maximum number of rows to return. Must be a number from 1 to 25,000 (inclusive).", "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." }, "endDate": { "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.", "type": "string" }, "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.", "enumDescriptions": [ "", "", "", "" ], "enum": [ "AUTO", "BY_PROPERTY", "BY_PAGE", "BY_NEWS_SHOWCASE_PANEL" ], "type": "string" } }, "type": "object" }, "Metadata": { "type": "object", "properties": { "firstIncompleteDate": { "description": "The first date for which the data is still being collected and processed, presented in `YYYY-MM-DD` format (ISO-8601 extended local date format). This field is populated only when the request's `dataState` is \"`all`\", data is grouped by \"`DATE`\", and the requested date range contains incomplete data points. All values after the `first_incomplete_date` may still change noticeably.", "type": "string" }, "firstIncompleteHour": { "type": "string", "description": "The first hour for which the data is still being collected and processed, presented in `YYYY-MM-DDThh:mm:ss[+|-]hh:mm` format (ISO-8601 extended offset date-time format). This field is populated only when the request's `dataState` is \"`hourly_all`\", data is grouped by \"`HOUR`\" and the requested date range contains incomplete data points. All values after the `first_incomplete_hour` may still change noticeably." } }, "id": "Metadata", "description": "An object that may be returned with your query results, providing context about the state of the data. When you request recent data (using `all` or `hourly_all` for `dataState`), some of the rows returned may represent data that is incomplete, which means that the data is still being collected and processed. This metadata object helps you identify exactly when this starts and ends. All dates and times provided in this object are in the `America/Los_Angeles` time zone. The specific field returned within this object depends on how you've grouped your data in the request. See details in inner fields." }, "RunMobileFriendlyTestResponse": { "type": "object", "properties": { "testStatus": { "description": "Final state of the test, can be either complete or an error.", "$ref": "TestStatus" }, "mobileFriendlyIssues": { "type": "array", "description": "List of mobile-usability issues.", "items": { "$ref": "MobileFriendlyIssue" } }, "resourceIssues": { "description": "Information about embedded resources issues.", "items": { "$ref": "ResourceIssue" }, "type": "array" }, "screenshot": { "$ref": "Image", "description": "Screenshot of the requested URL." }, "mobileFriendliness": { "description": "Test verdict, whether the page is mobile friendly or not.", "enumDescriptions": [ "Internal error when running this test. Please try running the test again.", "The page is mobile friendly.", "The page is not mobile friendly." ], "enum": [ "MOBILE_FRIENDLY_TEST_RESULT_UNSPECIFIED", "MOBILE_FRIENDLY", "NOT_MOBILE_FRIENDLY" ], "type": "string" } }, "id": "RunMobileFriendlyTestResponse", "description": "Mobile-friendly test response, including mobile-friendly issues and resource issues." }, "MobileUsabilityInspectionResult": { "type": "object", "properties": { "verdict": { "enumDescriptions": [ "Unknown verdict.", "Equivalent to \"Valid\" for the page or item in Search Console.", "Reserved, no longer in use.", "Equivalent to \"Error\" or \"Invalid\" for the page or item in Search Console.", "Equivalent to \"Excluded\" for the page or item in Search Console." ], "enum": [ "VERDICT_UNSPECIFIED", "PASS", "PARTIAL", "FAIL", "NEUTRAL" ], "type": "string", "description": "High-level mobile-usability inspection result for this URL." }, "issues": { "type": "array", "description": "A list of zero or more mobile-usability issues detected for this URL.", "items": { "$ref": "MobileUsabilityIssue" } } }, "id": "MobileUsabilityInspectionResult", "description": "Mobile-usability inspection results." }, "TestStatus": { "properties": { "status": { "description": "Status of the test.", "type": "string", "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" ] }, "details": { "description": "Error details if applicable.", "type": "string" } }, "type": "object", "id": "TestStatus", "description": "Final state of the test, including error details if necessary." }, "UrlInspectionResult": { "id": "UrlInspectionResult", "description": "URL inspection result, including all inspection results.", "type": "object", "properties": { "richResultsResult": { "$ref": "RichResultsInspectionResult", "description": "Result of the Rich Results analysis. Absent if there are no rich results found." }, "indexStatusResult": { "description": "Result of the index status analysis.", "$ref": "IndexStatusInspectionResult" }, "inspectionResultLink": { "type": "string", "description": "Link to Search Console URL inspection." }, "ampResult": { "description": "Result of the AMP analysis. Absent if the page is not an AMP page.", "$ref": "AmpInspectionResult" }, "mobileUsabilityResult": { "$ref": "MobileUsabilityInspectionResult", "description": "Result of the Mobile usability analysis.", "deprecated": true } } }, "ApiDataRow": { "id": "ApiDataRow", "properties": { "impressions": { "type": "number", "format": "double" }, "clicks": { "type": "number", "format": "double" }, "ctr": { "type": "number", "format": "double" }, "keys": { "items": { "type": "string" }, "type": "array" }, "position": { "type": "number", "format": "double" } }, "type": "object" }, "Image": { "properties": { "data": { "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.", "type": "string", "format": "byte" }, "mimeType": { "type": "string", "description": "The mime-type of the image data." } }, "type": "object", "id": "Image", "description": "Describe image data." }, "InspectUrlIndexResponse": { "type": "object", "properties": { "inspectionResult": { "description": "URL inspection results.", "$ref": "UrlInspectionResult" } }, "id": "InspectUrlIndexResponse", "description": "Index-Status inspection response." }, "BlockedResource": { "id": "BlockedResource", "description": "Blocked resource.", "properties": { "url": { "type": "string", "description": "URL of the blocked resource." } }, "type": "object" }, "MobileFriendlyIssue": { "id": "MobileFriendlyIssue", "description": "Mobile-friendly issue.", "type": "object", "properties": { "rule": { "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).", "Viewport 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)." ], "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" ], "type": "string", "description": "Rule violated." } } }, "InspectUrlIndexRequest": { "id": "InspectUrlIndexRequest", "description": "Index inspection request.", "properties": { "languageCode": { "type": "string", "description": "Optional. An [IETF BCP-47](https://en.wikipedia.org/wiki/IETF_language_tag) language code representing the requested language for translated issue messages, e.g. \"en-US\", \"or \"de-CH\". Default value is \"en-US\"." }, "inspectionUrl": { "type": "string", "description": "Required. URL to inspect. Must be under the property specified in \"site_url\"." }, "siteUrl": { "type": "string", "description": "Required. The URL of the property as defined in Search Console. **Examples:** `http://www.example.com/` for a URL-prefix property, or `sc-domain:example.com` for a Domain property." } }, "type": "object" }, "SearchAnalyticsQueryResponse": { "type": "object", "properties": { "metadata": { "$ref": "Metadata", "description": "An object that may be returned with your query results, providing context about the state of the data. See details in Metadata object documentation." }, "rows": { "description": "A list of rows grouped by the key values in the order given in the query.", "items": { "$ref": "ApiDataRow" }, "type": "array" }, "responseAggregationType": { "type": "string", "enumDescriptions": [ "", "", "", "" ], "enum": [ "AUTO", "BY_PROPERTY", "BY_PAGE", "BY_NEWS_SHOWCASE_PANEL" ], "description": "How the results were aggregated." } }, "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." }, "SitemapsListResponse": { "id": "SitemapsListResponse", "description": "List of sitemaps.", "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" } } }, "type": "object" }, "SitesListResponse": { "id": "SitesListResponse", "description": "List of sites with access level information.", "properties": { "siteEntry": { "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" }, "type": "array" } }, "type": "object" }, "ResourceIssue": { "type": "object", "properties": { "blockedResource": { "description": "Describes a blocked resource issue.", "$ref": "BlockedResource" } }, "id": "ResourceIssue", "description": "Information about a resource with issue." }, "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", "INCLUDING_REGEX", "EXCLUDING_REGEX" ] }, "expression": { "type": "string" } } }, "AmpInspectionResult": { "id": "AmpInspectionResult", "description": "AMP inspection result of the live page or the current information from Google's index, depending on whether you requested a live inspection or not.", "properties": { "verdict": { "description": "The status of the most severe error on the page. If a page has both warnings and errors, the page status is error. Error status means the page cannot be shown in Search results.", "enumDescriptions": [ "Unknown verdict.", "Equivalent to \"Valid\" for the page or item in Search Console.", "Reserved, no longer in use.", "Equivalent to \"Error\" or \"Invalid\" for the page or item in Search Console.", "Equivalent to \"Excluded\" for the page or item in Search Console." ], "enum": [ "VERDICT_UNSPECIFIED", "PASS", "PARTIAL", "FAIL", "NEUTRAL" ], "type": "string" }, "ampIndexStatusVerdict": { "description": "Index status of the AMP URL.", "type": "string", "enumDescriptions": [ "Unknown verdict.", "Equivalent to \"Valid\" for the page or item in Search Console.", "Reserved, no longer in use.", "Equivalent to \"Error\" or \"Invalid\" for the page or item in Search Console.", "Equivalent to \"Excluded\" for the page or item in Search Console." ], "enum": [ "VERDICT_UNSPECIFIED", "PASS", "PARTIAL", "FAIL", "NEUTRAL" ] }, "pageFetchState": { "description": "Whether or not Google could fetch the AMP.", "type": "string", "enumDescriptions": [ "Unknown fetch state.", "Successful fetch.", "Soft 404.", "Blocked by robots.txt.", "Not found (404).", "Blocked due to unauthorized request (401).", "Server error (5xx).", "Redirection error.", "Blocked due to access forbidden (403).", "Blocked due to other 4xx issue (not 403, 404).", "Internal error.", "Invalid URL." ], "enum": [ "PAGE_FETCH_STATE_UNSPECIFIED", "SUCCESSFUL", "SOFT_404", "BLOCKED_ROBOTS_TXT", "NOT_FOUND", "ACCESS_DENIED", "SERVER_ERROR", "REDIRECT_ERROR", "ACCESS_FORBIDDEN", "BLOCKED_4XX", "INTERNAL_CRAWL_ERROR", "INVALID_URL" ] }, "lastCrawlTime": { "description": "Last time this AMP version was crawled by Google. Absent if the URL was never crawled successfully.", "type": "string", "format": "google-datetime" }, "ampUrl": { "type": "string", "description": "URL of the AMP that was inspected. If the submitted URL is a desktop page that refers to an AMP version, the AMP version will be inspected." }, "indexingState": { "description": "Whether or not the page blocks indexing through a noindex rule.", "type": "string", "enumDescriptions": [ "Unknown indexing status.", "Indexing allowed.", "Indexing not allowed, 'noindex' detected.", "Indexing not allowed, 'unavailable_after' date expired." ], "enum": [ "AMP_INDEXING_STATE_UNSPECIFIED", "AMP_INDEXING_ALLOWED", "BLOCKED_DUE_TO_NOINDEX", "BLOCKED_DUE_TO_EXPIRED_UNAVAILABLE_AFTER" ] }, "issues": { "type": "array", "description": "A list of zero or more AMP issues found for the inspected URL.", "items": { "$ref": "AmpIssue" } }, "robotsTxtState": { "type": "string", "enumDescriptions": [ "Unknown robots.txt state, typically because the page wasn't fetched or found, or because robots.txt itself couldn't be reached.", "Crawl allowed by robots.txt.", "Crawl blocked by robots.txt." ], "enum": [ "ROBOTS_TXT_STATE_UNSPECIFIED", "ALLOWED", "DISALLOWED" ], "description": "Whether or not the page is blocked to Google by a robots.txt rule." } }, "type": "object" }, "RichResultsIssue": { "type": "object", "properties": { "severity": { "type": "string", "enumDescriptions": [ "Unknown severity.", "Warning.", "Error." ], "enum": [ "SEVERITY_UNSPECIFIED", "WARNING", "ERROR" ], "description": "Severity of this issue: WARNING, or ERROR. Items with an issue of status ERROR cannot appear with rich result features in Google Search results." }, "issueMessage": { "description": "Rich Results issue type.", "type": "string" } }, "id": "RichResultsIssue", "description": "Severity and status of a single issue affecting a single rich result instance on a page." }, "RunMobileFriendlyTestRequest": { "id": "RunMobileFriendlyTestRequest", "description": "Mobile-friendly test request.", "type": "object", "properties": { "url": { "type": "string", "description": "URL for inspection." }, "requestScreenshot": { "description": "Whether or not screenshot is requested. Default is false.", "type": "boolean" } } }, "WmxSitemap": { "id": "WmxSitemap", "description": "Contains detailed information about a specific URL submitted as a [sitemap](https://support.google.com/webmasters/answer/156184).", "type": "object", "properties": { "type": { "description": "The type of the sitemap. For example: `rssFeed`.", "enumDescriptions": [ "", "", "", "", "", "Unsupported sitemap types.", "" ], "enum": [ "NOT_SITEMAP", "URL_LIST", "SITEMAP", "RSS_FEED", "ATOM_FEED", "PATTERN_SITEMAP", "OCEANFRONT" ], "type": "string", "enumDeprecated": [ false, false, false, false, false, true, true ] }, "path": { "type": "string", "description": "The url of the sitemap." }, "errors": { "type": "string", "format": "int64", "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." }, "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)." }, "isPending": { "description": "If true, the sitemap has not been processed.", "type": "boolean" }, "contents": { "description": "The various content types in the sitemap.", "items": { "$ref": "WmxSitemapContent" }, "type": "array" }, "warnings": { "type": "string", "format": "int64", "description": "Number of warnings for the sitemap. These are generally non-critical issues with URLs in the sitemaps." }, "isSitemapsIndex": { "type": "boolean", "description": "If true, the sitemap is a collection of sitemaps." }, "lastSubmitted": { "type": "string", "format": "google-datetime", "description": "Date & time in which this sitemap was submitted. Date format is in RFC 3339 format (yyyy-mm-dd)." } } }, "RichResultsInspectionResult": { "properties": { "verdict": { "description": "High-level rich results inspection result for this URL.", "type": "string", "enumDescriptions": [ "Unknown verdict.", "Equivalent to \"Valid\" for the page or item in Search Console.", "Reserved, no longer in use.", "Equivalent to \"Error\" or \"Invalid\" for the page or item in Search Console.", "Equivalent to \"Excluded\" for the page or item in Search Console." ], "enum": [ "VERDICT_UNSPECIFIED", "PASS", "PARTIAL", "FAIL", "NEUTRAL" ] }, "detectedItems": { "description": "A list of zero or more rich results detected on this page. Rich results that cannot even be parsed due to syntactic issues will not be listed here.", "items": { "$ref": "DetectedItems" }, "type": "array" } }, "type": "object", "id": "RichResultsInspectionResult", "description": "Rich-Results inspection result, including any rich results found at this URL." } }, "rootUrl": "https://searchconsole.googleapis.com/" }