Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(447)

Issues Search
    My Issues | Starred     Open | Closed | All

Side by Side Diff: discovery/googleapis/webmasters__v3.json

Issue 612053002: Api roll 2: 2014-09-29 (Closed) Base URL: git@github.com:dart-lang/googleapis.git@master
Patch Set: Addressed more review comments Created 6 years, 2 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
« no previous file with comments | « discovery/googleapis/plus__v1.json ('k') | discovery/googleapis/youtube__v3.json » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
(Empty)
1 {
2 "auth": {
3 "oauth2": {
4 "scopes": {
5 "https://www.googleapis.com/auth/webmasters": {
6 "description": "View and modify Webmaster Tools data for you r verified sites"
7 },
8 "https://www.googleapis.com/auth/webmasters.readonly": {
9 "description": "View Webmaster Tools data for your verified sites"
10 }
11 }
12 }
13 },
14 "basePath": "/webmasters/v3/",
15 "baseUrl": "https://www.googleapis.com/webmasters/v3/",
16 "batchPath": "batch",
17 "description": "Lets you view Google Webmaster Tools data for your verified sites.",
18 "discoveryVersion": "v1",
19 "documentationLink": "https://developers.google.com/webmaster-tools/v3/welco me",
20 "etag": "\"uUWyYHXmEn-ab7WLvo8qNz2S8ws/sCAxuVQJb4ynjZxsnsm28T2muEw\"",
21 "icons": {
22 "x16": "https://www.google.com/images/icons/product/webmaster_tools-16.p ng",
23 "x32": "https://www.google.com/images/icons/product/webmaster_tools-32.p ng"
24 },
25 "id": "webmasters:v3",
26 "kind": "discovery#restDescription",
27 "name": "webmasters",
28 "ownerDomain": "google.com",
29 "ownerName": "Google",
30 "parameters": {
31 "alt": {
32 "default": "json",
33 "description": "Data format for the response.",
34 "enum": [
35 "json"
36 ],
37 "enumDescriptions": [
38 "Responses with Content-Type of application/json"
39 ],
40 "location": "query",
41 "type": "string"
42 },
43 "fields": {
44 "description": "Selector specifying which fields to include in a par tial response.",
45 "location": "query",
46 "type": "string"
47 },
48 "key": {
49 "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.",
50 "location": "query",
51 "type": "string"
52 },
53 "oauth_token": {
54 "description": "OAuth 2.0 token for the current user.",
55 "location": "query",
56 "type": "string"
57 },
58 "prettyPrint": {
59 "default": "true",
60 "description": "Returns response with indentations and line breaks." ,
61 "location": "query",
62 "type": "boolean"
63 },
64 "quotaUser": {
65 "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. Overrides userIp if both are provided.",
66 "location": "query",
67 "type": "string"
68 },
69 "userIp": {
70 "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
71 "location": "query",
72 "type": "string"
73 }
74 },
75 "protocol": "rest",
76 "resources": {
77 "sitemaps": {
78 "methods": {
79 "delete": {
80 "description": "Deletes a sitemap from this site.",
81 "httpMethod": "DELETE",
82 "id": "webmasters.sitemaps.delete",
83 "parameterOrder": [
84 "siteUrl",
85 "feedpath"
86 ],
87 "parameters": {
88 "feedpath": {
89 "description": "The URL of the actual sitemap (for e xample http://www.example.com/sitemap.xml).",
90 "location": "path",
91 "required": true,
92 "type": "string"
93 },
94 "siteUrl": {
95 "description": "The site's URL, including protocol, for example 'http://www.example.com/'",
96 "location": "path",
97 "required": true,
98 "type": "string"
99 }
100 },
101 "path": "sites/{siteUrl}/sitemaps/{feedpath}",
102 "scopes": [
103 "https://www.googleapis.com/auth/webmasters"
104 ]
105 },
106 "get": {
107 "description": "Retrieves information about a specific sitem ap.",
108 "httpMethod": "GET",
109 "id": "webmasters.sitemaps.get",
110 "parameterOrder": [
111 "siteUrl",
112 "feedpath"
113 ],
114 "parameters": {
115 "feedpath": {
116 "description": "The URL of the actual sitemap (for e xample http://www.example.com/sitemap.xml).",
117 "location": "path",
118 "required": true,
119 "type": "string"
120 },
121 "siteUrl": {
122 "description": "The site's URL, including protocol, for example 'http://www.example.com/'",
123 "location": "path",
124 "required": true,
125 "type": "string"
126 }
127 },
128 "path": "sites/{siteUrl}/sitemaps/{feedpath}",
129 "response": {
130 "$ref": "WmxSitemap"
131 },
132 "scopes": [
133 "https://www.googleapis.com/auth/webmasters",
134 "https://www.googleapis.com/auth/webmasters.readonly"
135 ]
136 },
137 "list": {
138 "description": "Lists sitemaps uploaded to the site.",
139 "httpMethod": "GET",
140 "id": "webmasters.sitemaps.list",
141 "parameterOrder": [
142 "siteUrl"
143 ],
144 "parameters": {
145 "siteUrl": {
146 "description": "The site's URL, including protocol, for example 'http://www.example.com/'",
147 "location": "path",
148 "required": true,
149 "type": "string"
150 },
151 "sitemapIndex": {
152 "description": "A URL of a site's sitemap index.",
153 "location": "query",
154 "type": "string"
155 }
156 },
157 "path": "sites/{siteUrl}/sitemaps",
158 "response": {
159 "$ref": "SitemapsListResponse"
160 },
161 "scopes": [
162 "https://www.googleapis.com/auth/webmasters",
163 "https://www.googleapis.com/auth/webmasters.readonly"
164 ]
165 },
166 "submit": {
167 "description": "Submits a sitemap for a site.",
168 "httpMethod": "PUT",
169 "id": "webmasters.sitemaps.submit",
170 "parameterOrder": [
171 "siteUrl",
172 "feedpath"
173 ],
174 "parameters": {
175 "feedpath": {
176 "description": "The URL of the sitemap to add.",
177 "location": "path",
178 "required": true,
179 "type": "string"
180 },
181 "siteUrl": {
182 "description": "The site's URL, including protocol, for example 'http://www.example.com/'",
183 "location": "path",
184 "required": true,
185 "type": "string"
186 }
187 },
188 "path": "sites/{siteUrl}/sitemaps/{feedpath}",
189 "scopes": [
190 "https://www.googleapis.com/auth/webmasters"
191 ]
192 }
193 }
194 },
195 "sites": {
196 "methods": {
197 "add": {
198 "description": "Adds a site to the set of the user's sites i n Webmaster Tools.",
199 "httpMethod": "PUT",
200 "id": "webmasters.sites.add",
201 "parameterOrder": [
202 "siteUrl"
203 ],
204 "parameters": {
205 "siteUrl": {
206 "description": "The URL of the site to add.",
207 "location": "path",
208 "required": true,
209 "type": "string"
210 }
211 },
212 "path": "sites/{siteUrl}",
213 "scopes": [
214 "https://www.googleapis.com/auth/webmasters"
215 ]
216 },
217 "delete": {
218 "description": "Removes a site from the set of the user's We bmaster Tools sites.",
219 "httpMethod": "DELETE",
220 "id": "webmasters.sites.delete",
221 "parameterOrder": [
222 "siteUrl"
223 ],
224 "parameters": {
225 "siteUrl": {
226 "description": "The site's URL, including protocol, for example 'http://www.example.com/'",
227 "location": "path",
228 "required": true,
229 "type": "string"
230 }
231 },
232 "path": "sites/{siteUrl}",
233 "scopes": [
234 "https://www.googleapis.com/auth/webmasters"
235 ]
236 },
237 "get": {
238 "description": "Retrieves information about specific site.",
239 "httpMethod": "GET",
240 "id": "webmasters.sites.get",
241 "parameterOrder": [
242 "siteUrl"
243 ],
244 "parameters": {
245 "siteUrl": {
246 "description": "The site's URL, including protocol, for example 'http://www.example.com/'",
247 "location": "path",
248 "required": true,
249 "type": "string"
250 }
251 },
252 "path": "sites/{siteUrl}",
253 "response": {
254 "$ref": "WmxSite"
255 },
256 "scopes": [
257 "https://www.googleapis.com/auth/webmasters",
258 "https://www.googleapis.com/auth/webmasters.readonly"
259 ]
260 },
261 "list": {
262 "description": "Lists your Webmaster Tools sites.",
263 "httpMethod": "GET",
264 "id": "webmasters.sites.list",
265 "path": "sites",
266 "response": {
267 "$ref": "SitesListResponse"
268 },
269 "scopes": [
270 "https://www.googleapis.com/auth/webmasters",
271 "https://www.googleapis.com/auth/webmasters.readonly"
272 ]
273 }
274 }
275 },
276 "urlcrawlerrorscounts": {
277 "methods": {
278 "query": {
279 "description": "Retrieves a time series of the number of URL crawl errors per error category and platform.",
280 "httpMethod": "GET",
281 "id": "webmasters.urlcrawlerrorscounts.query",
282 "parameterOrder": [
283 "siteUrl"
284 ],
285 "parameters": {
286 "category": {
287 "description": "The crawl error category, for exampl e 'serverError'. If not specified, we return results for all categories.",
288 "enum": [
289 "authPermissions",
290 "manyToOneRedirect",
291 "notFollowed",
292 "notFound",
293 "other",
294 "roboted",
295 "serverError",
296 "soft404"
297 ],
298 "enumDescriptions": [
299 "",
300 "",
301 "",
302 "",
303 "",
304 "",
305 "",
306 ""
307 ],
308 "location": "query",
309 "type": "string"
310 },
311 "latestCountsOnly": {
312 "default": "true",
313 "description": "If true, returns only the latest cra wl error counts.",
314 "location": "query",
315 "type": "boolean"
316 },
317 "platform": {
318 "description": "The user agent type (platform) that made the request, for example 'web'. If not specified, we return results for all platforms.",
319 "enum": [
320 "mobile",
321 "smartphoneOnly",
322 "web"
323 ],
324 "enumDescriptions": [
325 "",
326 "",
327 ""
328 ],
329 "location": "query",
330 "type": "string"
331 },
332 "siteUrl": {
333 "description": "The site's URL, including protocol, for example 'http://www.example.com/'",
334 "location": "path",
335 "required": true,
336 "type": "string"
337 }
338 },
339 "path": "sites/{siteUrl}/urlCrawlErrorsCounts/query",
340 "response": {
341 "$ref": "UrlCrawlErrorsCountsQueryResponse"
342 },
343 "scopes": [
344 "https://www.googleapis.com/auth/webmasters",
345 "https://www.googleapis.com/auth/webmasters.readonly"
346 ]
347 }
348 }
349 },
350 "urlcrawlerrorssamples": {
351 "methods": {
352 "get": {
353 "description": "Retrieves details about crawl errors for a s ite's sample URL.",
354 "httpMethod": "GET",
355 "id": "webmasters.urlcrawlerrorssamples.get",
356 "parameterOrder": [
357 "siteUrl",
358 "url",
359 "category",
360 "platform"
361 ],
362 "parameters": {
363 "category": {
364 "description": "The crawl error category, for exampl e 'authPermissions'",
365 "enum": [
366 "authPermissions",
367 "manyToOneRedirect",
368 "notFollowed",
369 "notFound",
370 "other",
371 "roboted",
372 "serverError",
373 "soft404"
374 ],
375 "enumDescriptions": [
376 "",
377 "",
378 "",
379 "",
380 "",
381 "",
382 "",
383 ""
384 ],
385 "location": "query",
386 "required": true,
387 "type": "string"
388 },
389 "platform": {
390 "description": "The user agent type (platform) that made the request, for example 'web'",
391 "enum": [
392 "mobile",
393 "smartphoneOnly",
394 "web"
395 ],
396 "enumDescriptions": [
397 "",
398 "",
399 ""
400 ],
401 "location": "query",
402 "required": true,
403 "type": "string"
404 },
405 "siteUrl": {
406 "description": "The site's URL, including protocol, for example 'http://www.example.com/'",
407 "location": "path",
408 "required": true,
409 "type": "string"
410 },
411 "url": {
412 "description": "The relative path (without the site) of the sample URL; must be one of the URLs returned by list",
413 "location": "path",
414 "required": true,
415 "type": "string"
416 }
417 },
418 "path": "sites/{siteUrl}/urlCrawlErrorsSamples/{url}",
419 "response": {
420 "$ref": "UrlCrawlErrorsSample"
421 },
422 "scopes": [
423 "https://www.googleapis.com/auth/webmasters",
424 "https://www.googleapis.com/auth/webmasters.readonly"
425 ]
426 },
427 "list": {
428 "description": "Lists a site's sample URLs for the specified crawl error category and platform.",
429 "httpMethod": "GET",
430 "id": "webmasters.urlcrawlerrorssamples.list",
431 "parameterOrder": [
432 "siteUrl",
433 "category",
434 "platform"
435 ],
436 "parameters": {
437 "category": {
438 "description": "The crawl error category, for exampl e 'authPermissions'",
439 "enum": [
440 "authPermissions",
441 "manyToOneRedirect",
442 "notFollowed",
443 "notFound",
444 "other",
445 "roboted",
446 "serverError",
447 "soft404"
448 ],
449 "enumDescriptions": [
450 "",
451 "",
452 "",
453 "",
454 "",
455 "",
456 "",
457 ""
458 ],
459 "location": "query",
460 "required": true,
461 "type": "string"
462 },
463 "platform": {
464 "description": "The user agent type (platform) that made the request, for example 'web'",
465 "enum": [
466 "mobile",
467 "smartphoneOnly",
468 "web"
469 ],
470 "enumDescriptions": [
471 "",
472 "",
473 ""
474 ],
475 "location": "query",
476 "required": true,
477 "type": "string"
478 },
479 "siteUrl": {
480 "description": "The site's URL, including protocol, for example 'http://www.example.com/'",
481 "location": "path",
482 "required": true,
483 "type": "string"
484 }
485 },
486 "path": "sites/{siteUrl}/urlCrawlErrorsSamples",
487 "response": {
488 "$ref": "UrlCrawlErrorsSamplesListResponse"
489 },
490 "scopes": [
491 "https://www.googleapis.com/auth/webmasters",
492 "https://www.googleapis.com/auth/webmasters.readonly"
493 ]
494 },
495 "markAsFixed": {
496 "description": "Marks the provided site's sample URL as fixe d, and removes it from the samples list.",
497 "httpMethod": "DELETE",
498 "id": "webmasters.urlcrawlerrorssamples.markAsFixed",
499 "parameterOrder": [
500 "siteUrl",
501 "url",
502 "category",
503 "platform"
504 ],
505 "parameters": {
506 "category": {
507 "description": "The crawl error category, for exampl e 'authPermissions'",
508 "enum": [
509 "authPermissions",
510 "manyToOneRedirect",
511 "notFollowed",
512 "notFound",
513 "other",
514 "roboted",
515 "serverError",
516 "soft404"
517 ],
518 "enumDescriptions": [
519 "",
520 "",
521 "",
522 "",
523 "",
524 "",
525 "",
526 ""
527 ],
528 "location": "query",
529 "required": true,
530 "type": "string"
531 },
532 "platform": {
533 "description": "The user agent type (platform) that made the request, for example 'web'",
534 "enum": [
535 "mobile",
536 "smartphoneOnly",
537 "web"
538 ],
539 "enumDescriptions": [
540 "",
541 "",
542 ""
543 ],
544 "location": "query",
545 "required": true,
546 "type": "string"
547 },
548 "siteUrl": {
549 "description": "The site's URL, including protocol, for example 'http://www.example.com/'",
550 "location": "path",
551 "required": true,
552 "type": "string"
553 },
554 "url": {
555 "description": "The relative path (without the site) of the sample URL; must be one of the URLs returned by list",
556 "location": "path",
557 "required": true,
558 "type": "string"
559 }
560 },
561 "path": "sites/{siteUrl}/urlCrawlErrorsSamples/{url}",
562 "scopes": [
563 "https://www.googleapis.com/auth/webmasters"
564 ]
565 }
566 }
567 }
568 },
569 "revision": "20140908",
570 "rootUrl": "https://www.googleapis.com/",
571 "schemas": {
572 "SitemapsListResponse": {
573 "description": "List of sitemaps.",
574 "id": "SitemapsListResponse",
575 "properties": {
576 "sitemap": {
577 "description": "Information about a sitemap entry.",
578 "items": {
579 "$ref": "WmxSitemap"
580 },
581 "type": "array"
582 }
583 },
584 "type": "object"
585 },
586 "SitesListResponse": {
587 "description": "List of sites with access level information.",
588 "id": "SitesListResponse",
589 "properties": {
590 "siteEntry": {
591 "description": "Access level information for a Webmaster Too ls site.",
592 "items": {
593 "$ref": "WmxSite"
594 },
595 "type": "array"
596 }
597 },
598 "type": "object"
599 },
600 "UrlCrawlErrorCount": {
601 "description": "An entry in a URL crawl errors time series.",
602 "id": "UrlCrawlErrorCount",
603 "properties": {
604 "count": {
605 "description": "The error count at the given timestamp.",
606 "format": "int64",
607 "type": "string"
608 },
609 "timestamp": {
610 "description": "The time (well, date) when errors were detec ted, in RFC 3339 format.",
611 "format": "date-time",
612 "type": "string"
613 }
614 },
615 "type": "object"
616 },
617 "UrlCrawlErrorCountsPerType": {
618 "description": "Number of errors per day for a specific error type ( defined by platform and category).",
619 "id": "UrlCrawlErrorCountsPerType",
620 "properties": {
621 "category": {
622 "description": "The crawl error type.",
623 "type": "string"
624 },
625 "entries": {
626 "description": "The error count entries time series.",
627 "items": {
628 "$ref": "UrlCrawlErrorCount"
629 },
630 "type": "array"
631 },
632 "platform": {
633 "description": "Corresponding to the user agent that made th e request.",
634 "type": "string"
635 }
636 },
637 "type": "object"
638 },
639 "UrlCrawlErrorsCountsQueryResponse": {
640 "description": "A time series of the number of URL crawl errors per error category and platform.",
641 "id": "UrlCrawlErrorsCountsQueryResponse",
642 "properties": {
643 "countPerTypes": {
644 "description": "The time series of the number of URL crawl e rrors for per error category and platform.",
645 "items": {
646 "$ref": "UrlCrawlErrorCountsPerType"
647 },
648 "type": "array"
649 }
650 },
651 "type": "object"
652 },
653 "UrlCrawlErrorsSample": {
654 "id": "UrlCrawlErrorsSample",
655 "properties": {
656 "first_detected": {
657 "description": "The time the error was first detected, in RF C 3339 format.",
658 "format": "date-time",
659 "type": "string"
660 },
661 "last_crawled": {
662 "description": "The time when the URL was last crawled, in R FC 3339 format.",
663 "format": "date-time",
664 "type": "string"
665 },
666 "pageUrl": {
667 "description": "The URL of an error, relative to the site.",
668 "type": "string"
669 },
670 "responseCode": {
671 "description": "The HTTP response code, if any.",
672 "format": "int32",
673 "type": "integer"
674 },
675 "urlDetails": {
676 "$ref": "UrlSampleDetails",
677 "description": "Additional details about the URL, set only w hen calling get()."
678 }
679 },
680 "type": "object"
681 },
682 "UrlCrawlErrorsSamplesListResponse": {
683 "description": "List of crawl error samples.",
684 "id": "UrlCrawlErrorsSamplesListResponse",
685 "properties": {
686 "urlCrawlErrorSample": {
687 "description": "Information about the sample URL and its cra wl error.",
688 "items": {
689 "$ref": "UrlCrawlErrorsSample"
690 },
691 "type": "array"
692 }
693 },
694 "type": "object"
695 },
696 "UrlSampleDetails": {
697 "description": "Additional details about the URL, set only when call ing get().",
698 "id": "UrlSampleDetails",
699 "properties": {
700 "containingSitemaps": {
701 "description": "List of sitemaps pointing at this URL.",
702 "items": {
703 "type": "string"
704 },
705 "type": "array"
706 },
707 "linkedFromUrls": {
708 "description": "A sample set of URLs linking to this URL.",
709 "items": {
710 "type": "string"
711 },
712 "type": "array"
713 }
714 },
715 "type": "object"
716 },
717 "WmxSite": {
718 "description": "Access level information for a Webmaster Tools site. ",
719 "id": "WmxSite",
720 "properties": {
721 "permissionLevel": {
722 "description": "The user's permission level for the site.",
723 "type": "string"
724 },
725 "siteUrl": {
726 "description": "The URL of the site.",
727 "type": "string"
728 }
729 },
730 "type": "object"
731 },
732 "WmxSitemap": {
733 "id": "WmxSitemap",
734 "properties": {
735 "contents": {
736 "description": "The various content types in the sitemap.",
737 "items": {
738 "$ref": "WmxSitemapContent"
739 },
740 "type": "array"
741 },
742 "errors": {
743 "description": "Number of errors in the sitemap - issues wit h the sitemap itself, that needs to be fixed before it can be processed correctl y.",
744 "format": "int64",
745 "type": "string"
746 },
747 "isPending": {
748 "description": "If true, the sitemap has not been processed. ",
749 "type": "boolean"
750 },
751 "isSitemapsIndex": {
752 "description": "If true, the sitemap is a collection of site maps.",
753 "type": "boolean"
754 },
755 "lastDownloaded": {
756 "description": "Date & time in which this sitemap was last d ownloaded. Date format is in RFC 3339 format (yyyy-mm-dd).",
757 "format": "date-time",
758 "type": "string"
759 },
760 "lastSubmitted": {
761 "description": "Date & time in which this sitemap was submit ted. Date format is in RFC 3339 format (yyyy-mm-dd).",
762 "format": "date-time",
763 "type": "string"
764 },
765 "path": {
766 "description": "The url of the sitemap.",
767 "type": "string"
768 },
769 "type": {
770 "description": "The type of the sitemap (for example \"sitem ap\").",
771 "type": "string"
772 },
773 "warnings": {
774 "description": "Number of warnings for the sitemap - issues with URLs in the sitemaps.",
775 "format": "int64",
776 "type": "string"
777 }
778 },
779 "type": "object"
780 },
781 "WmxSitemapContent": {
782 "description": "Information about the various content types in the s itemap.",
783 "id": "WmxSitemapContent",
784 "properties": {
785 "indexed": {
786 "description": "The number of URLs from the sitemap that wer e indexed (of the content type).",
787 "format": "int64",
788 "type": "string"
789 },
790 "submitted": {
791 "description": "The number of URLs in the sitemap (of the co ntent type).",
792 "format": "int64",
793 "type": "string"
794 },
795 "type": {
796 "description": "The specific type of content in this sitemap (for example \"web\", \"images\").",
797 "type": "string"
798 }
799 },
800 "type": "object"
801 }
802 },
803 "servicePath": "webmasters/v3/",
804 "title": "Webmaster Tools API",
805 "version": "v3"
806 }
OLDNEW
« no previous file with comments | « discovery/googleapis/plus__v1.json ('k') | discovery/googleapis/youtube__v3.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698