/
adsense-api.json
2402 lines (2402 loc) · 116 KB
/
adsense-api.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/adsense": {
"description": "View and manage your AdSense data"
},
"https://www.googleapis.com/auth/adsense.readonly": {
"description": "View your AdSense data"
}
}
}
},
"basePath": "",
"baseUrl": "https://adsense.googleapis.com/",
"batchPath": "batch",
"description": "The AdSense Management API allows publishers to access their inventory and run earnings and performance reports.",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/adsense/management/",
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "adsense:v2",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://adsense.mtls.googleapis.com/",
"name": "adsense",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"accounts": {
"methods": {
"get": {
"description": "Gets information about the selected AdSense account.",
"flatPath": "v2/accounts/{accountsId}",
"httpMethod": "GET",
"id": "adsense.accounts.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Account to get information about. Format: accounts/{account}",
"location": "path",
"pattern": "^accounts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "Account"
},
"scopes": [
"https://www.googleapis.com/auth/adsense",
"https://www.googleapis.com/auth/adsense.readonly"
]
},
"list": {
"description": "Lists all accounts available to this user.",
"flatPath": "v2/accounts",
"httpMethod": "GET",
"id": "adsense.accounts.list",
"parameterOrder": [],
"parameters": {
"pageSize": {
"description": "The maximum number of accounts to include in the response, used for paging. If unspecified, at most 10000 accounts will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must match the call that provided the page token.",
"location": "query",
"type": "string"
}
},
"path": "v2/accounts",
"response": {
"$ref": "ListAccountsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/adsense",
"https://www.googleapis.com/auth/adsense.readonly"
]
},
"listChildAccounts": {
"description": "Lists all accounts directly managed by the given AdSense account.",
"flatPath": "v2/accounts/{accountsId}:listChildAccounts",
"httpMethod": "GET",
"id": "adsense.accounts.listChildAccounts",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "The maximum number of accounts to include in the response, used for paging. If unspecified, at most 10000 accounts will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must match the call that provided the page token.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent account, which owns the child accounts. Format: accounts/{account}",
"location": "path",
"pattern": "^accounts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}:listChildAccounts",
"response": {
"$ref": "ListChildAccountsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/adsense",
"https://www.googleapis.com/auth/adsense.readonly"
]
}
},
"resources": {
"adclients": {
"methods": {
"get": {
"description": "Gets the ad client from the given resource name.",
"flatPath": "v2/accounts/{accountsId}/adclients/{adclientsId}",
"httpMethod": "GET",
"id": "adsense.accounts.adclients.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the ad client to retrieve. Format: accounts/{account}/adclients/{adclient}",
"location": "path",
"pattern": "^accounts/[^/]+/adclients/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "AdClient"
},
"scopes": [
"https://www.googleapis.com/auth/adsense",
"https://www.googleapis.com/auth/adsense.readonly"
]
},
"getAdcode": {
"description": "Gets the AdSense code for a given ad client. This returns what was previously known as the 'auto ad code'. This is only supported for ad clients with a product_code of AFC. For more information, see [About the AdSense code](https://support.google.com/adsense/answer/9274634).",
"flatPath": "v2/accounts/{accountsId}/adclients/{adclientsId}/adcode",
"httpMethod": "GET",
"id": "adsense.accounts.adclients.getAdcode",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Name of the ad client for which to get the adcode. Format: accounts/{account}/adclients/{adclient}",
"location": "path",
"pattern": "^accounts/[^/]+/adclients/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}/adcode",
"response": {
"$ref": "AdClientAdCode"
},
"scopes": [
"https://www.googleapis.com/auth/adsense",
"https://www.googleapis.com/auth/adsense.readonly"
]
},
"list": {
"description": "Lists all the ad clients available in an account.",
"flatPath": "v2/accounts/{accountsId}/adclients",
"httpMethod": "GET",
"id": "adsense.accounts.adclients.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "The maximum number of ad clients to include in the response, used for paging. If unspecified, at most 10000 ad clients will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A page token, received from a previous `ListAdClients` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAdClients` must match the call that provided the page token.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The account which owns the collection of ad clients. Format: accounts/{account}",
"location": "path",
"pattern": "^accounts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/adclients",
"response": {
"$ref": "ListAdClientsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/adsense",
"https://www.googleapis.com/auth/adsense.readonly"
]
}
},
"resources": {
"adunits": {
"methods": {
"get": {
"description": "Gets an ad unit from a specified account and ad client.",
"flatPath": "v2/accounts/{accountsId}/adclients/{adclientsId}/adunits/{adunitsId}",
"httpMethod": "GET",
"id": "adsense.accounts.adclients.adunits.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. AdUnit to get information about. Format: accounts/{account}/adclients/{adclient}/adunits/{adunit}",
"location": "path",
"pattern": "^accounts/[^/]+/adclients/[^/]+/adunits/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "AdUnit"
},
"scopes": [
"https://www.googleapis.com/auth/adsense",
"https://www.googleapis.com/auth/adsense.readonly"
]
},
"getAdcode": {
"description": "Gets the AdSense code for a given ad unit.",
"flatPath": "v2/accounts/{accountsId}/adclients/{adclientsId}/adunits/{adunitsId}/adcode",
"httpMethod": "GET",
"id": "adsense.accounts.adclients.adunits.getAdcode",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Name of the adunit for which to get the adcode. Format: accounts/{account}/adclients/{adclient}/adunits/{adunit}",
"location": "path",
"pattern": "^accounts/[^/]+/adclients/[^/]+/adunits/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}/adcode",
"response": {
"$ref": "AdUnitAdCode"
},
"scopes": [
"https://www.googleapis.com/auth/adsense",
"https://www.googleapis.com/auth/adsense.readonly"
]
},
"list": {
"description": "Lists all ad units under a specified account and ad client.",
"flatPath": "v2/accounts/{accountsId}/adclients/{adclientsId}/adunits",
"httpMethod": "GET",
"id": "adsense.accounts.adclients.adunits.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "The maximum number of ad units to include in the response, used for paging. If unspecified, at most 10000 ad units will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A page token, received from a previous `ListAdUnits` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAdUnits` must match the call that provided the page token.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The ad client which owns the collection of ad units. Format: accounts/{account}/adclients/{adclient}",
"location": "path",
"pattern": "^accounts/[^/]+/adclients/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/adunits",
"response": {
"$ref": "ListAdUnitsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/adsense",
"https://www.googleapis.com/auth/adsense.readonly"
]
},
"listLinkedCustomChannels": {
"description": "Lists all the custom channels available for an ad unit.",
"flatPath": "v2/accounts/{accountsId}/adclients/{adclientsId}/adunits/{adunitsId}:listLinkedCustomChannels",
"httpMethod": "GET",
"id": "adsense.accounts.adclients.adunits.listLinkedCustomChannels",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "The maximum number of custom channels to include in the response, used for paging. If unspecified, at most 10000 custom channels will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A page token, received from a previous `ListLinkedCustomChannels` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListLinkedCustomChannels` must match the call that provided the page token.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The ad unit which owns the collection of custom channels. Format: accounts/{account}/adclients/{adclient}/adunits/{adunit}",
"location": "path",
"pattern": "^accounts/[^/]+/adclients/[^/]+/adunits/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}:listLinkedCustomChannels",
"response": {
"$ref": "ListLinkedCustomChannelsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/adsense",
"https://www.googleapis.com/auth/adsense.readonly"
]
}
}
},
"customchannels": {
"methods": {
"get": {
"description": "Gets information about the selected custom channel.",
"flatPath": "v2/accounts/{accountsId}/adclients/{adclientsId}/customchannels/{customchannelsId}",
"httpMethod": "GET",
"id": "adsense.accounts.adclients.customchannels.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Name of the custom channel. Format: accounts/{account}/adclients/{adclient}/customchannels/{customchannel}",
"location": "path",
"pattern": "^accounts/[^/]+/adclients/[^/]+/customchannels/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "CustomChannel"
},
"scopes": [
"https://www.googleapis.com/auth/adsense",
"https://www.googleapis.com/auth/adsense.readonly"
]
},
"list": {
"description": "Lists all the custom channels available in an ad client.",
"flatPath": "v2/accounts/{accountsId}/adclients/{adclientsId}/customchannels",
"httpMethod": "GET",
"id": "adsense.accounts.adclients.customchannels.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "The maximum number of custom channels to include in the response, used for paging. If unspecified, at most 10000 custom channels will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A page token, received from a previous `ListCustomChannels` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCustomChannels` must match the call that provided the page token.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The ad client which owns the collection of custom channels. Format: accounts/{account}/adclients/{adclient}",
"location": "path",
"pattern": "^accounts/[^/]+/adclients/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/customchannels",
"response": {
"$ref": "ListCustomChannelsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/adsense",
"https://www.googleapis.com/auth/adsense.readonly"
]
},
"listLinkedAdUnits": {
"description": "Lists all the ad units available for a custom channel.",
"flatPath": "v2/accounts/{accountsId}/adclients/{adclientsId}/customchannels/{customchannelsId}:listLinkedAdUnits",
"httpMethod": "GET",
"id": "adsense.accounts.adclients.customchannels.listLinkedAdUnits",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "The maximum number of ad units to include in the response, used for paging. If unspecified, at most 10000 ad units will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A page token, received from a previous `ListLinkedAdUnits` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListLinkedAdUnits` must match the call that provided the page token.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The custom channel which owns the collection of ad units. Format: accounts/{account}/adclients/{adclient}/customchannels/{customchannel}",
"location": "path",
"pattern": "^accounts/[^/]+/adclients/[^/]+/customchannels/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}:listLinkedAdUnits",
"response": {
"$ref": "ListLinkedAdUnitsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/adsense",
"https://www.googleapis.com/auth/adsense.readonly"
]
}
}
},
"urlchannels": {
"methods": {
"get": {
"description": "Gets information about the selected url channel.",
"flatPath": "v2/accounts/{accountsId}/adclients/{adclientsId}/urlchannels/{urlchannelsId}",
"httpMethod": "GET",
"id": "adsense.accounts.adclients.urlchannels.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the url channel to retrieve. Format: accounts/{account}/adclients/{adclient}/urlchannels/{urlchannel}",
"location": "path",
"pattern": "^accounts/[^/]+/adclients/[^/]+/urlchannels/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "UrlChannel"
},
"scopes": [
"https://www.googleapis.com/auth/adsense",
"https://www.googleapis.com/auth/adsense.readonly"
]
},
"list": {
"description": "Lists active url channels.",
"flatPath": "v2/accounts/{accountsId}/adclients/{adclientsId}/urlchannels",
"httpMethod": "GET",
"id": "adsense.accounts.adclients.urlchannels.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "The maximum number of url channels to include in the response, used for paging. If unspecified, at most 10000 url channels will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A page token, received from a previous `ListUrlChannels` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUrlChannels` must match the call that provided the page token.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The ad client which owns the collection of url channels. Format: accounts/{account}/adclients/{adclient}",
"location": "path",
"pattern": "^accounts/[^/]+/adclients/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/urlchannels",
"response": {
"$ref": "ListUrlChannelsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/adsense",
"https://www.googleapis.com/auth/adsense.readonly"
]
}
}
}
}
},
"alerts": {
"methods": {
"list": {
"description": "Lists all the alerts available in an account.",
"flatPath": "v2/accounts/{accountsId}/alerts",
"httpMethod": "GET",
"id": "adsense.accounts.alerts.list",
"parameterOrder": [
"parent"
],
"parameters": {
"languageCode": {
"description": "The language to use for translating alert messages. If unspecified, this defaults to the user's display language. If the given language is not supported, alerts will be returned in English. The language is specified as an [IETF BCP-47 language code](https://en.wikipedia.org/wiki/IETF_language_tag).",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The account which owns the collection of alerts. Format: accounts/{account}",
"location": "path",
"pattern": "^accounts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/alerts",
"response": {
"$ref": "ListAlertsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/adsense",
"https://www.googleapis.com/auth/adsense.readonly"
]
}
}
},
"payments": {
"methods": {
"list": {
"description": "Lists all the payments available for an account.",
"flatPath": "v2/accounts/{accountsId}/payments",
"httpMethod": "GET",
"id": "adsense.accounts.payments.list",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The account which owns the collection of payments. Format: accounts/{account}",
"location": "path",
"pattern": "^accounts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/payments",
"response": {
"$ref": "ListPaymentsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/adsense",
"https://www.googleapis.com/auth/adsense.readonly"
]
}
}
},
"reports": {
"methods": {
"generate": {
"description": "Generates an ad hoc report.",
"flatPath": "v2/accounts/{accountsId}/reports:generate",
"httpMethod": "GET",
"id": "adsense.accounts.reports.generate",
"parameterOrder": [
"account"
],
"parameters": {
"account": {
"description": "Required. The account which owns the collection of reports. Format: accounts/{account}",
"location": "path",
"pattern": "^accounts/[^/]+$",
"required": true,
"type": "string"
},
"currencyCode": {
"description": "The [ISO-4217 currency code](https://en.wikipedia.org/wiki/ISO_4217) to use when reporting on monetary metrics. Defaults to the account's currency if not set.",
"location": "query",
"type": "string"
},
"dateRange": {
"description": "Date range of the report, if unset the range will be considered CUSTOM.",
"enum": [
"REPORTING_DATE_RANGE_UNSPECIFIED",
"CUSTOM",
"TODAY",
"YESTERDAY",
"MONTH_TO_DATE",
"YEAR_TO_DATE",
"LAST_7_DAYS",
"LAST_30_DAYS"
],
"enumDescriptions": [
"Unspecified date range.",
"A custom date range specified using the `start_date` and `end_date` fields. This is the default if no ReportingDateRange is provided.",
"Current day.",
"Yesterday.",
"From the start of the current month to the current day. e.g. if the current date is 2020-03-12 then the range will be [2020-03-01, 2020-03-12].",
"From the start of the current year to the current day. e.g. if the current date is 2020-03-12 then the range will be [2020-01-01, 2020-03-12].",
"Last 7 days, excluding current day.",
"Last 30 days, excluding current day."
],
"location": "query",
"type": "string"
},
"dimensions": {
"description": "Dimensions to base the report on.",
"enum": [
"DIMENSION_UNSPECIFIED",
"DATE",
"WEEK",
"MONTH",
"ACCOUNT_NAME",
"AD_CLIENT_ID",
"PRODUCT_NAME",
"PRODUCT_CODE",
"AD_UNIT_NAME",
"AD_UNIT_ID",
"AD_UNIT_SIZE_NAME",
"AD_UNIT_SIZE_CODE",
"CUSTOM_CHANNEL_NAME",
"CUSTOM_CHANNEL_ID",
"OWNED_SITE_DOMAIN_NAME",
"OWNED_SITE_ID",
"URL_CHANNEL_NAME",
"URL_CHANNEL_ID",
"BUYER_NETWORK_NAME",
"BUYER_NETWORK_ID",
"BID_TYPE_NAME",
"BID_TYPE_CODE",
"CREATIVE_SIZE_NAME",
"CREATIVE_SIZE_CODE",
"DOMAIN_NAME",
"DOMAIN_CODE",
"COUNTRY_NAME",
"COUNTRY_CODE",
"PLATFORM_TYPE_NAME",
"PLATFORM_TYPE_CODE",
"TARGETING_TYPE_NAME",
"TARGETING_TYPE_CODE",
"CONTENT_PLATFORM_NAME",
"CONTENT_PLATFORM_CODE",
"AD_PLACEMENT_NAME",
"AD_PLACEMENT_CODE",
"REQUESTED_AD_TYPE_NAME",
"REQUESTED_AD_TYPE_CODE",
"SERVED_AD_TYPE_NAME",
"SERVED_AD_TYPE_CODE",
"AD_FORMAT_NAME",
"AD_FORMAT_CODE",
"CUSTOM_SEARCH_STYLE_NAME",
"CUSTOM_SEARCH_STYLE_ID",
"DOMAIN_REGISTRANT",
"WEBSEARCH_QUERY_STRING"
],
"enumDescriptions": [
"Unspecified dimension.",
"Date dimension in YYYY-MM-DD format (e.g. \"2010-02-10\").",
"Week dimension in YYYY-MM-DD format, representing the first day of each week (e.g. \"2010-02-08\"). The first day of the week is determined by the language_code specified in a report generation request (so e.g. this would be a Monday for \"en-GB\" or \"es\", but a Sunday for \"en\" or \"fr-CA\").",
"Month dimension in YYYY-MM format (e.g. \"2010-02\").",
"Account name. The members of this dimension match the values from Account.display_name.",
"Unique ID of an ad client. The members of this dimension match the values from AdClient.reporting_dimension_id.",
"Localized product name (e.g. \"AdSense for Content\", \"AdSense for Search\").",
"Product code (e.g. \"AFC\", \"AFS\"). The members of this dimension match the values from AdClient.product_code.",
"Ad unit name (within which an ad was served). The members of this dimension match the values from AdUnit.display_name.",
"Unique ID of an ad unit (within which an ad was served). The members of this dimension match the values from AdUnit.reporting_dimension_id.",
"Localized size of an ad unit (e.g. \"728x90\", \"Responsive\").",
"The size code of an ad unit (e.g. \"728x90\", \"responsive\").",
"Custom channel name. The members of this dimension match the values from CustomChannel.display_name.",
"Unique ID of a custom channel. The members of this dimension match the values from CustomChannel.reporting_dimension_id.",
"Domain name of a verified site (e.g. \"example.com\"). The members of this dimension match the values from Site.domain.",
"Unique ID of a verified site. The members of this dimension match the values from Site.reporting_dimension_id.",
"Name of a URL channel. The members of this dimension match the values from UrlChannel.uri_pattern.",
"Unique ID of a URL channel. The members of this dimension match the values from UrlChannel.reporting_dimension_id.",
"Name of an ad network that returned the winning ads for an ad request (e.g. \"Google AdWords\"). Note that unlike other \"NAME\" dimensions, the members of this dimensions are not localized.",
"Unique (opaque) ID of an ad network that returned the winning ads for an ad request.",
"Localized bid type name (e.g. \"CPC bids\", \"CPM bids\") for a served ad.",
"Type of a bid (e.g. \"cpc\", \"cpm\") for a served ad.",
"Localized creative size name (e.g. \"728x90\", \"Dynamic\") of a served ad.",
"Creative size code (e.g. \"728x90\", \"dynamic\") of a served ad.",
"Localized name of a host on which an ad was served, after IDNA decoding (e.g. \"www.google.com\", \"Web caches and other\", \"bücher.example\").",
"Name of a host on which an ad was served (e.g. \"www.google.com\", \"webcaches\", \"xn--bcher-kva.example\").",
"Localized region name of a user viewing an ad (e.g. \"United States\", \"France\").",
"CLDR region code of a user viewing an ad (e.g. \"US\", \"FR\").",
"Localized platform type name (e.g. \"High-end mobile devices\", \"Desktop\").",
"Platform type code (e.g. \"HighEndMobile\", \"Desktop\").",
"Localized targeting type name (e.g. \"Contextual\", \"Personalized\", \"Run of Network\").",
"Targeting type code (e.g. \"Keyword\", \"UserInterest\", \"RunOfNetwork\").",
"Localized content platform name an ad request was made from (e.g. \"AMP\", \"Web\").",
"Content platform code an ad request was made from (e.g. \"AMP\", \"HTML\").",
"Localized ad placement name (e.g. \"Ad unit\", \"Global settings\", \"Manual\").",
"Ad placement code (e.g. \"AD_UNIT\", \"ca-pub-123456:78910\", \"OTHER\").",
"Localized requested ad type name (e.g. \"Display\", \"Link unit\", \"Other\").",
"Requested ad type code (e.g. \"IMAGE\", \"RADLINK\", \"OTHER\").",
"Localized served ad type name (e.g. \"Display\", \"Link unit\", \"Other\").",
"Served ad type code (e.g. \"IMAGE\", \"RADLINK\", \"OTHER\").",
"Localized ad format name indicating the way an ad is shown to the users on your site (e.g. \"In-page\", \"Anchor\", \"Vignette\").",
"Ad format code indicating the way an ad is shown to the users on your site (e.g. \"ON_PAGE\", \"ANCHOR\", \"INTERSTITIAL\").",
"Custom search style name.",
"Custom search style id.",
"Domain registrants.",
"Query strings for web searches."
],
"location": "query",
"repeated": true,
"type": "string"
},
"endDate.day": {
"description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.",
"format": "int32",
"location": "query",
"type": "integer"
},
"endDate.month": {
"description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.",
"format": "int32",
"location": "query",
"type": "integer"
},
"endDate.year": {
"description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.",
"format": "int32",
"location": "query",
"type": "integer"
},
"filters": {
"description": "Filters to be run on the report.",
"location": "query",
"repeated": true,
"type": "string"
},
"languageCode": {
"description": "The language to use for translating report output. If unspecified, this defaults to English (\"en\"). If the given language is not supported, report output will be returned in English. The language is specified as an [IETF BCP-47 language code](https://en.wikipedia.org/wiki/IETF_language_tag).",
"location": "query",
"type": "string"
},
"limit": {
"description": "The maximum number of rows of report data to return. Reports producing more rows than the requested limit will be truncated. If unset, this defaults to 100,000 rows for `Reports.GenerateReport` and 1,000,000 rows for `Reports.GenerateCsvReport`, which are also the maximum values permitted here. Report truncation can be identified (for `Reports.GenerateReport` only) by comparing the number of rows returned to the value returned in `total_matched_rows`.",
"format": "int32",
"location": "query",
"type": "integer"
},
"metrics": {
"description": "Required. Reporting metrics.",
"enum": [
"METRIC_UNSPECIFIED",
"PAGE_VIEWS",
"AD_REQUESTS",
"MATCHED_AD_REQUESTS",
"TOTAL_IMPRESSIONS",
"IMPRESSIONS",
"INDIVIDUAL_AD_IMPRESSIONS",
"CLICKS",
"PAGE_VIEWS_SPAM_RATIO",
"AD_REQUESTS_SPAM_RATIO",
"MATCHED_AD_REQUESTS_SPAM_RATIO",
"IMPRESSIONS_SPAM_RATIO",
"INDIVIDUAL_AD_IMPRESSIONS_SPAM_RATIO",
"CLICKS_SPAM_RATIO",
"AD_REQUESTS_COVERAGE",
"PAGE_VIEWS_CTR",
"AD_REQUESTS_CTR",
"MATCHED_AD_REQUESTS_CTR",
"IMPRESSIONS_CTR",
"INDIVIDUAL_AD_IMPRESSIONS_CTR",
"ACTIVE_VIEW_MEASURABILITY",
"ACTIVE_VIEW_VIEWABILITY",
"ACTIVE_VIEW_TIME",
"ESTIMATED_EARNINGS",
"PAGE_VIEWS_RPM",
"AD_REQUESTS_RPM",
"MATCHED_AD_REQUESTS_RPM",
"IMPRESSIONS_RPM",
"INDIVIDUAL_AD_IMPRESSIONS_RPM",
"COST_PER_CLICK",
"ADS_PER_IMPRESSION",
"TOTAL_EARNINGS",
"WEBSEARCH_RESULT_PAGES"
],
"enumDescriptions": [
"Unspecified metric.",
"Number of page views.",
"Number of ad units that requested ads (for content ads) or search queries (for search ads). An ad request may result in zero, one, or multiple individual ad impressions depending on the size of the ad unit and whether any ads were available.",
"Requests that returned at least one ad.",
"Impressions. An impression is counted for each ad request where at least one ad has been downloaded to the user’s device and has begun to load. It is the number of ad units (for content ads) or search queries (for search ads) that showed ads.",
"Impressions. An impression is counted for each ad request where at least one ad has been downloaded to the user’s device and has begun to load. It is the number of ad units (for content ads) or search queries (for search ads) that showed ads.",
"Ads shown. Different ad formats will display varying numbers of ads. For example, a vertical banner may consist of 2 or more ads. Also, the number of ads in an ad unit may vary depending on whether the ad unit is displaying standard text ads, expanded text ads or image ads.",
"Number of times a user clicked on a standard content ad.",
"Fraction of page views considered to be spam. Only available to premium accounts.",
"Fraction of ad requests considered to be spam. Only available to premium accounts.",
"Fraction of ad requests that returned ads considered to be spam. Only available to premium accounts.",
"Fraction of impressions considered to be spam. Only available to premium accounts.",
"Fraction of ad impressions considered to be spam. Only available to premium accounts.",
"Fraction of clicks considered to be spam. Only available to premium accounts.",
"Ratio of requested ad units or queries to the number returned to the site.",
"Ratio of individual page views that resulted in a click.",
"Ratio of ad requests that resulted in a click.",
"Ratio of clicks to matched requests.",
"Ratio of IMPRESSIONS that resulted in a click.",
"Ratio of individual ad impressions that resulted in a click.",
"Ratio of requests that were measurable for viewability.",
"Ratio of requests that were viewable.",
"Mean time an ad was displayed on screen.",
"Estimated earnings of the publisher. Note that earnings up to yesterday are accurate, more recent earnings are estimated due to the possibility of spam, or exchange rate fluctuations.",
"Revenue per thousand page views. This is calculated by dividing the estimated revenue by the number of page views multiplied by 1000.",
"Revenue per thousand ad requests. This is calculated by dividing estimated revenue by the number of ad requests multiplied by 1000.",
"Revenue per thousand matched ad requests. This is calculated by dividing estimated revenue by the number of matched ad requests multiplied by 1000.",
"Revenue per thousand ad impressions. This is calculated by dividing estimated revenue by the number of ad impressions multiplied by 1000.",
"Revenue per thousand individual ad impressions. This is calculated by dividing estimated revenue by the number of individual ad impressions multiplied by 1000.",
"Amount the publisher earns each time a user clicks on an ad. CPC is calculated by dividing the estimated revenue by the number of clicks received.",
"Number of ad views per impression.",
"Total earnings are the gross estimated earnings from revenue shared traffic before any parent and child account revenue share is applied.",
"Number of results pages."
],
"location": "query",
"repeated": true,
"type": "string"
},
"orderBy": {
"description": "The name of a dimension or metric to sort the resulting report on, can be prefixed with \"+\" to sort ascending or \"-\" to sort descending. If no prefix is specified, the column is sorted ascending.",
"location": "query",
"repeated": true,
"type": "string"
},
"reportingTimeZone": {
"description": "Timezone in which to generate the report. If unspecified, this defaults to the account timezone. For more information, see [changing the time zone of your reports](https://support.google.com/adsense/answer/9830725).",
"enum": [
"REPORTING_TIME_ZONE_UNSPECIFIED",
"ACCOUNT_TIME_ZONE",
"GOOGLE_TIME_ZONE"
],
"enumDescriptions": [
"Unspecified timezone.",
"Use the account timezone in the report.",
"Use the Google timezone in the report (America/Los_Angeles)."
],
"location": "query",
"type": "string"
},
"startDate.day": {
"description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.",
"format": "int32",
"location": "query",
"type": "integer"
},
"startDate.month": {
"description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.",
"format": "int32",
"location": "query",
"type": "integer"
},
"startDate.year": {
"description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.",
"format": "int32",
"location": "query",
"type": "integer"
}
},
"path": "v2/{+account}/reports:generate",
"response": {
"$ref": "ReportResult"
},
"scopes": [
"https://www.googleapis.com/auth/adsense",
"https://www.googleapis.com/auth/adsense.readonly"
]
},
"generateCsv": {
"description": "Generates a csv formatted ad hoc report.",
"flatPath": "v2/accounts/{accountsId}/reports:generateCsv",
"httpMethod": "GET",
"id": "adsense.accounts.reports.generateCsv",
"parameterOrder": [
"account"
],
"parameters": {
"account": {
"description": "Required. The account which owns the collection of reports. Format: accounts/{account}",
"location": "path",
"pattern": "^accounts/[^/]+$",
"required": true,
"type": "string"
},
"currencyCode": {
"description": "The [ISO-4217 currency code](https://en.wikipedia.org/wiki/ISO_4217) to use when reporting on monetary metrics. Defaults to the account's currency if not set.",
"location": "query",
"type": "string"
},
"dateRange": {
"description": "Date range of the report, if unset the range will be considered CUSTOM.",
"enum": [
"REPORTING_DATE_RANGE_UNSPECIFIED",
"CUSTOM",