generated from Apodini/Template-Repository
-
Notifications
You must be signed in to change notification settings - Fork 0
/
google-adsense-v1.4.yaml
2612 lines (2610 loc) · 92.7 KB
/
google-adsense-v1.4.yaml
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
openapi: 3.0.0
servers:
- url: https://www.googleapis.com/adsense/v1.4
info:
contact:
name: Google
url: https://google.com
x-twitter: youtube
description: Accesses AdSense publishers' inventory and generates performance reports.
license:
name: Creative Commons Attribution 3.0
url: http://creativecommons.org/licenses/by/3.0/
termsOfService: https://developers.google.com/terms/
title: AdSense Management API
version: v1.4
x-apiClientRegistration:
url: https://console.developers.google.com
x-apisguru-categories:
- analytics
- media
x-logo:
url: https://www.google.com/images/branding/googlelogo/2x/googlelogo_color_272x92dp.png
x-origin:
- format: google
url: https://adsense.googleapis.com/$discovery/rest?version=v1.4
version: v1
x-preferred: true
x-providerName: googleapis.com
x-serviceName: adsense
externalDocs:
url: https://developers.google.com/adsense/management/
tags:
- name: accounts
- name: adclients
- name: adunits
- name: alerts
- name: customchannels
- name: metadata
- name: payments
- name: reports
- name: savedadstyles
- name: urlchannels
paths:
/accounts:
get:
description: List all accounts available to this AdSense account.
operationId: adsense.accounts.list
parameters:
- description: The maximum number of accounts to include in the response, used for paging.
in: query
name: maxResults
schema:
maximum: 10000
minimum: 0
type: integer
- description: A continuation token, used to page through accounts. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
in: query
name: pageToken
schema:
type: string
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/Accounts"
description: Successful response
security:
- Oauth2:
- https://www.googleapis.com/auth/adsense
Oauth2c:
- https://www.googleapis.com/auth/adsense
- Oauth2:
- https://www.googleapis.com/auth/adsense.readonly
Oauth2c:
- https://www.googleapis.com/auth/adsense.readonly
tags:
- accounts
parameters:
- $ref: "#/components/parameters/alt"
- $ref: "#/components/parameters/fields"
- $ref: "#/components/parameters/key"
- $ref: "#/components/parameters/oauth_token"
- $ref: "#/components/parameters/prettyPrint"
- $ref: "#/components/parameters/quotaUser"
- $ref: "#/components/parameters/userIp"
"/accounts/{accountId}":
get:
description: Get information about the selected AdSense account.
operationId: adsense.accounts.get
parameters:
- description: Account to get information about.
in: path
name: accountId
required: true
schema:
type: string
- description: Whether the tree of sub accounts should be returned.
in: query
name: tree
schema:
type: boolean
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/Account"
description: Successful response
security:
- Oauth2:
- https://www.googleapis.com/auth/adsense
Oauth2c:
- https://www.googleapis.com/auth/adsense
- Oauth2:
- https://www.googleapis.com/auth/adsense.readonly
Oauth2c:
- https://www.googleapis.com/auth/adsense.readonly
tags:
- accounts
parameters:
- $ref: "#/components/parameters/alt"
- $ref: "#/components/parameters/fields"
- $ref: "#/components/parameters/key"
- $ref: "#/components/parameters/oauth_token"
- $ref: "#/components/parameters/prettyPrint"
- $ref: "#/components/parameters/quotaUser"
- $ref: "#/components/parameters/userIp"
"/accounts/{accountId}/adclients":
get:
description: List all ad clients in the specified account.
operationId: adsense.accounts.adclients.list
parameters:
- description: Account for which to list ad clients.
in: path
name: accountId
required: true
schema:
type: string
- description: The maximum number of ad clients to include in the response, used for paging.
in: query
name: maxResults
schema:
maximum: 10000
minimum: 0
type: integer
- description: A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
in: query
name: pageToken
schema:
type: string
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/AdClients"
description: Successful response
security:
- Oauth2:
- https://www.googleapis.com/auth/adsense
Oauth2c:
- https://www.googleapis.com/auth/adsense
- Oauth2:
- https://www.googleapis.com/auth/adsense.readonly
Oauth2c:
- https://www.googleapis.com/auth/adsense.readonly
tags:
- accounts
parameters:
- $ref: "#/components/parameters/alt"
- $ref: "#/components/parameters/fields"
- $ref: "#/components/parameters/key"
- $ref: "#/components/parameters/oauth_token"
- $ref: "#/components/parameters/prettyPrint"
- $ref: "#/components/parameters/quotaUser"
- $ref: "#/components/parameters/userIp"
"/accounts/{accountId}/adclients/{adClientId}/adcode":
get:
description: Get Auto ad code for a given ad client.
operationId: adsense.accounts.adclients.getAdCode
parameters:
- description: Account which contains the ad client.
in: path
name: accountId
required: true
schema:
type: string
- description: Ad client to get the code for.
in: path
name: adClientId
required: true
schema:
type: string
- description: Tag partner to include in the ad code snippet.
in: query
name: tagPartner
schema:
type: string
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/AdCode"
description: Successful response
security:
- Oauth2:
- https://www.googleapis.com/auth/adsense
Oauth2c:
- https://www.googleapis.com/auth/adsense
- Oauth2:
- https://www.googleapis.com/auth/adsense.readonly
Oauth2c:
- https://www.googleapis.com/auth/adsense.readonly
tags:
- accounts
parameters:
- $ref: "#/components/parameters/alt"
- $ref: "#/components/parameters/fields"
- $ref: "#/components/parameters/key"
- $ref: "#/components/parameters/oauth_token"
- $ref: "#/components/parameters/prettyPrint"
- $ref: "#/components/parameters/quotaUser"
- $ref: "#/components/parameters/userIp"
"/accounts/{accountId}/adclients/{adClientId}/adunits":
get:
description: List all ad units in the specified ad client for the specified account.
operationId: adsense.accounts.adunits.list
parameters:
- description: Account to which the ad client belongs.
in: path
name: accountId
required: true
schema:
type: string
- description: Ad client for which to list ad units.
in: path
name: adClientId
required: true
schema:
type: string
- description: "Whether to include inactive ad units. Default: true."
in: query
name: includeInactive
schema:
type: boolean
- description: The maximum number of ad units to include in the response, used for paging.
in: query
name: maxResults
schema:
maximum: 10000
minimum: 0
type: integer
- description: A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
in: query
name: pageToken
schema:
type: string
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/AdUnits"
description: Successful response
security:
- Oauth2:
- https://www.googleapis.com/auth/adsense
Oauth2c:
- https://www.googleapis.com/auth/adsense
- Oauth2:
- https://www.googleapis.com/auth/adsense.readonly
Oauth2c:
- https://www.googleapis.com/auth/adsense.readonly
tags:
- accounts
parameters:
- $ref: "#/components/parameters/alt"
- $ref: "#/components/parameters/fields"
- $ref: "#/components/parameters/key"
- $ref: "#/components/parameters/oauth_token"
- $ref: "#/components/parameters/prettyPrint"
- $ref: "#/components/parameters/quotaUser"
- $ref: "#/components/parameters/userIp"
"/accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}":
get:
description: Gets the specified ad unit in the specified ad client for the specified account.
operationId: adsense.accounts.adunits.get
parameters:
- description: Account to which the ad client belongs.
in: path
name: accountId
required: true
schema:
type: string
- description: Ad client for which to get the ad unit.
in: path
name: adClientId
required: true
schema:
type: string
- description: Ad unit to retrieve.
in: path
name: adUnitId
required: true
schema:
type: string
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/AdUnit"
description: Successful response
security:
- Oauth2:
- https://www.googleapis.com/auth/adsense
Oauth2c:
- https://www.googleapis.com/auth/adsense
- Oauth2:
- https://www.googleapis.com/auth/adsense.readonly
Oauth2c:
- https://www.googleapis.com/auth/adsense.readonly
tags:
- accounts
parameters:
- $ref: "#/components/parameters/alt"
- $ref: "#/components/parameters/fields"
- $ref: "#/components/parameters/key"
- $ref: "#/components/parameters/oauth_token"
- $ref: "#/components/parameters/prettyPrint"
- $ref: "#/components/parameters/quotaUser"
- $ref: "#/components/parameters/userIp"
"/accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}/adcode":
get:
description: Get ad code for the specified ad unit.
operationId: adsense.accounts.adunits.getAdCode
parameters:
- description: Account which contains the ad client.
in: path
name: accountId
required: true
schema:
type: string
- description: Ad client with contains the ad unit.
in: path
name: adClientId
required: true
schema:
type: string
- description: Ad unit to get the code for.
in: path
name: adUnitId
required: true
schema:
type: string
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/AdCode"
description: Successful response
security:
- Oauth2:
- https://www.googleapis.com/auth/adsense
Oauth2c:
- https://www.googleapis.com/auth/adsense
- Oauth2:
- https://www.googleapis.com/auth/adsense.readonly
Oauth2c:
- https://www.googleapis.com/auth/adsense.readonly
tags:
- accounts
parameters:
- $ref: "#/components/parameters/alt"
- $ref: "#/components/parameters/fields"
- $ref: "#/components/parameters/key"
- $ref: "#/components/parameters/oauth_token"
- $ref: "#/components/parameters/prettyPrint"
- $ref: "#/components/parameters/quotaUser"
- $ref: "#/components/parameters/userIp"
"/accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}/customchannels":
get:
description: List all custom channels which the specified ad unit belongs to.
operationId: adsense.accounts.adunits.customchannels.list
parameters:
- description: Account to which the ad client belongs.
in: path
name: accountId
required: true
schema:
type: string
- description: Ad client which contains the ad unit.
in: path
name: adClientId
required: true
schema:
type: string
- description: Ad unit for which to list custom channels.
in: path
name: adUnitId
required: true
schema:
type: string
- description: The maximum number of custom channels to include in the response, used for paging.
in: query
name: maxResults
schema:
maximum: 10000
minimum: 0
type: integer
- description: A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
in: query
name: pageToken
schema:
type: string
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/CustomChannels"
description: Successful response
security:
- Oauth2:
- https://www.googleapis.com/auth/adsense
Oauth2c:
- https://www.googleapis.com/auth/adsense
- Oauth2:
- https://www.googleapis.com/auth/adsense.readonly
Oauth2c:
- https://www.googleapis.com/auth/adsense.readonly
tags:
- accounts
parameters:
- $ref: "#/components/parameters/alt"
- $ref: "#/components/parameters/fields"
- $ref: "#/components/parameters/key"
- $ref: "#/components/parameters/oauth_token"
- $ref: "#/components/parameters/prettyPrint"
- $ref: "#/components/parameters/quotaUser"
- $ref: "#/components/parameters/userIp"
"/accounts/{accountId}/adclients/{adClientId}/customchannels":
get:
description: List all custom channels in the specified ad client for the specified account.
operationId: adsense.accounts.customchannels.list
parameters:
- description: Account to which the ad client belongs.
in: path
name: accountId
required: true
schema:
type: string
- description: Ad client for which to list custom channels.
in: path
name: adClientId
required: true
schema:
type: string
- description: The maximum number of custom channels to include in the response, used for paging.
in: query
name: maxResults
schema:
maximum: 10000
minimum: 0
type: integer
- description: A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
in: query
name: pageToken
schema:
type: string
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/CustomChannels"
description: Successful response
security:
- Oauth2:
- https://www.googleapis.com/auth/adsense
Oauth2c:
- https://www.googleapis.com/auth/adsense
- Oauth2:
- https://www.googleapis.com/auth/adsense.readonly
Oauth2c:
- https://www.googleapis.com/auth/adsense.readonly
tags:
- accounts
parameters:
- $ref: "#/components/parameters/alt"
- $ref: "#/components/parameters/fields"
- $ref: "#/components/parameters/key"
- $ref: "#/components/parameters/oauth_token"
- $ref: "#/components/parameters/prettyPrint"
- $ref: "#/components/parameters/quotaUser"
- $ref: "#/components/parameters/userIp"
"/accounts/{accountId}/adclients/{adClientId}/customchannels/{customChannelId}":
get:
description: Get the specified custom channel from the specified ad client for the specified account.
operationId: adsense.accounts.customchannels.get
parameters:
- description: Account to which the ad client belongs.
in: path
name: accountId
required: true
schema:
type: string
- description: Ad client which contains the custom channel.
in: path
name: adClientId
required: true
schema:
type: string
- description: Custom channel to retrieve.
in: path
name: customChannelId
required: true
schema:
type: string
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/CustomChannel"
description: Successful response
security:
- Oauth2:
- https://www.googleapis.com/auth/adsense
Oauth2c:
- https://www.googleapis.com/auth/adsense
- Oauth2:
- https://www.googleapis.com/auth/adsense.readonly
Oauth2c:
- https://www.googleapis.com/auth/adsense.readonly
tags:
- accounts
parameters:
- $ref: "#/components/parameters/alt"
- $ref: "#/components/parameters/fields"
- $ref: "#/components/parameters/key"
- $ref: "#/components/parameters/oauth_token"
- $ref: "#/components/parameters/prettyPrint"
- $ref: "#/components/parameters/quotaUser"
- $ref: "#/components/parameters/userIp"
"/accounts/{accountId}/adclients/{adClientId}/customchannels/{customChannelId}/adunits":
get:
description: List all ad units in the specified custom channel.
operationId: adsense.accounts.customchannels.adunits.list
parameters:
- description: Account to which the ad client belongs.
in: path
name: accountId
required: true
schema:
type: string
- description: Ad client which contains the custom channel.
in: path
name: adClientId
required: true
schema:
type: string
- description: Custom channel for which to list ad units.
in: path
name: customChannelId
required: true
schema:
type: string
- description: "Whether to include inactive ad units. Default: true."
in: query
name: includeInactive
schema:
type: boolean
- description: The maximum number of ad units to include in the response, used for paging.
in: query
name: maxResults
schema:
maximum: 10000
minimum: 0
type: integer
- description: A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
in: query
name: pageToken
schema:
type: string
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/AdUnits"
description: Successful response
security:
- Oauth2:
- https://www.googleapis.com/auth/adsense
Oauth2c:
- https://www.googleapis.com/auth/adsense
- Oauth2:
- https://www.googleapis.com/auth/adsense.readonly
Oauth2c:
- https://www.googleapis.com/auth/adsense.readonly
tags:
- accounts
parameters:
- $ref: "#/components/parameters/alt"
- $ref: "#/components/parameters/fields"
- $ref: "#/components/parameters/key"
- $ref: "#/components/parameters/oauth_token"
- $ref: "#/components/parameters/prettyPrint"
- $ref: "#/components/parameters/quotaUser"
- $ref: "#/components/parameters/userIp"
"/accounts/{accountId}/adclients/{adClientId}/urlchannels":
get:
description: List all URL channels in the specified ad client for the specified account.
operationId: adsense.accounts.urlchannels.list
parameters:
- description: Account to which the ad client belongs.
in: path
name: accountId
required: true
schema:
type: string
- description: Ad client for which to list URL channels.
in: path
name: adClientId
required: true
schema:
type: string
- description: The maximum number of URL channels to include in the response, used for paging.
in: query
name: maxResults
schema:
maximum: 10000
minimum: 0
type: integer
- description: A continuation token, used to page through URL channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
in: query
name: pageToken
schema:
type: string
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/UrlChannels"
description: Successful response
security:
- Oauth2:
- https://www.googleapis.com/auth/adsense
Oauth2c:
- https://www.googleapis.com/auth/adsense
- Oauth2:
- https://www.googleapis.com/auth/adsense.readonly
Oauth2c:
- https://www.googleapis.com/auth/adsense.readonly
tags:
- accounts
parameters:
- $ref: "#/components/parameters/alt"
- $ref: "#/components/parameters/fields"
- $ref: "#/components/parameters/key"
- $ref: "#/components/parameters/oauth_token"
- $ref: "#/components/parameters/prettyPrint"
- $ref: "#/components/parameters/quotaUser"
- $ref: "#/components/parameters/userIp"
"/accounts/{accountId}/alerts":
get:
description: List the alerts for the specified AdSense account.
operationId: adsense.accounts.alerts.list
parameters:
- description: Account for which to retrieve the alerts.
in: path
name: accountId
required: true
schema:
type: string
- description: The locale to use for translating alert messages. The account locale will be used if this is not supplied. The AdSense default (English) will be used if the supplied locale is invalid or unsupported.
in: query
name: locale
schema:
type: string
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/Alerts"
description: Successful response
security:
- Oauth2:
- https://www.googleapis.com/auth/adsense
Oauth2c:
- https://www.googleapis.com/auth/adsense
- Oauth2:
- https://www.googleapis.com/auth/adsense.readonly
Oauth2c:
- https://www.googleapis.com/auth/adsense.readonly
tags:
- accounts
parameters:
- $ref: "#/components/parameters/alt"
- $ref: "#/components/parameters/fields"
- $ref: "#/components/parameters/key"
- $ref: "#/components/parameters/oauth_token"
- $ref: "#/components/parameters/prettyPrint"
- $ref: "#/components/parameters/quotaUser"
- $ref: "#/components/parameters/userIp"
"/accounts/{accountId}/alerts/{alertId}":
delete:
description: Dismiss (delete) the specified alert from the specified publisher AdSense account.
operationId: adsense.accounts.alerts.delete
parameters:
- description: Account which contains the ad unit.
in: path
name: accountId
required: true
schema:
type: string
- description: Alert to delete.
in: path
name: alertId
required: true
schema:
type: string
responses:
"200":
description: Successful response
security:
- Oauth2:
- https://www.googleapis.com/auth/adsense
Oauth2c:
- https://www.googleapis.com/auth/adsense
tags:
- accounts
parameters:
- $ref: "#/components/parameters/alt"
- $ref: "#/components/parameters/fields"
- $ref: "#/components/parameters/key"
- $ref: "#/components/parameters/oauth_token"
- $ref: "#/components/parameters/prettyPrint"
- $ref: "#/components/parameters/quotaUser"
- $ref: "#/components/parameters/userIp"
"/accounts/{accountId}/payments":
get:
description: List the payments for the specified AdSense account.
operationId: adsense.accounts.payments.list
parameters:
- description: Account for which to retrieve the payments.
in: path
name: accountId
required: true
schema:
type: string
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/Payments"
description: Successful response
security:
- Oauth2:
- https://www.googleapis.com/auth/adsense
Oauth2c:
- https://www.googleapis.com/auth/adsense
- Oauth2:
- https://www.googleapis.com/auth/adsense.readonly
Oauth2c:
- https://www.googleapis.com/auth/adsense.readonly
tags:
- accounts
parameters:
- $ref: "#/components/parameters/alt"
- $ref: "#/components/parameters/fields"
- $ref: "#/components/parameters/key"
- $ref: "#/components/parameters/oauth_token"
- $ref: "#/components/parameters/prettyPrint"
- $ref: "#/components/parameters/quotaUser"
- $ref: "#/components/parameters/userIp"
"/accounts/{accountId}/reports":
get:
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.
operationId: adsense.accounts.reports.generate
parameters:
- description: Account upon which to report.
in: path
name: accountId
required: true
schema:
type: string
- description: Start of the date range to report on in "YYYY-MM-DD" format, inclusive.
in: query
name: startDate
required: true
schema:
type: string
- description: End of the date range to report on in "YYYY-MM-DD" format, inclusive.
in: query
name: endDate
required: true
schema:
type: string
- description: Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set.
in: query
name: currency
schema:
type: string
- description: Dimensions to base the report on.
explode: true
in: query
name: dimension
schema:
items:
type: string
type: array
style: form
- description: Filters to be run on the report.
explode: true
in: query
name: filter
schema:
items:
type: string
type: array
style: form
- description: Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified.
in: query
name: locale
schema:
type: string
- description: The maximum number of rows of report data to return.
in: query
name: maxResults
schema:
maximum: 50000
minimum: 0
type: integer
- description: Numeric columns to include in the report.
explode: true
in: query
name: metric
schema:
items:
type: string
type: array
style: form
- 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 ascending.
explode: true
in: query
name: sort
schema:
items:
type: string
type: array
style: form
- description: Index of the first row of report data to return.
in: query
name: startIndex
schema:
maximum: 5000
minimum: 0
type: integer
- description: Whether the report should be generated in the AdSense account's local timezone. If false default PST/PDT timezone will be used.
in: query
name: useTimezoneReporting
schema:
type: boolean
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/AdsenseReportsGenerateResponse"
description: Successful response
security:
- Oauth2:
- https://www.googleapis.com/auth/adsense
Oauth2c:
- https://www.googleapis.com/auth/adsense
- Oauth2:
- https://www.googleapis.com/auth/adsense.readonly
Oauth2c:
- https://www.googleapis.com/auth/adsense.readonly
tags:
- accounts
parameters:
- $ref: "#/components/parameters/alt"
- $ref: "#/components/parameters/fields"
- $ref: "#/components/parameters/key"
- $ref: "#/components/parameters/oauth_token"
- $ref: "#/components/parameters/prettyPrint"
- $ref: "#/components/parameters/quotaUser"
- $ref: "#/components/parameters/userIp"
"/accounts/{accountId}/reports/saved":
get:
description: List all saved reports in the specified AdSense account.
operationId: adsense.accounts.reports.saved.list
parameters:
- description: Account to which the saved reports belong.
in: path
name: accountId
required: true
schema:
type: string
- description: The maximum number of saved reports to include in the response, used for paging.
in: query
name: maxResults
schema:
maximum: 100
minimum: 0
type: integer
- description: A continuation token, used to page through saved reports. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
in: query
name: pageToken
schema:
type: string
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/SavedReports"
description: Successful response
security:
- Oauth2:
- https://www.googleapis.com/auth/adsense
Oauth2c:
- https://www.googleapis.com/auth/adsense
- Oauth2:
- https://www.googleapis.com/auth/adsense.readonly
Oauth2c:
- https://www.googleapis.com/auth/adsense.readonly
tags:
- accounts
parameters:
- $ref: "#/components/parameters/alt"
- $ref: "#/components/parameters/fields"
- $ref: "#/components/parameters/key"
- $ref: "#/components/parameters/oauth_token"
- $ref: "#/components/parameters/prettyPrint"
- $ref: "#/components/parameters/quotaUser"
- $ref: "#/components/parameters/userIp"
"/accounts/{accountId}/reports/{savedReportId}":
get:
description: Generate an AdSense report based on the saved report ID sent in the query parameters.
operationId: adsense.accounts.reports.saved.generate
parameters:
- description: Account to which the saved reports belong.
in: path
name: accountId
required: true
schema:
type: string
- description: The saved report to retrieve.
in: path
name: savedReportId
required: true
schema:
type: string
- description: Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified.
in: query
name: locale
schema:
type: string
- description: The maximum number of rows of report data to return.
in: query
name: maxResults
schema:
maximum: 50000
minimum: 0
type: integer
- description: Index of the first row of report data to return.
in: query
name: startIndex
schema:
maximum: 5000
minimum: 0
type: integer
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/AdsenseReportsGenerateResponse"
description: Successful response
security:
- Oauth2:
- https://www.googleapis.com/auth/adsense
Oauth2c:
- https://www.googleapis.com/auth/adsense
- Oauth2:
- https://www.googleapis.com/auth/adsense.readonly
Oauth2c:
- https://www.googleapis.com/auth/adsense.readonly
tags:
- accounts