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 "quotaUser": { | |
20 "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.", | |
21 "location": "query", | |
22 "type": "string" | |
23 }, | |
24 "pp": { | |
25 "default": "true", | |
26 "description": "Pretty-print response.", | |
27 "location": "query", | |
28 "type": "boolean" | |
29 }, | |
30 "oauth_token": { | |
31 "description": "OAuth 2.0 token for the current user.", | |
32 "location": "query", | |
33 "type": "string" | |
34 }, | |
35 "bearer_token": { | |
36 "description": "OAuth bearer token.", | |
37 "location": "query", | |
38 "type": "string" | |
39 }, | |
40 "upload_protocol": { | 19 "upload_protocol": { |
41 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | 20 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
42 "location": "query", | 21 "location": "query", |
43 "type": "string" | 22 "type": "string" |
44 }, | 23 }, |
45 "prettyPrint": { | 24 "prettyPrint": { |
46 "default": "true", | 25 "default": "true", |
47 "description": "Returns response with indentations and line breaks."
, | 26 "description": "Returns response with indentations and line breaks."
, |
48 "location": "query", | 27 "location": "query", |
49 "type": "boolean" | 28 "type": "boolean" |
(...skipping 44 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
94 }, | 73 }, |
95 "key": { | 74 "key": { |
96 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", | 75 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", |
97 "location": "query", | 76 "location": "query", |
98 "type": "string" | 77 "type": "string" |
99 }, | 78 }, |
100 "access_token": { | 79 "access_token": { |
101 "description": "OAuth access token.", | 80 "description": "OAuth access token.", |
102 "location": "query", | 81 "location": "query", |
103 "type": "string" | 82 "type": "string" |
| 83 }, |
| 84 "quotaUser": { |
| 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.", |
| 86 "location": "query", |
| 87 "type": "string" |
| 88 }, |
| 89 "pp": { |
| 90 "default": "true", |
| 91 "description": "Pretty-print response.", |
| 92 "location": "query", |
| 93 "type": "boolean" |
| 94 }, |
| 95 "oauth_token": { |
| 96 "description": "OAuth 2.0 token for the current user.", |
| 97 "location": "query", |
| 98 "type": "string" |
| 99 }, |
| 100 "bearer_token": { |
| 101 "description": "OAuth bearer token.", |
| 102 "location": "query", |
| 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": "20170520", | 131 "revision": "20170610", |
132 "rootUrl": "https://searchconsole.googleapis.com/", | 132 "rootUrl": "https://searchconsole.googleapis.com/", |
133 "schemas": { | 133 "schemas": { |
| 134 "BlockedResource": { |
| 135 "description": "Blocked resource.", |
| 136 "id": "BlockedResource", |
| 137 "properties": { |
| 138 "url": { |
| 139 "description": "URL of the blocked resource.", |
| 140 "type": "string" |
| 141 } |
| 142 }, |
| 143 "type": "object" |
| 144 }, |
| 145 "TestStatus": { |
| 146 "description": "Final state of the test, including error details if
necessary.", |
| 147 "id": "TestStatus", |
| 148 "properties": { |
| 149 "status": { |
| 150 "description": "Status of the test.", |
| 151 "enum": [ |
| 152 "TEST_STATUS_UNSPECIFIED", |
| 153 "COMPLETE", |
| 154 "INTERNAL_ERROR", |
| 155 "PAGE_UNREACHABLE" |
| 156 ], |
| 157 "enumDescriptions": [ |
| 158 "Internal error when running this test. Please try runni
ng the test again.", |
| 159 "Inspection has completed without errors.", |
| 160 "Inspection terminated in an error state. This indicates
a problem in\nGoogle's infrastructure, not a user error. Please try again later
.", |
| 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." |
| 162 ], |
| 163 "type": "string" |
| 164 }, |
| 165 "details": { |
| 166 "description": "Error details if applicable.", |
| 167 "type": "string" |
| 168 } |
| 169 }, |
| 170 "type": "object" |
| 171 }, |
| 172 "RunMobileFriendlyTestRequest": { |
| 173 "description": "Mobile-friendly test request.", |
| 174 "id": "RunMobileFriendlyTestRequest", |
| 175 "properties": { |
| 176 "url": { |
| 177 "description": "URL for inspection.", |
| 178 "type": "string" |
| 179 }, |
| 180 "requestScreenshot": { |
| 181 "description": "Whether or not screenshot is requested. Defa
ult is false.", |
| 182 "type": "boolean" |
| 183 } |
| 184 }, |
| 185 "type": "object" |
| 186 }, |
| 187 "Image": { |
| 188 "description": "Describe image data.", |
| 189 "id": "Image", |
| 190 "properties": { |
| 191 "mimeType": { |
| 192 "description": "The mime-type of the image data.", |
| 193 "type": "string" |
| 194 }, |
| 195 "data": { |
| 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.", |
| 197 "format": "byte", |
| 198 "type": "string" |
| 199 } |
| 200 }, |
| 201 "type": "object" |
| 202 }, |
134 "MobileFriendlyIssue": { | 203 "MobileFriendlyIssue": { |
135 "description": "Mobile-friendly issue.", | 204 "description": "Mobile-friendly issue.", |
136 "id": "MobileFriendlyIssue", | 205 "id": "MobileFriendlyIssue", |
137 "properties": { | 206 "properties": { |
138 "rule": { | 207 "rule": { |
139 "description": "Rule violated.", | 208 "description": "Rule violated.", |
140 "enum": [ | 209 "enum": [ |
141 "MOBILE_FRIENDLY_RULE_UNSPECIFIED", | 210 "MOBILE_FRIENDLY_RULE_UNSPECIFIED", |
142 "USES_INCOMPATIBLE_PLUGINS", | 211 "USES_INCOMPATIBLE_PLUGINS", |
143 "CONFIGURE_VIEWPORT", | 212 "CONFIGURE_VIEWPORT", |
(...skipping 13 matching lines...) Expand all Loading... |
157 ], | 226 ], |
158 "type": "string" | 227 "type": "string" |
159 } | 228 } |
160 }, | 229 }, |
161 "type": "object" | 230 "type": "object" |
162 }, | 231 }, |
163 "RunMobileFriendlyTestResponse": { | 232 "RunMobileFriendlyTestResponse": { |
164 "description": "Mobile-friendly test response, including mobile-frie
ndly issues and resource\nissues.", | 233 "description": "Mobile-friendly test response, including mobile-frie
ndly issues and resource\nissues.", |
165 "id": "RunMobileFriendlyTestResponse", | 234 "id": "RunMobileFriendlyTestResponse", |
166 "properties": { | 235 "properties": { |
167 "resourceIssues": { | |
168 "description": "Information about embedded resources issues.
", | |
169 "items": { | |
170 "$ref": "ResourceIssue" | |
171 }, | |
172 "type": "array" | |
173 }, | |
174 "testStatus": { | |
175 "$ref": "TestStatus", | |
176 "description": "Final state of the test, can be either compl
ete or an error." | |
177 }, | |
178 "mobileFriendliness": { | 236 "mobileFriendliness": { |
179 "description": "Test verdict, whether the page is mobile fri
endly or not.", | 237 "description": "Test verdict, whether the page is mobile fri
endly or not.", |
180 "enum": [ | 238 "enum": [ |
181 "MOBILE_FRIENDLY_TEST_RESULT_UNSPECIFIED", | 239 "MOBILE_FRIENDLY_TEST_RESULT_UNSPECIFIED", |
182 "MOBILE_FRIENDLY", | 240 "MOBILE_FRIENDLY", |
183 "NOT_MOBILE_FRIENDLY" | 241 "NOT_MOBILE_FRIENDLY" |
184 ], | 242 ], |
185 "enumDescriptions": [ | 243 "enumDescriptions": [ |
186 "Internal error when running this test. Please try runni
ng the test again.", | 244 "Internal error when running this test. Please try runni
ng the test again.", |
187 "The page is mobile friendly.", | 245 "The page is mobile friendly.", |
188 "The page is not mobile friendly." | 246 "The page is not mobile friendly." |
189 ], | 247 ], |
190 "type": "string" | 248 "type": "string" |
191 }, | 249 }, |
192 "mobileFriendlyIssues": { | 250 "mobileFriendlyIssues": { |
193 "description": "List of mobile-usability issues.", | 251 "description": "List of mobile-usability issues.", |
194 "items": { | 252 "items": { |
195 "$ref": "MobileFriendlyIssue" | 253 "$ref": "MobileFriendlyIssue" |
196 }, | 254 }, |
197 "type": "array" | 255 "type": "array" |
198 }, | 256 }, |
199 "screenshot": { | 257 "screenshot": { |
200 "$ref": "Image", | 258 "$ref": "Image", |
201 "description": "Screenshot of the requested URL." | 259 "description": "Screenshot of the requested URL." |
| 260 }, |
| 261 "resourceIssues": { |
| 262 "description": "Information about embedded resources issues.
", |
| 263 "items": { |
| 264 "$ref": "ResourceIssue" |
| 265 }, |
| 266 "type": "array" |
| 267 }, |
| 268 "testStatus": { |
| 269 "$ref": "TestStatus", |
| 270 "description": "Final state of the test, can be either compl
ete or an error." |
202 } | 271 } |
203 }, | 272 }, |
204 "type": "object" | 273 "type": "object" |
205 }, | 274 }, |
206 "ResourceIssue": { | 275 "ResourceIssue": { |
207 "description": "Information about a resource with issue.", | 276 "description": "Information about a resource with issue.", |
208 "id": "ResourceIssue", | 277 "id": "ResourceIssue", |
209 "properties": { | 278 "properties": { |
210 "blockedResource": { | 279 "blockedResource": { |
211 "$ref": "BlockedResource", | 280 "$ref": "BlockedResource", |
212 "description": "Describes a blocked resource issue." | 281 "description": "Describes a blocked resource issue." |
213 } | 282 } |
214 }, | 283 }, |
215 "type": "object" | 284 "type": "object" |
216 }, | |
217 "BlockedResource": { | |
218 "description": "Blocked resource.", | |
219 "id": "BlockedResource", | |
220 "properties": { | |
221 "url": { | |
222 "description": "URL of the blocked resource.", | |
223 "type": "string" | |
224 } | |
225 }, | |
226 "type": "object" | |
227 }, | |
228 "TestStatus": { | |
229 "description": "Final state of the test, including error details if
necessary.", | |
230 "id": "TestStatus", | |
231 "properties": { | |
232 "details": { | |
233 "description": "Error details if applicable.", | |
234 "type": "string" | |
235 }, | |
236 "status": { | |
237 "description": "Status of the test.", | |
238 "enum": [ | |
239 "TEST_STATUS_UNSPECIFIED", | |
240 "COMPLETE", | |
241 "INTERNAL_ERROR", | |
242 "PAGE_UNREACHABLE" | |
243 ], | |
244 "enumDescriptions": [ | |
245 "Internal error when running this test. Please try runni
ng the test again.", | |
246 "Inspection has completed without errors.", | |
247 "Inspection terminated in an error state. This indicates
a problem in\nGoogle's infrastructure, not a user error. Please try again later
.", | |
248 "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." | |
249 ], | |
250 "type": "string" | |
251 } | |
252 }, | |
253 "type": "object" | |
254 }, | |
255 "Image": { | |
256 "description": "Describe image data.", | |
257 "id": "Image", | |
258 "properties": { | |
259 "mimeType": { | |
260 "description": "The mime-type of the image data.", | |
261 "type": "string" | |
262 }, | |
263 "data": { | |
264 "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.", | |
265 "format": "byte", | |
266 "type": "string" | |
267 } | |
268 }, | |
269 "type": "object" | |
270 }, | |
271 "RunMobileFriendlyTestRequest": { | |
272 "description": "Mobile-friendly test request.", | |
273 "id": "RunMobileFriendlyTestRequest", | |
274 "properties": { | |
275 "requestScreenshot": { | |
276 "description": "Whether or not screenshot is requested. Defa
ult is false.", | |
277 "type": "boolean" | |
278 }, | |
279 "url": { | |
280 "description": "URL for inspection.", | |
281 "type": "string" | |
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 |