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 "bearer_token": { |
| 31 "description": "OAuth bearer token.", |
| 32 "location": "query", |
| 33 "type": "string" |
| 34 }, |
| 35 "oauth_token": { |
| 36 "description": "OAuth 2.0 token for the current user.", |
| 37 "location": "query", |
| 38 "type": "string" |
| 39 }, |
19 "upload_protocol": { | 40 "upload_protocol": { |
20 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | 41 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
21 "location": "query", | 42 "location": "query", |
22 "type": "string" | 43 "type": "string" |
23 }, | 44 }, |
24 "prettyPrint": { | 45 "prettyPrint": { |
25 "default": "true", | 46 "default": "true", |
26 "description": "Returns response with indentations and line breaks."
, | 47 "description": "Returns response with indentations and line breaks."
, |
27 "location": "query", | 48 "location": "query", |
28 "type": "boolean" | 49 "type": "boolean" |
29 }, | 50 }, |
| 51 "uploadType": { |
| 52 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
| 53 "location": "query", |
| 54 "type": "string" |
| 55 }, |
30 "fields": { | 56 "fields": { |
31 "description": "Selector specifying which fields to include in a par
tial response.", | 57 "description": "Selector specifying which fields to include in a par
tial response.", |
32 "location": "query", | 58 "location": "query", |
33 "type": "string" | 59 "type": "string" |
34 }, | 60 }, |
35 "uploadType": { | |
36 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", | |
37 "location": "query", | |
38 "type": "string" | |
39 }, | |
40 "callback": { | |
41 "description": "JSONP", | |
42 "location": "query", | |
43 "type": "string" | |
44 }, | |
45 "$.xgafv": { | 61 "$.xgafv": { |
46 "description": "V1 error format.", | 62 "description": "V1 error format.", |
47 "enum": [ | 63 "enum": [ |
48 "1", | 64 "1", |
49 "2" | 65 "2" |
50 ], | 66 ], |
51 "enumDescriptions": [ | 67 "enumDescriptions": [ |
52 "v1 error format", | 68 "v1 error format", |
53 "v2 error format" | 69 "v2 error format" |
54 ], | 70 ], |
55 "location": "query", | 71 "location": "query", |
56 "type": "string" | 72 "type": "string" |
57 }, | 73 }, |
| 74 "callback": { |
| 75 "description": "JSONP", |
| 76 "location": "query", |
| 77 "type": "string" |
| 78 }, |
58 "alt": { | 79 "alt": { |
59 "default": "json", | 80 "default": "json", |
60 "description": "Data format for response.", | 81 "description": "Data format for response.", |
61 "enum": [ | 82 "enum": [ |
62 "json", | 83 "json", |
63 "media", | 84 "media", |
64 "proto" | 85 "proto" |
65 ], | 86 ], |
66 "enumDescriptions": [ | 87 "enumDescriptions": [ |
67 "Responses with Content-Type of application/json", | 88 "Responses with Content-Type of application/json", |
68 "Media download with context-dependent Content-Type", | 89 "Media download with context-dependent Content-Type", |
69 "Responses with Content-Type of application/x-protobuf" | 90 "Responses with Content-Type of application/x-protobuf" |
70 ], | 91 ], |
71 "location": "query", | 92 "location": "query", |
72 "type": "string" | 93 "type": "string" |
73 }, | 94 }, |
74 "key": { | |
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.", | |
76 "location": "query", | |
77 "type": "string" | |
78 }, | |
79 "access_token": { | 95 "access_token": { |
80 "description": "OAuth access token.", | 96 "description": "OAuth access token.", |
81 "location": "query", | 97 "location": "query", |
82 "type": "string" | 98 "type": "string" |
83 }, | 99 }, |
84 "quotaUser": { | 100 "key": { |
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.", | 101 "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.", |
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", | 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": "20170610", | 131 "revision": "20170709", |
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 "resourceIssues": { |
| 139 "description": "Information about embedded resources issues.
", |
| 140 "items": { |
| 141 "$ref": "ResourceIssue" |
| 142 }, |
| 143 "type": "array" |
| 144 }, |
| 145 "testStatus": { |
| 146 "$ref": "TestStatus", |
| 147 "description": "Final state of the test, can be either compl
ete or an error." |
| 148 }, |
| 149 "mobileFriendliness": { |
| 150 "description": "Test verdict, whether the page is mobile fri
endly or not.", |
| 151 "enum": [ |
| 152 "MOBILE_FRIENDLY_TEST_RESULT_UNSPECIFIED", |
| 153 "MOBILE_FRIENDLY", |
| 154 "NOT_MOBILE_FRIENDLY" |
| 155 ], |
| 156 "enumDescriptions": [ |
| 157 "Internal error when running this test. Please try runni
ng the test again.", |
| 158 "The page is mobile friendly.", |
| 159 "The page is not mobile friendly." |
| 160 ], |
| 161 "type": "string" |
| 162 }, |
| 163 "mobileFriendlyIssues": { |
| 164 "description": "List of mobile-usability issues.", |
| 165 "items": { |
| 166 "$ref": "MobileFriendlyIssue" |
| 167 }, |
| 168 "type": "array" |
| 169 }, |
| 170 "screenshot": { |
| 171 "$ref": "Image", |
| 172 "description": "Screenshot of the requested URL." |
| 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 }, |
134 "BlockedResource": { | 188 "BlockedResource": { |
135 "description": "Blocked resource.", | 189 "description": "Blocked resource.", |
136 "id": "BlockedResource", | 190 "id": "BlockedResource", |
137 "properties": { | 191 "properties": { |
138 "url": { | 192 "url": { |
139 "description": "URL of the blocked resource.", | 193 "description": "URL of the blocked resource.", |
140 "type": "string" | 194 "type": "string" |
141 } | 195 } |
142 }, | 196 }, |
143 "type": "object" | 197 "type": "object" |
144 }, | 198 }, |
145 "TestStatus": { | 199 "TestStatus": { |
146 "description": "Final state of the test, including error details if
necessary.", | 200 "description": "Final state of the test, including error details if
necessary.", |
147 "id": "TestStatus", | 201 "id": "TestStatus", |
148 "properties": { | 202 "properties": { |
| 203 "details": { |
| 204 "description": "Error details if applicable.", |
| 205 "type": "string" |
| 206 }, |
149 "status": { | 207 "status": { |
150 "description": "Status of the test.", | 208 "description": "Status of the test.", |
151 "enum": [ | 209 "enum": [ |
152 "TEST_STATUS_UNSPECIFIED", | 210 "TEST_STATUS_UNSPECIFIED", |
153 "COMPLETE", | 211 "COMPLETE", |
154 "INTERNAL_ERROR", | 212 "INTERNAL_ERROR", |
155 "PAGE_UNREACHABLE" | 213 "PAGE_UNREACHABLE" |
156 ], | 214 ], |
157 "enumDescriptions": [ | 215 "enumDescriptions": [ |
158 "Internal error when running this test. Please try runni
ng the test again.", | 216 "Internal error when running this test. Please try runni
ng the test again.", |
159 "Inspection has completed without errors.", | 217 "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
.", | 218 "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." | 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." |
162 ], | 220 ], |
163 "type": "string" | 221 "type": "string" |
| 222 } |
| 223 }, |
| 224 "type": "object" |
| 225 }, |
| 226 "Image": { |
| 227 "description": "Describe image data.", |
| 228 "id": "Image", |
| 229 "properties": { |
| 230 "mimeType": { |
| 231 "description": "The mime-type of the image data.", |
| 232 "type": "string" |
164 }, | 233 }, |
165 "details": { | 234 "data": { |
166 "description": "Error details if applicable.", | 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.", |
| 236 "format": "byte", |
167 "type": "string" | 237 "type": "string" |
168 } | 238 } |
169 }, | 239 }, |
170 "type": "object" | 240 "type": "object" |
171 }, | 241 }, |
172 "RunMobileFriendlyTestRequest": { | 242 "RunMobileFriendlyTestRequest": { |
173 "description": "Mobile-friendly test request.", | 243 "description": "Mobile-friendly test request.", |
174 "id": "RunMobileFriendlyTestRequest", | 244 "id": "RunMobileFriendlyTestRequest", |
175 "properties": { | 245 "properties": { |
176 "url": { | 246 "url": { |
177 "description": "URL for inspection.", | 247 "description": "URL for inspection.", |
178 "type": "string" | 248 "type": "string" |
179 }, | 249 }, |
180 "requestScreenshot": { | 250 "requestScreenshot": { |
181 "description": "Whether or not screenshot is requested. Defa
ult is false.", | 251 "description": "Whether or not screenshot is requested. Defa
ult is false.", |
182 "type": "boolean" | 252 "type": "boolean" |
183 } | 253 } |
184 }, | 254 }, |
185 "type": "object" | 255 "type": "object" |
186 }, | 256 }, |
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 }, | |
203 "MobileFriendlyIssue": { | 257 "MobileFriendlyIssue": { |
204 "description": "Mobile-friendly issue.", | 258 "description": "Mobile-friendly issue.", |
205 "id": "MobileFriendlyIssue", | 259 "id": "MobileFriendlyIssue", |
206 "properties": { | 260 "properties": { |
207 "rule": { | 261 "rule": { |
208 "description": "Rule violated.", | 262 "description": "Rule violated.", |
209 "enum": [ | 263 "enum": [ |
210 "MOBILE_FRIENDLY_RULE_UNSPECIFIED", | 264 "MOBILE_FRIENDLY_RULE_UNSPECIFIED", |
211 "USES_INCOMPATIBLE_PLUGINS", | 265 "USES_INCOMPATIBLE_PLUGINS", |
212 "CONFIGURE_VIEWPORT", | 266 "CONFIGURE_VIEWPORT", |
213 "FIXED_WIDTH_VIEWPORT", | 267 "FIXED_WIDTH_VIEWPORT", |
214 "SIZE_CONTENT_TO_VIEWPORT", | 268 "SIZE_CONTENT_TO_VIEWPORT", |
215 "USE_LEGIBLE_FONT_SIZES", | 269 "USE_LEGIBLE_FONT_SIZES", |
216 "TAP_TARGETS_TOO_CLOSE" | 270 "TAP_TARGETS_TOO_CLOSE" |
217 ], | 271 ], |
218 "enumDescriptions": [ | 272 "enumDescriptions": [ |
219 "Unknown rule. Sorry, we don't have any description for
the rule that was\nbroken.", | 273 "Unknown rule. Sorry, we don't have any description for
the rule that was\nbroken.", |
220 "Plugins incompatible with mobile devices are being used
. [Learn more]\n(https://support.google.com/webmasters/answer/6352293#flash_usag
e).", | 274 "Plugins incompatible with mobile devices are being used
. [Learn more]\n(https://support.google.com/webmasters/answer/6352293#flash_usag
e).", |
221 "Viewsport is not specified using the meta viewport tag.
[Learn more]\n(https://support.google.com/webmasters/answer/6352293#viewport_no
t_configured).", | 275 "Viewsport is not specified using the meta viewport tag.
[Learn more]\n(https://support.google.com/webmasters/answer/6352293#viewport_no
t_configured).", |
222 "Viewport defined to a fixed width. [Learn more]\n(https
://support.google.com/webmasters/answer/6352293#fixed-width_viewport).", | 276 "Viewport defined to a fixed width. [Learn more]\n(https
://support.google.com/webmasters/answer/6352293#fixed-width_viewport).", |
223 "Content not sized to viewport. [Learn more]\n(https://s
upport.google.com/webmasters/answer/6352293#content_not_sized_to_viewport).", | 277 "Content not sized to viewport. [Learn more]\n(https://s
upport.google.com/webmasters/answer/6352293#content_not_sized_to_viewport).", |
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).", | 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).", |
225 "Touch elements are too close to each other. [Learn more
]\n(https://support.google.com/webmasters/answer/6352293#touch_elements_too_clos
e)." | 279 "Touch elements are too close to each other. [Learn more
]\n(https://support.google.com/webmasters/answer/6352293#touch_elements_too_clos
e)." |
226 ], | 280 ], |
227 "type": "string" | 281 "type": "string" |
228 } | 282 } |
229 }, | 283 }, |
230 "type": "object" | 284 "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 "mobileFriendliness": { | |
237 "description": "Test verdict, whether the page is mobile fri
endly or not.", | |
238 "enum": [ | |
239 "MOBILE_FRIENDLY_TEST_RESULT_UNSPECIFIED", | |
240 "MOBILE_FRIENDLY", | |
241 "NOT_MOBILE_FRIENDLY" | |
242 ], | |
243 "enumDescriptions": [ | |
244 "Internal error when running this test. Please try runni
ng the test again.", | |
245 "The page is mobile friendly.", | |
246 "The page is not mobile friendly." | |
247 ], | |
248 "type": "string" | |
249 }, | |
250 "mobileFriendlyIssues": { | |
251 "description": "List of mobile-usability issues.", | |
252 "items": { | |
253 "$ref": "MobileFriendlyIssue" | |
254 }, | |
255 "type": "array" | |
256 }, | |
257 "screenshot": { | |
258 "$ref": "Image", | |
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." | |
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 |