OLD | NEW |
1 { | 1 { |
2 "basePath": "", | 2 "basePath": "", |
3 "baseUrl": "https://searchconsole.googleapis.com/", | 3 "baseUrl": "https://searchconsole.googleapis.com/", |
4 "batchPath": "batch", | 4 "batchPath": "batch", |
5 "canonicalName": "Search Console", | 5 "canonicalName": "Search Console", |
6 "description": "Provides tools for running validation tests against single U
RLs", | 6 "description": "Provides tools for running validation tests against single U
RLs", |
7 "discoveryVersion": "v1", | 7 "discoveryVersion": "v1", |
8 "documentationLink": "https://developers.google.com/webmaster-tools/search-c
onsole-api/", | 8 "documentationLink": "https://developers.google.com/webmaster-tools/search-c
onsole-api/", |
9 "icons": { | 9 "icons": { |
10 "x16": "http://www.google.com/images/icons/product/search-16.gif", | 10 "x16": "http://www.google.com/images/icons/product/search-16.gif", |
11 "x32": "http://www.google.com/images/icons/product/search-32.gif" | 11 "x32": "http://www.google.com/images/icons/product/search-32.gif" |
12 }, | 12 }, |
13 "id": "searchconsole:v1", | 13 "id": "searchconsole:v1", |
14 "kind": "discovery#restDescription", | 14 "kind": "discovery#restDescription", |
15 "name": "searchconsole", | 15 "name": "searchconsole", |
16 "ownerDomain": "google.com", | 16 "ownerDomain": "google.com", |
17 "ownerName": "Google", | 17 "ownerName": "Google", |
18 "parameters": { | 18 "parameters": { |
| 19 "upload_protocol": { |
| 20 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
| 21 "location": "query", |
| 22 "type": "string" |
| 23 }, |
| 24 "prettyPrint": { |
| 25 "default": "true", |
| 26 "description": "Returns response with indentations and line breaks."
, |
| 27 "location": "query", |
| 28 "type": "boolean" |
| 29 }, |
| 30 "uploadType": { |
| 31 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
| 32 "location": "query", |
| 33 "type": "string" |
| 34 }, |
| 35 "fields": { |
| 36 "description": "Selector specifying which fields to include in a par
tial response.", |
| 37 "location": "query", |
| 38 "type": "string" |
| 39 }, |
| 40 "callback": { |
| 41 "description": "JSONP", |
| 42 "location": "query", |
| 43 "type": "string" |
| 44 }, |
| 45 "$.xgafv": { |
| 46 "description": "V1 error format.", |
| 47 "enum": [ |
| 48 "1", |
| 49 "2" |
| 50 ], |
| 51 "enumDescriptions": [ |
| 52 "v1 error format", |
| 53 "v2 error format" |
| 54 ], |
| 55 "location": "query", |
| 56 "type": "string" |
| 57 }, |
19 "alt": { | 58 "alt": { |
20 "default": "json", | 59 "default": "json", |
21 "description": "Data format for response.", | 60 "description": "Data format for response.", |
22 "enum": [ | 61 "enum": [ |
23 "json", | 62 "json", |
24 "media", | 63 "media", |
25 "proto" | 64 "proto" |
26 ], | 65 ], |
27 "enumDescriptions": [ | 66 "enumDescriptions": [ |
28 "Responses with Content-Type of application/json", | 67 "Responses with Content-Type of application/json", |
(...skipping 17 matching lines...) Expand all Loading... |
46 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters.", | 85 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters.", |
47 "location": "query", | 86 "location": "query", |
48 "type": "string" | 87 "type": "string" |
49 }, | 88 }, |
50 "pp": { | 89 "pp": { |
51 "default": "true", | 90 "default": "true", |
52 "description": "Pretty-print response.", | 91 "description": "Pretty-print response.", |
53 "location": "query", | 92 "location": "query", |
54 "type": "boolean" | 93 "type": "boolean" |
55 }, | 94 }, |
56 "oauth_token": { | |
57 "description": "OAuth 2.0 token for the current user.", | |
58 "location": "query", | |
59 "type": "string" | |
60 }, | |
61 "bearer_token": { | 95 "bearer_token": { |
62 "description": "OAuth bearer token.", | 96 "description": "OAuth bearer token.", |
63 "location": "query", | 97 "location": "query", |
64 "type": "string" | 98 "type": "string" |
65 }, | 99 }, |
66 "upload_protocol": { | 100 "oauth_token": { |
67 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | 101 "description": "OAuth 2.0 token for the current user.", |
68 "location": "query", | |
69 "type": "string" | |
70 }, | |
71 "prettyPrint": { | |
72 "default": "true", | |
73 "description": "Returns response with indentations and line breaks."
, | |
74 "location": "query", | |
75 "type": "boolean" | |
76 }, | |
77 "fields": { | |
78 "description": "Selector specifying which fields to include in a par
tial response.", | |
79 "location": "query", | |
80 "type": "string" | |
81 }, | |
82 "uploadType": { | |
83 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", | |
84 "location": "query", | |
85 "type": "string" | |
86 }, | |
87 "callback": { | |
88 "description": "JSONP", | |
89 "location": "query", | |
90 "type": "string" | |
91 }, | |
92 "$.xgafv": { | |
93 "description": "V1 error format.", | |
94 "enum": [ | |
95 "1", | |
96 "2" | |
97 ], | |
98 "enumDescriptions": [ | |
99 "v1 error format", | |
100 "v2 error format" | |
101 ], | |
102 "location": "query", | 102 "location": "query", |
103 "type": "string" | 103 "type": "string" |
104 } | 104 } |
105 }, | 105 }, |
106 "protocol": "rest", | 106 "protocol": "rest", |
107 "resources": { | 107 "resources": { |
108 "urlTestingTools": { | 108 "urlTestingTools": { |
109 "resources": { | 109 "resources": { |
110 "mobileFriendlyTest": { | 110 "mobileFriendlyTest": { |
111 "methods": { | 111 "methods": { |
112 "run": { | 112 "run": { |
113 "description": "Runs Mobile-Friendly Test for a give
n URL.", | 113 "description": "Runs Mobile-Friendly Test for a give
n URL.", |
114 "httpMethod": "POST", | 114 "httpMethod": "POST", |
115 "id": "searchconsole.urlTestingTools.mobileFriendlyT
est.run", | 115 "id": "searchconsole.urlTestingTools.mobileFriendlyT
est.run", |
116 "parameterOrder": [], | 116 "parameterOrder": [], |
117 "parameters": {}, | 117 "parameters": {}, |
118 "path": "v1/urlTestingTools/mobileFriendlyTest:run", | 118 "path": "v1/urlTestingTools/mobileFriendlyTest:run", |
119 "request": { | 119 "request": { |
120 "$ref": "RunMobileFriendlyTestRequest" | 120 "$ref": "RunMobileFriendlyTestRequest" |
121 }, | 121 }, |
122 "response": { | 122 "response": { |
123 "$ref": "RunMobileFriendlyTestResponse" | 123 "$ref": "RunMobileFriendlyTestResponse" |
124 } | 124 } |
125 } | 125 } |
126 } | 126 } |
127 } | 127 } |
128 } | 128 } |
129 } | 129 } |
130 }, | 130 }, |
131 "revision": "20170819", | 131 "revision": "20170905", |
132 "rootUrl": "https://searchconsole.googleapis.com/", | 132 "rootUrl": "https://searchconsole.googleapis.com/", |
133 "schemas": { | 133 "schemas": { |
134 "RunMobileFriendlyTestResponse": { | |
135 "description": "Mobile-friendly test response, including mobile-frie
ndly issues and resource\nissues.", | |
136 "id": "RunMobileFriendlyTestResponse", | |
137 "properties": { | |
138 "screenshot": { | |
139 "$ref": "Image", | |
140 "description": "Screenshot of the requested URL." | |
141 }, | |
142 "resourceIssues": { | |
143 "description": "Information about embedded resources issues.
", | |
144 "items": { | |
145 "$ref": "ResourceIssue" | |
146 }, | |
147 "type": "array" | |
148 }, | |
149 "testStatus": { | |
150 "$ref": "TestStatus", | |
151 "description": "Final state of the test, can be either compl
ete or an error." | |
152 }, | |
153 "mobileFriendliness": { | |
154 "description": "Test verdict, whether the page is mobile fri
endly or not.", | |
155 "enum": [ | |
156 "MOBILE_FRIENDLY_TEST_RESULT_UNSPECIFIED", | |
157 "MOBILE_FRIENDLY", | |
158 "NOT_MOBILE_FRIENDLY" | |
159 ], | |
160 "enumDescriptions": [ | |
161 "Internal error when running this test. Please try runni
ng the test again.", | |
162 "The page is mobile friendly.", | |
163 "The page is not mobile friendly." | |
164 ], | |
165 "type": "string" | |
166 }, | |
167 "mobileFriendlyIssues": { | |
168 "description": "List of mobile-usability issues.", | |
169 "items": { | |
170 "$ref": "MobileFriendlyIssue" | |
171 }, | |
172 "type": "array" | |
173 } | |
174 }, | |
175 "type": "object" | |
176 }, | |
177 "ResourceIssue": { | |
178 "description": "Information about a resource with issue.", | |
179 "id": "ResourceIssue", | |
180 "properties": { | |
181 "blockedResource": { | |
182 "$ref": "BlockedResource", | |
183 "description": "Describes a blocked resource issue." | |
184 } | |
185 }, | |
186 "type": "object" | |
187 }, | |
188 "BlockedResource": { | 134 "BlockedResource": { |
189 "description": "Blocked resource.", | 135 "description": "Blocked resource.", |
190 "id": "BlockedResource", | 136 "id": "BlockedResource", |
191 "properties": { | 137 "properties": { |
192 "url": { | 138 "url": { |
193 "description": "URL of the blocked resource.", | 139 "description": "URL of the blocked resource.", |
194 "type": "string" | 140 "type": "string" |
195 } | 141 } |
196 }, | 142 }, |
197 "type": "object" | 143 "type": "object" |
198 }, | 144 }, |
199 "TestStatus": { | 145 "TestStatus": { |
200 "description": "Final state of the test, including error details if
necessary.", | 146 "description": "Final state of the test, including error details if
necessary.", |
201 "id": "TestStatus", | 147 "id": "TestStatus", |
202 "properties": { | 148 "properties": { |
203 "details": { | |
204 "description": "Error details if applicable.", | |
205 "type": "string" | |
206 }, | |
207 "status": { | 149 "status": { |
208 "description": "Status of the test.", | 150 "description": "Status of the test.", |
209 "enum": [ | 151 "enum": [ |
210 "TEST_STATUS_UNSPECIFIED", | 152 "TEST_STATUS_UNSPECIFIED", |
211 "COMPLETE", | 153 "COMPLETE", |
212 "INTERNAL_ERROR", | 154 "INTERNAL_ERROR", |
213 "PAGE_UNREACHABLE" | 155 "PAGE_UNREACHABLE" |
214 ], | 156 ], |
215 "enumDescriptions": [ | 157 "enumDescriptions": [ |
216 "Internal error when running this test. Please try runni
ng the test again.", | 158 "Internal error when running this test. Please try runni
ng the test again.", |
217 "Inspection has completed without errors.", | 159 "Inspection has completed without errors.", |
218 "Inspection terminated in an error state. This indicates
a problem in\nGoogle's infrastructure, not a user error. Please try again later
.", | 160 "Inspection terminated in an error state. This indicates
a problem in\nGoogle's infrastructure, not a user error. Please try again later
.", |
219 "Google can not access the URL because of a user error s
uch 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." | 161 "Google can not access the URL because of a user error s
uch 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." |
220 ], | 162 ], |
221 "type": "string" | 163 "type": "string" |
| 164 }, |
| 165 "details": { |
| 166 "description": "Error details if applicable.", |
| 167 "type": "string" |
222 } | 168 } |
223 }, | 169 }, |
224 "type": "object" | 170 "type": "object" |
| 171 }, |
| 172 "RunMobileFriendlyTestRequest": { |
| 173 "description": "Mobile-friendly test request.", |
| 174 "id": "RunMobileFriendlyTestRequest", |
| 175 "properties": { |
| 176 "requestScreenshot": { |
| 177 "description": "Whether or not screenshot is requested. Defa
ult is false.", |
| 178 "type": "boolean" |
| 179 }, |
| 180 "url": { |
| 181 "description": "URL for inspection.", |
| 182 "type": "string" |
| 183 } |
| 184 }, |
| 185 "type": "object" |
225 }, | 186 }, |
226 "Image": { | 187 "Image": { |
227 "description": "Describe image data.", | 188 "description": "Describe image data.", |
228 "id": "Image", | 189 "id": "Image", |
229 "properties": { | 190 "properties": { |
230 "mimeType": { | 191 "mimeType": { |
231 "description": "The mime-type of the image data.", | 192 "description": "The mime-type of the image data.", |
232 "type": "string" | 193 "type": "string" |
233 }, | 194 }, |
234 "data": { | 195 "data": { |
235 "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.", | 196 "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.", |
236 "format": "byte", | 197 "format": "byte", |
237 "type": "string" | 198 "type": "string" |
238 } | 199 } |
239 }, | 200 }, |
240 "type": "object" | 201 "type": "object" |
241 }, | 202 }, |
242 "RunMobileFriendlyTestRequest": { | |
243 "description": "Mobile-friendly test request.", | |
244 "id": "RunMobileFriendlyTestRequest", | |
245 "properties": { | |
246 "url": { | |
247 "description": "URL for inspection.", | |
248 "type": "string" | |
249 }, | |
250 "requestScreenshot": { | |
251 "description": "Whether or not screenshot is requested. Defa
ult is false.", | |
252 "type": "boolean" | |
253 } | |
254 }, | |
255 "type": "object" | |
256 }, | |
257 "MobileFriendlyIssue": { | 203 "MobileFriendlyIssue": { |
258 "description": "Mobile-friendly issue.", | 204 "description": "Mobile-friendly issue.", |
259 "id": "MobileFriendlyIssue", | 205 "id": "MobileFriendlyIssue", |
260 "properties": { | 206 "properties": { |
261 "rule": { | 207 "rule": { |
262 "description": "Rule violated.", | 208 "description": "Rule violated.", |
263 "enum": [ | 209 "enum": [ |
264 "MOBILE_FRIENDLY_RULE_UNSPECIFIED", | 210 "MOBILE_FRIENDLY_RULE_UNSPECIFIED", |
265 "USES_INCOMPATIBLE_PLUGINS", | 211 "USES_INCOMPATIBLE_PLUGINS", |
266 "CONFIGURE_VIEWPORT", | 212 "CONFIGURE_VIEWPORT", |
267 "FIXED_WIDTH_VIEWPORT", | 213 "FIXED_WIDTH_VIEWPORT", |
268 "SIZE_CONTENT_TO_VIEWPORT", | 214 "SIZE_CONTENT_TO_VIEWPORT", |
269 "USE_LEGIBLE_FONT_SIZES", | 215 "USE_LEGIBLE_FONT_SIZES", |
270 "TAP_TARGETS_TOO_CLOSE" | 216 "TAP_TARGETS_TOO_CLOSE" |
271 ], | 217 ], |
272 "enumDescriptions": [ | 218 "enumDescriptions": [ |
273 "Unknown rule. Sorry, we don't have any description for
the rule that was\nbroken.", | 219 "Unknown rule. Sorry, we don't have any description for
the rule that was\nbroken.", |
274 "Plugins incompatible with mobile devices are being used
. [Learn more]\n(https://support.google.com/webmasters/answer/6352293#flash_usag
e).", | 220 "Plugins incompatible with mobile devices are being used
. [Learn more]\n(https://support.google.com/webmasters/answer/6352293#flash_usag
e).", |
275 "Viewsport is not specified using the meta viewport tag.
[Learn more]\n(https://support.google.com/webmasters/answer/6352293#viewport_no
t_configured).", | 221 "Viewsport is not specified using the meta viewport tag.
[Learn more]\n(https://support.google.com/webmasters/answer/6352293#viewport_no
t_configured).", |
276 "Viewport defined to a fixed width. [Learn more]\n(https
://support.google.com/webmasters/answer/6352293#fixed-width_viewport).", | 222 "Viewport defined to a fixed width. [Learn more]\n(https
://support.google.com/webmasters/answer/6352293#fixed-width_viewport).", |
277 "Content not sized to viewport. [Learn more]\n(https://s
upport.google.com/webmasters/answer/6352293#content_not_sized_to_viewport).", | 223 "Content not sized to viewport. [Learn more]\n(https://s
upport.google.com/webmasters/answer/6352293#content_not_sized_to_viewport).", |
278 "Font size is too small for easy reading on a small scre
en. [Learn More]\n(https://support.google.com/webmasters/answer/6352293#small_fo
nt_size).", | 224 "Font size is too small for easy reading on a small scre
en. [Learn More]\n(https://support.google.com/webmasters/answer/6352293#small_fo
nt_size).", |
279 "Touch elements are too close to each other. [Learn more
]\n(https://support.google.com/webmasters/answer/6352293#touch_elements_too_clos
e)." | 225 "Touch elements are too close to each other. [Learn more
]\n(https://support.google.com/webmasters/answer/6352293#touch_elements_too_clos
e)." |
280 ], | 226 ], |
281 "type": "string" | 227 "type": "string" |
282 } | 228 } |
283 }, | 229 }, |
284 "type": "object" | 230 "type": "object" |
| 231 }, |
| 232 "RunMobileFriendlyTestResponse": { |
| 233 "description": "Mobile-friendly test response, including mobile-frie
ndly issues and resource\nissues.", |
| 234 "id": "RunMobileFriendlyTestResponse", |
| 235 "properties": { |
| 236 "testStatus": { |
| 237 "$ref": "TestStatus", |
| 238 "description": "Final state of the test, can be either compl
ete or an error." |
| 239 }, |
| 240 "resourceIssues": { |
| 241 "description": "Information about embedded resources issues.
", |
| 242 "items": { |
| 243 "$ref": "ResourceIssue" |
| 244 }, |
| 245 "type": "array" |
| 246 }, |
| 247 "mobileFriendliness": { |
| 248 "description": "Test verdict, whether the page is mobile fri
endly or not.", |
| 249 "enum": [ |
| 250 "MOBILE_FRIENDLY_TEST_RESULT_UNSPECIFIED", |
| 251 "MOBILE_FRIENDLY", |
| 252 "NOT_MOBILE_FRIENDLY" |
| 253 ], |
| 254 "enumDescriptions": [ |
| 255 "Internal error when running this test. Please try runni
ng the test again.", |
| 256 "The page is mobile friendly.", |
| 257 "The page is not mobile friendly." |
| 258 ], |
| 259 "type": "string" |
| 260 }, |
| 261 "mobileFriendlyIssues": { |
| 262 "description": "List of mobile-usability issues.", |
| 263 "items": { |
| 264 "$ref": "MobileFriendlyIssue" |
| 265 }, |
| 266 "type": "array" |
| 267 }, |
| 268 "screenshot": { |
| 269 "$ref": "Image", |
| 270 "description": "Screenshot of the requested URL." |
| 271 } |
| 272 }, |
| 273 "type": "object" |
| 274 }, |
| 275 "ResourceIssue": { |
| 276 "description": "Information about a resource with issue.", |
| 277 "id": "ResourceIssue", |
| 278 "properties": { |
| 279 "blockedResource": { |
| 280 "$ref": "BlockedResource", |
| 281 "description": "Describes a blocked resource issue." |
| 282 } |
| 283 }, |
| 284 "type": "object" |
285 } | 285 } |
286 }, | 286 }, |
287 "servicePath": "", | 287 "servicePath": "", |
288 "title": "Google Search Console URL Testing Tools API", | 288 "title": "Google Search Console URL Testing Tools API", |
289 "version": "v1" | 289 "version": "v1" |
290 } | 290 } |
OLD | NEW |