{ "baseUrl": "https://searchconsole.googleapis.com/", "canonicalName": "Search Console", "servicePath": "", "description": "Provides tools for running validation tests against single URLs", "kind": "discovery#restDescription", "rootUrl": "https://searchconsole.googleapis.com/", "basePath": "", "ownerDomain": "google.com", "name": "searchconsole", "batchPath": "batch", "id": "searchconsole:v1", "documentationLink": "https://developers.google.com/webmaster-tools/search-console-api/", "revision": "20170802", "title": "Google Search Console URL Testing Tools API", "ownerName": "Google", "discoveryVersion": "v1", "version_module": "True", "resources": { "urlTestingTools": { "resources": { "mobileFriendlyTest": { "methods": { "run": { "flatPath": "v1/urlTestingTools/mobileFriendlyTest:run", "path": "v1/urlTestingTools/mobileFriendlyTest:run", "id": "searchconsole.urlTestingTools.mobileFriendlyTest.run", "request": { "$ref": "RunMobileFriendlyTestRequest" }, "description": "Runs Mobile-Friendly Test for a given URL.", "httpMethod": "POST", "parameterOrder": [], "response": { "$ref": "RunMobileFriendlyTestResponse" }, "parameters": {} } } } } } }, "parameters": { "quotaUser": { "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.", "type": "string" }, "pp": { "description": "Pretty-print response.", "default": "true", "type": "boolean", "location": "query" }, "oauth_token": { "location": "query", "description": "OAuth 2.0 token for the current user.", "type": "string" }, "bearer_token": { "location": "query", "description": "OAuth bearer token.", "type": "string" }, "upload_protocol": { "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "type": "string", "location": "query" }, "prettyPrint": { "description": "Returns response with indentations and line breaks.", "default": "true", "type": "boolean", "location": "query" }, "uploadType": { "location": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "type": "string" }, "fields": { "location": "query", "description": "Selector specifying which fields to include in a partial response.", "type": "string" }, "callback": { "location": "query", "description": "JSONP", "type": "string" }, "$.xgafv": { "description": "V1 error format.", "type": "string", "enumDescriptions": [ "v1 error format", "v2 error format" ], "location": "query", "enum": [ "1", "2" ] }, "alt": { "description": "Data format for response.", "default": "json", "enum": [ "json", "media", "proto" ], "type": "string", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "location": "query" }, "access_token": { "location": "query", "description": "OAuth access token.", "type": "string" }, "key": { "location": "query", "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.", "type": "string" } }, "schemas": { "Image": { "description": "Describe image data.", "type": "object", "properties": { "mimeType": { "description": "The mime-type of the image data.", "type": "string" }, "data": { "format": "byte", "description": "Image data in format determined by the mime type. Currently, the format\nwill always be \"image/png\", but this might change in the future.", "type": "string" } }, "id": "Image" }, "RunMobileFriendlyTestRequest": { "description": "Mobile-friendly test request.", "type": "object", "properties": { "requestScreenshot": { "description": "Whether or not screenshot is requested. Default is false.", "type": "boolean" }, "url": { "description": "URL for inspection.", "type": "string" } }, "id": "RunMobileFriendlyTestRequest" }, "MobileFriendlyIssue": { "description": "Mobile-friendly issue.", "type": "object", "properties": { "rule": { "enumDescriptions": [ "Unknown rule. Sorry, we don't have any description for the rule that was\nbroken.", "Plugins incompatible with mobile devices are being used. [Learn more]\n(https://support.google.com/webmasters/answer/6352293#flash_usage).", "Viewsport is not specified using the meta viewport tag. [Learn more]\n(https://support.google.com/webmasters/answer/6352293#viewport_not_configured).", "Viewport defined to a fixed width. [Learn more]\n(https://support.google.com/webmasters/answer/6352293#fixed-width_viewport).", "Content not sized to viewport. [Learn more]\n(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]\n(https://support.google.com/webmasters/answer/6352293#small_font_size).", "Touch elements are too close to each other. [Learn more]\n(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" ], "description": "Rule violated.", "type": "string" } }, "id": "MobileFriendlyIssue" }, "RunMobileFriendlyTestResponse": { "description": "Mobile-friendly test response, including mobile-friendly issues and resource\nissues.", "type": "object", "properties": { "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." ], "enum": [ "MOBILE_FRIENDLY_TEST_RESULT_UNSPECIFIED", "MOBILE_FRIENDLY", "NOT_MOBILE_FRIENDLY" ], "description": "Test verdict, whether the page is mobile friendly or not.", "type": "string" }, "mobileFriendlyIssues": { "description": "List of mobile-usability issues.", "items": { "$ref": "MobileFriendlyIssue" }, "type": "array" }, "screenshot": { "description": "Screenshot of the requested URL.", "$ref": "Image" }, "resourceIssues": { "description": "Information about embedded resources issues.", "items": { "$ref": "ResourceIssue" }, "type": "array" }, "testStatus": { "$ref": "TestStatus", "description": "Final state of the test, can be either complete or an error." } }, "id": "RunMobileFriendlyTestResponse" }, "ResourceIssue": { "description": "Information about a resource with issue.", "type": "object", "properties": { "blockedResource": { "$ref": "BlockedResource", "description": "Describes a blocked resource issue." } }, "id": "ResourceIssue" }, "BlockedResource": { "description": "Blocked resource.", "type": "object", "properties": { "url": { "description": "URL of the blocked resource.", "type": "string" } }, "id": "BlockedResource" }, "TestStatus": { "description": "Final state of the test, including error details if necessary.", "type": "object", "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\nGoogle'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\nblockage, a 403 or 500 code etc. Please make sure that the URL provided is\naccessible by Googlebot and is not password protected." ], "enum": [ "TEST_STATUS_UNSPECIFIED", "COMPLETE", "INTERNAL_ERROR", "PAGE_UNREACHABLE" ] }, "details": { "description": "Error details if applicable.", "type": "string" } }, "id": "TestStatus" } }, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "protocol": "rest", "version": "v1" }