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

Issues Search
    My Issues | Starred     Open | Closed | All

Side by Side Diff: discovery/googleapis/adsensehost__v4.1.json

Issue 559053002: Generate 0.1.0 version of googleapis/googleapis_beta (Closed) Base URL: git@github.com:dart-lang/googleapis.git@master
Patch Set: Created 6 years, 3 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/adsense__v1.4.json ('k') | discovery/googleapis/analytics__v3.json » ('j') | pubspec.yaml » ('J')
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/adsensehost": {
6 "description": "View and manage your AdSense host data and a ssociated accounts"
7 }
8 }
9 }
10 },
11 "basePath": "/adsensehost/v4.1/",
12 "baseUrl": "https://www.googleapis.com/adsensehost/v4.1/",
13 "batchPath": "batch",
14 "canonicalName": "AdSense Host",
15 "description": "Gives AdSense Hosts access to report generation, ad code gen eration, and publisher management capabilities.",
16 "discoveryVersion": "v1",
17 "documentationLink": "https://developers.google.com/adsense/host/",
18 "etag": "\"uUWyYHXmEn-ab7WLvo8qNz2S8ws/9aNn1Kv5HngMiv4DqtLxcaAgF8g\"",
19 "icons": {
20 "x16": "https://www.google.com/images/icons/product/adsense-16.png",
21 "x32": "https://www.google.com/images/icons/product/adsense-32.png"
22 },
23 "id": "adsensehost:v4.1",
24 "kind": "discovery#restDescription",
25 "labels": [
26 "limited_availability"
27 ],
28 "name": "adsensehost",
29 "ownerDomain": "google.com",
30 "ownerName": "Google",
31 "parameters": {
32 "alt": {
33 "default": "json",
34 "description": "Data format for the response.",
35 "enum": [
36 "csv",
37 "json"
38 ],
39 "enumDescriptions": [
40 "Responses with Content-Type of text/csv",
41 "Responses with Content-Type of application/json"
42 ],
43 "location": "query",
44 "type": "string"
45 },
46 "fields": {
47 "description": "Selector specifying which fields to include in a par tial response.",
48 "location": "query",
49 "type": "string"
50 },
51 "key": {
52 "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.",
53 "location": "query",
54 "type": "string"
55 },
56 "oauth_token": {
57 "description": "OAuth 2.0 token for the current user.",
58 "location": "query",
59 "type": "string"
60 },
61 "prettyPrint": {
62 "default": "true",
63 "description": "Returns response with indentations and line breaks." ,
64 "location": "query",
65 "type": "boolean"
66 },
67 "quotaUser": {
68 "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.",
69 "location": "query",
70 "type": "string"
71 },
72 "userIp": {
73 "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
74 "location": "query",
75 "type": "string"
76 }
77 },
78 "protocol": "rest",
79 "resources": {
80 "accounts": {
81 "methods": {
82 "get": {
83 "description": "Get information about the selected associate d AdSense account.",
84 "httpMethod": "GET",
85 "id": "adsensehost.accounts.get",
86 "parameterOrder": [
87 "accountId"
88 ],
89 "parameters": {
90 "accountId": {
91 "description": "Account to get information about.",
92 "location": "path",
93 "required": true,
94 "type": "string"
95 }
96 },
97 "path": "accounts/{accountId}",
98 "response": {
99 "$ref": "Account"
100 },
101 "scopes": [
102 "https://www.googleapis.com/auth/adsensehost"
103 ]
104 },
105 "list": {
106 "description": "List hosted accounts associated with this Ad Sense account by ad client id.",
107 "httpMethod": "GET",
108 "id": "adsensehost.accounts.list",
109 "parameterOrder": [
110 "filterAdClientId"
111 ],
112 "parameters": {
113 "filterAdClientId": {
114 "description": "Ad clients to list accounts for.",
115 "location": "query",
116 "repeated": true,
117 "required": true,
118 "type": "string"
119 }
120 },
121 "path": "accounts",
122 "response": {
123 "$ref": "Accounts"
124 },
125 "scopes": [
126 "https://www.googleapis.com/auth/adsensehost"
127 ]
128 }
129 },
130 "resources": {
131 "adclients": {
132 "methods": {
133 "get": {
134 "description": "Get information about one of the ad clients in the specified publisher's AdSense account.",
135 "httpMethod": "GET",
136 "id": "adsensehost.accounts.adclients.get",
137 "parameterOrder": [
138 "accountId",
139 "adClientId"
140 ],
141 "parameters": {
142 "accountId": {
143 "description": "Account which contains the a d client.",
144 "location": "path",
145 "required": true,
146 "type": "string"
147 },
148 "adClientId": {
149 "description": "Ad client to get.",
150 "location": "path",
151 "required": true,
152 "type": "string"
153 }
154 },
155 "path": "accounts/{accountId}/adclients/{adClientId} ",
156 "response": {
157 "$ref": "AdClient"
158 },
159 "scopes": [
160 "https://www.googleapis.com/auth/adsensehost"
161 ]
162 },
163 "list": {
164 "description": "List all hosted ad clients in the sp ecified hosted account.",
165 "httpMethod": "GET",
166 "id": "adsensehost.accounts.adclients.list",
167 "parameterOrder": [
168 "accountId"
169 ],
170 "parameters": {
171 "accountId": {
172 "description": "Account for which to list ad clients.",
173 "location": "path",
174 "required": true,
175 "type": "string"
176 },
177 "maxResults": {
178 "description": "The maximum number of ad cli ents to include in the response, used for paging.",
179 "format": "uint32",
180 "location": "query",
181 "maximum": "10000",
182 "minimum": "0",
183 "type": "integer"
184 },
185 "pageToken": {
186 "description": "A continuation token, used t o page through ad clients. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
187 "location": "query",
188 "type": "string"
189 }
190 },
191 "path": "accounts/{accountId}/adclients",
192 "response": {
193 "$ref": "AdClients"
194 },
195 "scopes": [
196 "https://www.googleapis.com/auth/adsensehost"
197 ]
198 }
199 }
200 },
201 "adunits": {
202 "methods": {
203 "delete": {
204 "description": "Delete the specified ad unit from th e specified publisher AdSense account.",
205 "httpMethod": "DELETE",
206 "id": "adsensehost.accounts.adunits.delete",
207 "parameterOrder": [
208 "accountId",
209 "adClientId",
210 "adUnitId"
211 ],
212 "parameters": {
213 "accountId": {
214 "description": "Account which contains the a d unit.",
215 "location": "path",
216 "required": true,
217 "type": "string"
218 },
219 "adClientId": {
220 "description": "Ad client for which to get a d unit.",
221 "location": "path",
222 "required": true,
223 "type": "string"
224 },
225 "adUnitId": {
226 "description": "Ad unit to delete.",
227 "location": "path",
228 "required": true,
229 "type": "string"
230 }
231 },
232 "path": "accounts/{accountId}/adclients/{adClientId} /adunits/{adUnitId}",
233 "response": {
234 "$ref": "AdUnit"
235 },
236 "scopes": [
237 "https://www.googleapis.com/auth/adsensehost"
238 ]
239 },
240 "get": {
241 "description": "Get the specified host ad unit in th is AdSense account.",
242 "httpMethod": "GET",
243 "id": "adsensehost.accounts.adunits.get",
244 "parameterOrder": [
245 "accountId",
246 "adClientId",
247 "adUnitId"
248 ],
249 "parameters": {
250 "accountId": {
251 "description": "Account which contains the a d unit.",
252 "location": "path",
253 "required": true,
254 "type": "string"
255 },
256 "adClientId": {
257 "description": "Ad client for which to get a d unit.",
258 "location": "path",
259 "required": true,
260 "type": "string"
261 },
262 "adUnitId": {
263 "description": "Ad unit to get.",
264 "location": "path",
265 "required": true,
266 "type": "string"
267 }
268 },
269 "path": "accounts/{accountId}/adclients/{adClientId} /adunits/{adUnitId}",
270 "response": {
271 "$ref": "AdUnit"
272 },
273 "scopes": [
274 "https://www.googleapis.com/auth/adsensehost"
275 ]
276 },
277 "getAdCode": {
278 "description": "Get ad code for the specified ad uni t, attaching the specified host custom channels.",
279 "httpMethod": "GET",
280 "id": "adsensehost.accounts.adunits.getAdCode",
281 "parameterOrder": [
282 "accountId",
283 "adClientId",
284 "adUnitId"
285 ],
286 "parameters": {
287 "accountId": {
288 "description": "Account which contains the a d client.",
289 "location": "path",
290 "required": true,
291 "type": "string"
292 },
293 "adClientId": {
294 "description": "Ad client with contains the ad unit.",
295 "location": "path",
296 "required": true,
297 "type": "string"
298 },
299 "adUnitId": {
300 "description": "Ad unit to get the code for. ",
301 "location": "path",
302 "required": true,
303 "type": "string"
304 },
305 "hostCustomChannelId": {
306 "description": "Host custom channel to attac h to the ad code.",
307 "location": "query",
308 "repeated": true,
309 "type": "string"
310 }
311 },
312 "path": "accounts/{accountId}/adclients/{adClientId} /adunits/{adUnitId}/adcode",
313 "response": {
314 "$ref": "AdCode"
315 },
316 "scopes": [
317 "https://www.googleapis.com/auth/adsensehost"
318 ]
319 },
320 "insert": {
321 "description": "Insert the supplied ad unit into the specified publisher AdSense account.",
322 "httpMethod": "POST",
323 "id": "adsensehost.accounts.adunits.insert",
324 "parameterOrder": [
325 "accountId",
326 "adClientId"
327 ],
328 "parameters": {
329 "accountId": {
330 "description": "Account which will contain t he ad unit.",
331 "location": "path",
332 "required": true,
333 "type": "string"
334 },
335 "adClientId": {
336 "description": "Ad client into which to inse rt the ad unit.",
337 "location": "path",
338 "required": true,
339 "type": "string"
340 }
341 },
342 "path": "accounts/{accountId}/adclients/{adClientId} /adunits",
343 "request": {
344 "$ref": "AdUnit"
345 },
346 "response": {
347 "$ref": "AdUnit"
348 },
349 "scopes": [
350 "https://www.googleapis.com/auth/adsensehost"
351 ]
352 },
353 "list": {
354 "description": "List all ad units in the specified p ublisher's AdSense account.",
355 "httpMethod": "GET",
356 "id": "adsensehost.accounts.adunits.list",
357 "parameterOrder": [
358 "accountId",
359 "adClientId"
360 ],
361 "parameters": {
362 "accountId": {
363 "description": "Account which contains the a d client.",
364 "location": "path",
365 "required": true,
366 "type": "string"
367 },
368 "adClientId": {
369 "description": "Ad client for which to list ad units.",
370 "location": "path",
371 "required": true,
372 "type": "string"
373 },
374 "includeInactive": {
375 "description": "Whether to include inactive ad units. Default: true.",
376 "location": "query",
377 "type": "boolean"
378 },
379 "maxResults": {
380 "description": "The maximum number of ad uni ts to include in the response, used for paging.",
381 "format": "uint32",
382 "location": "query",
383 "maximum": "10000",
384 "minimum": "0",
385 "type": "integer"
386 },
387 "pageToken": {
388 "description": "A continuation token, used t o page through ad units. To retrieve the next page, set this parameter to the va lue of \"nextPageToken\" from the previous response.",
389 "location": "query",
390 "type": "string"
391 }
392 },
393 "path": "accounts/{accountId}/adclients/{adClientId} /adunits",
394 "response": {
395 "$ref": "AdUnits"
396 },
397 "scopes": [
398 "https://www.googleapis.com/auth/adsensehost"
399 ]
400 },
401 "patch": {
402 "description": "Update the supplied ad unit in the s pecified publisher AdSense account. This method supports patch semantics.",
403 "httpMethod": "PATCH",
404 "id": "adsensehost.accounts.adunits.patch",
405 "parameterOrder": [
406 "accountId",
407 "adClientId",
408 "adUnitId"
409 ],
410 "parameters": {
411 "accountId": {
412 "description": "Account which contains the a d client.",
413 "location": "path",
414 "required": true,
415 "type": "string"
416 },
417 "adClientId": {
418 "description": "Ad client which contains the ad unit.",
419 "location": "path",
420 "required": true,
421 "type": "string"
422 },
423 "adUnitId": {
424 "description": "Ad unit to get.",
425 "location": "query",
426 "required": true,
427 "type": "string"
428 }
429 },
430 "path": "accounts/{accountId}/adclients/{adClientId} /adunits",
431 "request": {
432 "$ref": "AdUnit"
433 },
434 "response": {
435 "$ref": "AdUnit"
436 },
437 "scopes": [
438 "https://www.googleapis.com/auth/adsensehost"
439 ]
440 },
441 "update": {
442 "description": "Update the supplied ad unit in the s pecified publisher AdSense account.",
443 "httpMethod": "PUT",
444 "id": "adsensehost.accounts.adunits.update",
445 "parameterOrder": [
446 "accountId",
447 "adClientId"
448 ],
449 "parameters": {
450 "accountId": {
451 "description": "Account which contains the a d client.",
452 "location": "path",
453 "required": true,
454 "type": "string"
455 },
456 "adClientId": {
457 "description": "Ad client which contains the ad unit.",
458 "location": "path",
459 "required": true,
460 "type": "string"
461 }
462 },
463 "path": "accounts/{accountId}/adclients/{adClientId} /adunits",
464 "request": {
465 "$ref": "AdUnit"
466 },
467 "response": {
468 "$ref": "AdUnit"
469 },
470 "scopes": [
471 "https://www.googleapis.com/auth/adsensehost"
472 ]
473 }
474 }
475 },
476 "reports": {
477 "methods": {
478 "generate": {
479 "description": "Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify \"alt=csv\" as a query parameter.",
480 "httpMethod": "GET",
481 "id": "adsensehost.accounts.reports.generate",
482 "parameterOrder": [
483 "accountId",
484 "startDate",
485 "endDate"
486 ],
487 "parameters": {
488 "accountId": {
489 "description": "Hosted account upon which to report.",
490 "location": "path",
491 "required": true,
492 "type": "string"
493 },
494 "dimension": {
495 "description": "Dimensions to base the repor t on.",
496 "location": "query",
497 "pattern": "[a-zA-Z_]+",
498 "repeated": true,
499 "type": "string"
500 },
501 "endDate": {
502 "description": "End of the date range to rep ort on in \"YYYY-MM-DD\" format, inclusive.",
503 "location": "query",
504 "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|star tOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
505 "required": true,
506 "type": "string"
507 },
508 "filter": {
509 "description": "Filters to be run on the rep ort.",
510 "location": "query",
511 "pattern": "[a-zA-Z_]+(==|=@).+",
512 "repeated": true,
513 "type": "string"
514 },
515 "locale": {
516 "description": "Optional locale to use for t ranslating report output to a local language. Defaults to \"en_US\" if not speci fied.",
517 "location": "query",
518 "pattern": "[a-zA-Z_]+",
519 "type": "string"
520 },
521 "maxResults": {
522 "description": "The maximum number of rows o f report data to return.",
523 "format": "uint32",
524 "location": "query",
525 "maximum": "50000",
526 "minimum": "0",
527 "type": "integer"
528 },
529 "metric": {
530 "description": "Numeric columns to include i n the report.",
531 "location": "query",
532 "pattern": "[a-zA-Z_]+",
533 "repeated": true,
534 "type": "string"
535 },
536 "sort": {
537 "description": "The name of a dimension or m etric to sort the resulting report on, optionally prefixed with \"+\" to sort as cending or \"-\" to sort descending. If no prefix is specified, the column is so rted ascending.",
538 "location": "query",
539 "pattern": "(\\+|-)?[a-zA-Z_]+",
540 "repeated": true,
541 "type": "string"
542 },
543 "startDate": {
544 "description": "Start of the date range to r eport on in \"YYYY-MM-DD\" format, inclusive.",
545 "location": "query",
546 "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|star tOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
547 "required": true,
548 "type": "string"
549 },
550 "startIndex": {
551 "description": "Index of the first row of re port data to return.",
552 "format": "uint32",
553 "location": "query",
554 "maximum": "5000",
555 "minimum": "0",
556 "type": "integer"
557 }
558 },
559 "path": "accounts/{accountId}/reports",
560 "response": {
561 "$ref": "Report"
562 },
563 "scopes": [
564 "https://www.googleapis.com/auth/adsensehost"
565 ]
566 }
567 }
568 }
569 }
570 },
571 "adclients": {
572 "methods": {
573 "get": {
574 "description": "Get information about one of the ad clients in the Host AdSense account.",
575 "httpMethod": "GET",
576 "id": "adsensehost.adclients.get",
577 "parameterOrder": [
578 "adClientId"
579 ],
580 "parameters": {
581 "adClientId": {
582 "description": "Ad client to get.",
583 "location": "path",
584 "required": true,
585 "type": "string"
586 }
587 },
588 "path": "adclients/{adClientId}",
589 "response": {
590 "$ref": "AdClient"
591 },
592 "scopes": [
593 "https://www.googleapis.com/auth/adsensehost"
594 ]
595 },
596 "list": {
597 "description": "List all host ad clients in this AdSense acc ount.",
598 "httpMethod": "GET",
599 "id": "adsensehost.adclients.list",
600 "parameters": {
601 "maxResults": {
602 "description": "The maximum number of ad clients to include in the response, used for paging.",
603 "format": "uint32",
604 "location": "query",
605 "maximum": "10000",
606 "minimum": "0",
607 "type": "integer"
608 },
609 "pageToken": {
610 "description": "A continuation token, used to page t hrough ad clients. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
611 "location": "query",
612 "type": "string"
613 }
614 },
615 "path": "adclients",
616 "response": {
617 "$ref": "AdClients"
618 },
619 "scopes": [
620 "https://www.googleapis.com/auth/adsensehost"
621 ]
622 }
623 }
624 },
625 "associationsessions": {
626 "methods": {
627 "start": {
628 "description": "Create an association session for initiating an association with an AdSense user.",
629 "httpMethod": "GET",
630 "id": "adsensehost.associationsessions.start",
631 "parameterOrder": [
632 "productCode",
633 "websiteUrl"
634 ],
635 "parameters": {
636 "productCode": {
637 "description": "Products to associate with the user. ",
638 "enum": [
639 "AFC",
640 "AFG",
641 "AFMC",
642 "AFS",
643 "AFV"
644 ],
645 "enumDescriptions": [
646 "AdSense For Content",
647 "AdSense For Games",
648 "AdSense For Mobile Content",
649 "AdSense For Search",
650 "AdSense For Video"
651 ],
652 "location": "query",
653 "repeated": true,
654 "required": true,
655 "type": "string"
656 },
657 "userLocale": {
658 "description": "The preferred locale of the user.",
659 "location": "query",
660 "type": "string"
661 },
662 "websiteLocale": {
663 "description": "The locale of the user's hosted webs ite.",
664 "location": "query",
665 "type": "string"
666 },
667 "websiteUrl": {
668 "description": "The URL of the user's hosted website .",
669 "location": "query",
670 "required": true,
671 "type": "string"
672 }
673 },
674 "path": "associationsessions/start",
675 "response": {
676 "$ref": "AssociationSession"
677 },
678 "scopes": [
679 "https://www.googleapis.com/auth/adsensehost"
680 ]
681 },
682 "verify": {
683 "description": "Verify an association session after the asso ciation callback returns from AdSense signup.",
684 "httpMethod": "GET",
685 "id": "adsensehost.associationsessions.verify",
686 "parameterOrder": [
687 "token"
688 ],
689 "parameters": {
690 "token": {
691 "description": "The token returned to the associatio n callback URL.",
692 "location": "query",
693 "required": true,
694 "type": "string"
695 }
696 },
697 "path": "associationsessions/verify",
698 "response": {
699 "$ref": "AssociationSession"
700 },
701 "scopes": [
702 "https://www.googleapis.com/auth/adsensehost"
703 ]
704 }
705 }
706 },
707 "customchannels": {
708 "methods": {
709 "delete": {
710 "description": "Delete a specific custom channel from the ho st AdSense account.",
711 "httpMethod": "DELETE",
712 "id": "adsensehost.customchannels.delete",
713 "parameterOrder": [
714 "adClientId",
715 "customChannelId"
716 ],
717 "parameters": {
718 "adClientId": {
719 "description": "Ad client from which to delete the c ustom channel.",
720 "location": "path",
721 "required": true,
722 "type": "string"
723 },
724 "customChannelId": {
725 "description": "Custom channel to delete.",
726 "location": "path",
727 "required": true,
728 "type": "string"
729 }
730 },
731 "path": "adclients/{adClientId}/customchannels/{customChanne lId}",
732 "response": {
733 "$ref": "CustomChannel"
734 },
735 "scopes": [
736 "https://www.googleapis.com/auth/adsensehost"
737 ]
738 },
739 "get": {
740 "description": "Get a specific custom channel from the host AdSense account.",
741 "httpMethod": "GET",
742 "id": "adsensehost.customchannels.get",
743 "parameterOrder": [
744 "adClientId",
745 "customChannelId"
746 ],
747 "parameters": {
748 "adClientId": {
749 "description": "Ad client from which to get the cust om channel.",
750 "location": "path",
751 "required": true,
752 "type": "string"
753 },
754 "customChannelId": {
755 "description": "Custom channel to get.",
756 "location": "path",
757 "required": true,
758 "type": "string"
759 }
760 },
761 "path": "adclients/{adClientId}/customchannels/{customChanne lId}",
762 "response": {
763 "$ref": "CustomChannel"
764 },
765 "scopes": [
766 "https://www.googleapis.com/auth/adsensehost"
767 ]
768 },
769 "insert": {
770 "description": "Add a new custom channel to the host AdSense account.",
771 "httpMethod": "POST",
772 "id": "adsensehost.customchannels.insert",
773 "parameterOrder": [
774 "adClientId"
775 ],
776 "parameters": {
777 "adClientId": {
778 "description": "Ad client to which the new custom ch annel will be added.",
779 "location": "path",
780 "required": true,
781 "type": "string"
782 }
783 },
784 "path": "adclients/{adClientId}/customchannels",
785 "request": {
786 "$ref": "CustomChannel"
787 },
788 "response": {
789 "$ref": "CustomChannel"
790 },
791 "scopes": [
792 "https://www.googleapis.com/auth/adsensehost"
793 ]
794 },
795 "list": {
796 "description": "List all host custom channels in this AdSens e account.",
797 "httpMethod": "GET",
798 "id": "adsensehost.customchannels.list",
799 "parameterOrder": [
800 "adClientId"
801 ],
802 "parameters": {
803 "adClientId": {
804 "description": "Ad client for which to list custom c hannels.",
805 "location": "path",
806 "required": true,
807 "type": "string"
808 },
809 "maxResults": {
810 "description": "The maximum number of custom channel s to include in the response, used for paging.",
811 "format": "uint32",
812 "location": "query",
813 "maximum": "10000",
814 "minimum": "0",
815 "type": "integer"
816 },
817 "pageToken": {
818 "description": "A continuation token, used to page t hrough custom channels. To retrieve the next page, set this parameter to the val ue of \"nextPageToken\" from the previous response.",
819 "location": "query",
820 "type": "string"
821 }
822 },
823 "path": "adclients/{adClientId}/customchannels",
824 "response": {
825 "$ref": "CustomChannels"
826 },
827 "scopes": [
828 "https://www.googleapis.com/auth/adsensehost"
829 ]
830 },
831 "patch": {
832 "description": "Update a custom channel in the host AdSense account. This method supports patch semantics.",
833 "httpMethod": "PATCH",
834 "id": "adsensehost.customchannels.patch",
835 "parameterOrder": [
836 "adClientId",
837 "customChannelId"
838 ],
839 "parameters": {
840 "adClientId": {
841 "description": "Ad client in which the custom channe l will be updated.",
842 "location": "path",
843 "required": true,
844 "type": "string"
845 },
846 "customChannelId": {
847 "description": "Custom channel to get.",
848 "location": "query",
849 "required": true,
850 "type": "string"
851 }
852 },
853 "path": "adclients/{adClientId}/customchannels",
854 "request": {
855 "$ref": "CustomChannel"
856 },
857 "response": {
858 "$ref": "CustomChannel"
859 },
860 "scopes": [
861 "https://www.googleapis.com/auth/adsensehost"
862 ]
863 },
864 "update": {
865 "description": "Update a custom channel in the host AdSense account.",
866 "httpMethod": "PUT",
867 "id": "adsensehost.customchannels.update",
868 "parameterOrder": [
869 "adClientId"
870 ],
871 "parameters": {
872 "adClientId": {
873 "description": "Ad client in which the custom channe l will be updated.",
874 "location": "path",
875 "required": true,
876 "type": "string"
877 }
878 },
879 "path": "adclients/{adClientId}/customchannels",
880 "request": {
881 "$ref": "CustomChannel"
882 },
883 "response": {
884 "$ref": "CustomChannel"
885 },
886 "scopes": [
887 "https://www.googleapis.com/auth/adsensehost"
888 ]
889 }
890 }
891 },
892 "reports": {
893 "methods": {
894 "generate": {
895 "description": "Generate an AdSense report based on the repo rt request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify \"alt=csv\" as a query parameter.",
896 "httpMethod": "GET",
897 "id": "adsensehost.reports.generate",
898 "parameterOrder": [
899 "startDate",
900 "endDate"
901 ],
902 "parameters": {
903 "dimension": {
904 "description": "Dimensions to base the report on.",
905 "location": "query",
906 "pattern": "[a-zA-Z_]+",
907 "repeated": true,
908 "type": "string"
909 },
910 "endDate": {
911 "description": "End of the date range to report on i n \"YYYY-MM-DD\" format, inclusive.",
912 "location": "query",
913 "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth |startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
914 "required": true,
915 "type": "string"
916 },
917 "filter": {
918 "description": "Filters to be run on the report.",
919 "location": "query",
920 "pattern": "[a-zA-Z_]+(==|=@).+",
921 "repeated": true,
922 "type": "string"
923 },
924 "locale": {
925 "description": "Optional locale to use for translati ng report output to a local language. Defaults to \"en_US\" if not specified.",
926 "location": "query",
927 "pattern": "[a-zA-Z_]+",
928 "type": "string"
929 },
930 "maxResults": {
931 "description": "The maximum number of rows of report data to return.",
932 "format": "uint32",
933 "location": "query",
934 "maximum": "50000",
935 "minimum": "0",
936 "type": "integer"
937 },
938 "metric": {
939 "description": "Numeric columns to include in the re port.",
940 "location": "query",
941 "pattern": "[a-zA-Z_]+",
942 "repeated": true,
943 "type": "string"
944 },
945 "sort": {
946 "description": "The name of a dimension or metric to sort the resulting report on, optionally prefixed with \"+\" to sort ascending or \"-\" to sort descending. If no prefix is specified, the column is sorted asc ending.",
947 "location": "query",
948 "pattern": "(\\+|-)?[a-zA-Z_]+",
949 "repeated": true,
950 "type": "string"
951 },
952 "startDate": {
953 "description": "Start of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
954 "location": "query",
955 "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth |startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
956 "required": true,
957 "type": "string"
958 },
959 "startIndex": {
960 "description": "Index of the first row of report dat a to return.",
961 "format": "uint32",
962 "location": "query",
963 "maximum": "5000",
964 "minimum": "0",
965 "type": "integer"
966 }
967 },
968 "path": "reports",
969 "response": {
970 "$ref": "Report"
971 },
972 "scopes": [
973 "https://www.googleapis.com/auth/adsensehost"
974 ]
975 }
976 }
977 },
978 "urlchannels": {
979 "methods": {
980 "delete": {
981 "description": "Delete a URL channel from the host AdSense a ccount.",
982 "httpMethod": "DELETE",
983 "id": "adsensehost.urlchannels.delete",
984 "parameterOrder": [
985 "adClientId",
986 "urlChannelId"
987 ],
988 "parameters": {
989 "adClientId": {
990 "description": "Ad client from which to delete the U RL channel.",
991 "location": "path",
992 "required": true,
993 "type": "string"
994 },
995 "urlChannelId": {
996 "description": "URL channel to delete.",
997 "location": "path",
998 "required": true,
999 "type": "string"
1000 }
1001 },
1002 "path": "adclients/{adClientId}/urlchannels/{urlChannelId}",
1003 "response": {
1004 "$ref": "UrlChannel"
1005 },
1006 "scopes": [
1007 "https://www.googleapis.com/auth/adsensehost"
1008 ]
1009 },
1010 "insert": {
1011 "description": "Add a new URL channel to the host AdSense ac count.",
1012 "httpMethod": "POST",
1013 "id": "adsensehost.urlchannels.insert",
1014 "parameterOrder": [
1015 "adClientId"
1016 ],
1017 "parameters": {
1018 "adClientId": {
1019 "description": "Ad client to which the new URL chann el will be added.",
1020 "location": "path",
1021 "required": true,
1022 "type": "string"
1023 }
1024 },
1025 "path": "adclients/{adClientId}/urlchannels",
1026 "request": {
1027 "$ref": "UrlChannel"
1028 },
1029 "response": {
1030 "$ref": "UrlChannel"
1031 },
1032 "scopes": [
1033 "https://www.googleapis.com/auth/adsensehost"
1034 ]
1035 },
1036 "list": {
1037 "description": "List all host URL channels in the host AdSen se account.",
1038 "httpMethod": "GET",
1039 "id": "adsensehost.urlchannels.list",
1040 "parameterOrder": [
1041 "adClientId"
1042 ],
1043 "parameters": {
1044 "adClientId": {
1045 "description": "Ad client for which to list URL chan nels.",
1046 "location": "path",
1047 "required": true,
1048 "type": "string"
1049 },
1050 "maxResults": {
1051 "description": "The maximum number of URL channels t o include in the response, used for paging.",
1052 "format": "uint32",
1053 "location": "query",
1054 "maximum": "10000",
1055 "minimum": "0",
1056 "type": "integer"
1057 },
1058 "pageToken": {
1059 "description": "A continuation token, used to page t hrough URL channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
1060 "location": "query",
1061 "type": "string"
1062 }
1063 },
1064 "path": "adclients/{adClientId}/urlchannels",
1065 "response": {
1066 "$ref": "UrlChannels"
1067 },
1068 "scopes": [
1069 "https://www.googleapis.com/auth/adsensehost"
1070 ]
1071 }
1072 }
1073 }
1074 },
1075 "revision": "20140908",
1076 "rootUrl": "https://www.googleapis.com/",
1077 "schemas": {
1078 "Account": {
1079 "id": "Account",
1080 "properties": {
1081 "id": {
1082 "description": "Unique identifier of this account.",
1083 "type": "string"
1084 },
1085 "kind": {
1086 "default": "adsensehost#account",
1087 "description": "Kind of resource this is, in this case adsen sehost#account.",
1088 "type": "string"
1089 },
1090 "name": {
1091 "description": "Name of this account.",
1092 "type": "string"
1093 },
1094 "status": {
1095 "description": "Approval status of this account. One of: PEN DING, APPROVED, DISABLED.",
1096 "type": "string"
1097 }
1098 },
1099 "type": "object"
1100 },
1101 "Accounts": {
1102 "id": "Accounts",
1103 "properties": {
1104 "etag": {
1105 "description": "ETag of this response for caching purposes." ,
1106 "type": "string"
1107 },
1108 "items": {
1109 "description": "The accounts returned in this list response. ",
1110 "items": {
1111 "$ref": "Account"
1112 },
1113 "type": "array"
1114 },
1115 "kind": {
1116 "default": "adsensehost#accounts",
1117 "description": "Kind of list this is, in this case adsenseho st#accounts.",
1118 "type": "string"
1119 }
1120 },
1121 "type": "object"
1122 },
1123 "AdClient": {
1124 "id": "AdClient",
1125 "properties": {
1126 "arcOptIn": {
1127 "description": "Whether this ad client is opted in to ARC.",
1128 "type": "boolean"
1129 },
1130 "id": {
1131 "description": "Unique identifier of this ad client.",
1132 "type": "string"
1133 },
1134 "kind": {
1135 "default": "adsensehost#adClient",
1136 "description": "Kind of resource this is, in this case adsen sehost#adClient.",
1137 "type": "string"
1138 },
1139 "productCode": {
1140 "description": "This ad client's product code, which corresp onds to the PRODUCT_CODE report dimension.",
1141 "type": "string"
1142 },
1143 "supportsReporting": {
1144 "description": "Whether this ad client supports being report ed on.",
1145 "type": "boolean"
1146 }
1147 },
1148 "type": "object"
1149 },
1150 "AdClients": {
1151 "id": "AdClients",
1152 "properties": {
1153 "etag": {
1154 "description": "ETag of this response for caching purposes." ,
1155 "type": "string"
1156 },
1157 "items": {
1158 "description": "The ad clients returned in this list respons e.",
1159 "items": {
1160 "$ref": "AdClient"
1161 },
1162 "type": "array"
1163 },
1164 "kind": {
1165 "default": "adsensehost#adClients",
1166 "description": "Kind of list this is, in this case adsenseho st#adClients.",
1167 "type": "string"
1168 },
1169 "nextPageToken": {
1170 "description": "Continuation token used to page through ad c lients. To retrieve the next page of results, set the next request's \"pageToken \" value to this.",
1171 "type": "string"
1172 }
1173 },
1174 "type": "object"
1175 },
1176 "AdCode": {
1177 "id": "AdCode",
1178 "properties": {
1179 "adCode": {
1180 "description": "The ad code snippet.",
1181 "type": "string"
1182 },
1183 "kind": {
1184 "default": "adsensehost#adCode",
1185 "description": "Kind this is, in this case adsensehost#adCod e.",
1186 "type": "string"
1187 }
1188 },
1189 "type": "object"
1190 },
1191 "AdStyle": {
1192 "id": "AdStyle",
1193 "properties": {
1194 "colors": {
1195 "description": "The colors included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but with out the leading hash.",
1196 "properties": {
1197 "background": {
1198 "description": "The color of the ad background.",
1199 "type": "string"
1200 },
1201 "border": {
1202 "description": "The color of the ad border.",
1203 "type": "string"
1204 },
1205 "text": {
1206 "description": "The color of the ad text.",
1207 "type": "string"
1208 },
1209 "title": {
1210 "description": "The color of the ad title.",
1211 "type": "string"
1212 },
1213 "url": {
1214 "description": "The color of the ad url.",
1215 "type": "string"
1216 }
1217 },
1218 "type": "object"
1219 },
1220 "corners": {
1221 "description": "The style of the corners in the ad. Possible values are SQUARE, SLIGHTLY_ROUNDED and VERY_ROUNDED.",
1222 "type": "string"
1223 },
1224 "font": {
1225 "description": "The font which is included in the style.",
1226 "properties": {
1227 "family": {
1228 "description": "The family of the font. Possible val ues are: ACCOUNT_DEFAULT_FAMILY, ADSENSE_DEFAULT_FAMILY, ARIAL, TIMES and VERDAN A.",
1229 "type": "string"
1230 },
1231 "size": {
1232 "description": "The size of the font. Possible value s are: ACCOUNT_DEFAULT_SIZE, ADSENSE_DEFAULT_SIZE, SMALL, MEDIUM and LARGE.",
1233 "type": "string"
1234 }
1235 },
1236 "type": "object"
1237 },
1238 "kind": {
1239 "default": "adsensehost#adStyle",
1240 "description": "Kind this is, in this case adsensehost#adSty le.",
1241 "type": "string"
1242 }
1243 },
1244 "type": "object"
1245 },
1246 "AdUnit": {
1247 "id": "AdUnit",
1248 "properties": {
1249 "code": {
1250 "description": "Identity code of this ad unit, not necessari ly unique across ad clients.",
1251 "type": "string"
1252 },
1253 "contentAdsSettings": {
1254 "description": "Settings specific to content ads (AFC) and h ighend mobile content ads (AFMC).",
1255 "properties": {
1256 "backupOption": {
1257 "description": "The backup option to be used in inst ances where no ad is available.",
1258 "properties": {
1259 "color": {
1260 "description": "Color to use when type is se t to COLOR. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.",
1261 "type": "string"
1262 },
1263 "type": {
1264 "description": "Type of the backup option. P ossible values are BLANK, COLOR and URL.",
1265 "type": "string"
1266 },
1267 "url": {
1268 "description": "URL to use when type is set to URL.",
1269 "type": "string"
1270 }
1271 },
1272 "type": "object"
1273 },
1274 "size": {
1275 "description": "Size of this ad unit. Size values ar e in the form SIZE_{width}_{height}.",
1276 "type": "string"
1277 },
1278 "type": {
1279 "description": "Type of this ad unit. Possible value s are TEXT, TEXT_IMAGE, IMAGE and LINK.",
1280 "type": "string"
1281 }
1282 },
1283 "type": "object"
1284 },
1285 "customStyle": {
1286 "$ref": "AdStyle",
1287 "description": "Custom style information specific to this ad unit."
1288 },
1289 "id": {
1290 "description": "Unique identifier of this ad unit. This shou ld be considered an opaque identifier; it is not safe to rely on it being in any particular format.",
1291 "type": "string"
1292 },
1293 "kind": {
1294 "default": "adsensehost#adUnit",
1295 "description": "Kind of resource this is, in this case adsen sehost#adUnit.",
1296 "type": "string"
1297 },
1298 "mobileContentAdsSettings": {
1299 "description": "Settings specific to WAP mobile content ads (AFMC).",
1300 "properties": {
1301 "markupLanguage": {
1302 "description": "The markup language to use for this ad unit.",
1303 "type": "string"
1304 },
1305 "scriptingLanguage": {
1306 "description": "The scripting language to use for th is ad unit.",
1307 "type": "string"
1308 },
1309 "size": {
1310 "description": "Size of this ad unit.",
1311 "type": "string"
1312 },
1313 "type": {
1314 "description": "Type of this ad unit.",
1315 "type": "string"
1316 }
1317 },
1318 "type": "object"
1319 },
1320 "name": {
1321 "description": "Name of this ad unit.",
1322 "type": "string"
1323 },
1324 "status": {
1325 "description": "Status of this ad unit. Possible values are: \nNEW: Indicates that the ad unit was created within the last seven days and doe s not yet have any activity associated with it.\n\nACTIVE: Indicates that there has been activity on this ad unit in the last seven days.\n\nINACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.",
1326 "type": "string"
1327 }
1328 },
1329 "type": "object"
1330 },
1331 "AdUnits": {
1332 "id": "AdUnits",
1333 "properties": {
1334 "etag": {
1335 "description": "ETag of this response for caching purposes." ,
1336 "type": "string"
1337 },
1338 "items": {
1339 "description": "The ad units returned in this list response. ",
1340 "items": {
1341 "$ref": "AdUnit"
1342 },
1343 "type": "array"
1344 },
1345 "kind": {
1346 "default": "adsensehost#adUnits",
1347 "description": "Kind of list this is, in this case adsenseho st#adUnits.",
1348 "type": "string"
1349 },
1350 "nextPageToken": {
1351 "description": "Continuation token used to page through ad u nits. To retrieve the next page of results, set the next request's \"pageToken\" value to this.",
1352 "type": "string"
1353 }
1354 },
1355 "type": "object"
1356 },
1357 "AssociationSession": {
1358 "id": "AssociationSession",
1359 "properties": {
1360 "accountId": {
1361 "description": "Hosted account id of the associated publishe r after association. Present if status is ACCEPTED.",
1362 "type": "string"
1363 },
1364 "id": {
1365 "description": "Unique identifier of this association sessio n.",
1366 "type": "string"
1367 },
1368 "kind": {
1369 "default": "adsensehost#associationSession",
1370 "description": "Kind of resource this is, in this case adsen sehost#associationSession.",
1371 "type": "string"
1372 },
1373 "productCodes": {
1374 "description": "The products to associate with the user. Opt ions: AFC, AFF, AFS, AFMC",
1375 "items": {
1376 "type": "string"
1377 },
1378 "type": "array"
1379 },
1380 "redirectUrl": {
1381 "description": "Redirect URL of this association session. Us ed to redirect users into the AdSense association flow.",
1382 "type": "string"
1383 },
1384 "status": {
1385 "description": "Status of the completed association, availab le once the association callback token has been verified. One of ACCEPTED, REJEC TED, or ERROR.",
1386 "type": "string"
1387 },
1388 "userLocale": {
1389 "description": "The preferred locale of the user themselves when going through the AdSense association flow.",
1390 "type": "string"
1391 },
1392 "websiteLocale": {
1393 "description": "The locale of the user's hosted website.",
1394 "type": "string"
1395 },
1396 "websiteUrl": {
1397 "description": "The URL of the user's hosted website.",
1398 "type": "string"
1399 }
1400 },
1401 "type": "object"
1402 },
1403 "CustomChannel": {
1404 "id": "CustomChannel",
1405 "properties": {
1406 "code": {
1407 "description": "Code of this custom channel, not necessarily unique across ad clients.",
1408 "type": "string"
1409 },
1410 "id": {
1411 "description": "Unique identifier of this custom channel. Th is should be considered an opaque identifier; it is not safe to rely on it being in any particular format.",
1412 "type": "string"
1413 },
1414 "kind": {
1415 "default": "adsensehost#customChannel",
1416 "description": "Kind of resource this is, in this case adsen sehost#customChannel.",
1417 "type": "string"
1418 },
1419 "name": {
1420 "description": "Name of this custom channel.",
1421 "type": "string"
1422 }
1423 },
1424 "type": "object"
1425 },
1426 "CustomChannels": {
1427 "id": "CustomChannels",
1428 "properties": {
1429 "etag": {
1430 "description": "ETag of this response for caching purposes." ,
1431 "type": "string"
1432 },
1433 "items": {
1434 "description": "The custom channels returned in this list re sponse.",
1435 "items": {
1436 "$ref": "CustomChannel"
1437 },
1438 "type": "array"
1439 },
1440 "kind": {
1441 "default": "adsensehost#customChannels",
1442 "description": "Kind of list this is, in this case adsenseho st#customChannels.",
1443 "type": "string"
1444 },
1445 "nextPageToken": {
1446 "description": "Continuation token used to page through cust om channels. To retrieve the next page of results, set the next request's \"page Token\" value to this.",
1447 "type": "string"
1448 }
1449 },
1450 "type": "object"
1451 },
1452 "Report": {
1453 "id": "Report",
1454 "properties": {
1455 "averages": {
1456 "description": "The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.",
1457 "items": {
1458 "type": "string"
1459 },
1460 "type": "array"
1461 },
1462 "headers": {
1463 "description": "The header information of the columns reques ted in the report. This is a list of headers; one for each dimension in the requ est, followed by one for each metric in the request.",
1464 "items": {
1465 "properties": {
1466 "currency": {
1467 "description": "The currency of this column. Onl y present if the header type is METRIC_CURRENCY.",
1468 "type": "string"
1469 },
1470 "name": {
1471 "description": "The name of the header.",
1472 "type": "string"
1473 },
1474 "type": {
1475 "description": "The type of the header; one of D IMENSION, METRIC_TALLY, METRIC_RATIO, or METRIC_CURRENCY.",
1476 "type": "string"
1477 }
1478 },
1479 "type": "object"
1480 },
1481 "type": "array"
1482 },
1483 "kind": {
1484 "default": "adsensehost#report",
1485 "description": "Kind this is, in this case adsensehost#repor t.",
1486 "type": "string"
1487 },
1488 "rows": {
1489 "description": "The output rows of the report. Each row is a list of cells; one for each dimension in the request, followed by one for each metric in the request. The dimension cells contain strings, and the metric cells contain numbers.",
1490 "items": {
1491 "items": {
1492 "type": "string"
1493 },
1494 "type": "array"
1495 },
1496 "type": "array"
1497 },
1498 "totalMatchedRows": {
1499 "description": "The total number of rows matched by the repo rt request. Fewer rows may be returned in the response due to being limited by t he row count requested or the report row limit.",
1500 "format": "int64",
1501 "type": "string"
1502 },
1503 "totals": {
1504 "description": "The totals of the report. This is the same l ength as any other row in the report; cells corresponding to dimension columns a re empty.",
1505 "items": {
1506 "type": "string"
1507 },
1508 "type": "array"
1509 },
1510 "warnings": {
1511 "description": "Any warnings associated with generation of t he report.",
1512 "items": {
1513 "type": "string"
1514 },
1515 "type": "array"
1516 }
1517 },
1518 "type": "object"
1519 },
1520 "UrlChannel": {
1521 "id": "UrlChannel",
1522 "properties": {
1523 "id": {
1524 "description": "Unique identifier of this URL channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.",
1525 "type": "string"
1526 },
1527 "kind": {
1528 "default": "adsensehost#urlChannel",
1529 "description": "Kind of resource this is, in this case adsen sehost#urlChannel.",
1530 "type": "string"
1531 },
1532 "urlPattern": {
1533 "description": "URL Pattern of this URL channel. Does not in clude \"http://\" or \"https://\". Example: www.example.com/home",
1534 "type": "string"
1535 }
1536 },
1537 "type": "object"
1538 },
1539 "UrlChannels": {
1540 "id": "UrlChannels",
1541 "properties": {
1542 "etag": {
1543 "description": "ETag of this response for caching purposes." ,
1544 "type": "string"
1545 },
1546 "items": {
1547 "description": "The URL channels returned in this list respo nse.",
1548 "items": {
1549 "$ref": "UrlChannel"
1550 },
1551 "type": "array"
1552 },
1553 "kind": {
1554 "default": "adsensehost#urlChannels",
1555 "description": "Kind of list this is, in this case adsenseho st#urlChannels.",
1556 "type": "string"
1557 },
1558 "nextPageToken": {
1559 "description": "Continuation token used to page through URL channels. To retrieve the next page of results, set the next request's \"pageTok en\" value to this.",
1560 "type": "string"
1561 }
1562 },
1563 "type": "object"
1564 }
1565 },
1566 "servicePath": "adsensehost/v4.1/",
1567 "title": "AdSense Host API",
1568 "version": "v4.1"
1569 }
OLDNEW
« no previous file with comments | « discovery/googleapis/adsense__v1.4.json ('k') | discovery/googleapis/analytics__v3.json » ('j') | pubspec.yaml » ('J')

Powered by Google App Engine
This is Rietveld 408576698