/
admob-api.json
1328 lines (1328 loc) · 65.7 KB
/
admob-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/admob.readonly": {
"description": "See your AdMob data"
},
"https://www.googleapis.com/auth/admob.report": {
"description": "See your AdMob data"
}
}
}
},
"basePath": "",
"baseUrl": "https://admob.googleapis.com/",
"batchPath": "batch",
"canonicalName": "AdMob",
"description": "The AdMob API allows publishers to programmatically get information about their AdMob account. ",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/admob/api/",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "admob:v1beta",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://admob.mtls.googleapis.com/",
"name": "admob",
"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 specified AdMob publisher account.",
"flatPath": "v1beta/accounts/{accountsId}",
"httpMethod": "GET",
"id": "admob.accounts.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Resource name of the publisher account to retrieve. Example: accounts/pub-9876543210987654",
"location": "path",
"pattern": "^accounts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "PublisherAccount"
},
"scopes": [
"https://www.googleapis.com/auth/admob.readonly",
"https://www.googleapis.com/auth/admob.report"
],
"streamingType": "NONE"
},
"list": {
"description": "Lists the AdMob publisher account that was most recently signed in to from the AdMob UI. For more information, see https://support.google.com/admob/answer/10243672.",
"flatPath": "v1beta/accounts",
"httpMethod": "GET",
"id": "admob.accounts.list",
"parameterOrder": [],
"parameters": {
"pageSize": {
"description": "Maximum number of accounts to return.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The value returned by the last `ListPublisherAccountsResponse`; indicates that this is a continuation of a prior `ListPublisherAccounts` call, and that the system should return the next page of data.",
"location": "query",
"type": "string"
}
},
"path": "v1beta/accounts",
"response": {
"$ref": "ListPublisherAccountsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/admob.readonly",
"https://www.googleapis.com/auth/admob.report"
],
"streamingType": "NONE"
}
},
"resources": {
"adSources": {
"methods": {
"list": {
"description": "List the ad sources.",
"flatPath": "v1beta/accounts/{accountsId}/adSources",
"httpMethod": "GET",
"id": "admob.accounts.adSources.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "The maximum number of ad sources to return. If unspecified or 0, at most 10,000 ad sources will be returned. The maximum value is 20,000; values above 10,000 will be coerced to 20,000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A page token, received from a previous `ListAdSources` call. Provide this to retrieve the subsequent page.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent which owns this collection of ad sources. Format: accounts/{publisher_id}",
"location": "path",
"pattern": "^accounts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/adSources",
"response": {
"$ref": "ListAdSourcesResponse"
},
"streamingType": "NONE"
}
}
},
"adUnits": {
"methods": {
"list": {
"description": "List the ad units under the specified AdMob account.",
"flatPath": "v1beta/accounts/{accountsId}/adUnits",
"httpMethod": "GET",
"id": "admob.accounts.adUnits.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "The maximum number of ad units to return. If unspecified or 0, at most 10,000 ad units will be returned. The maximum value is 20,000; values above 20,000 will be coerced to 20,000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The value returned by the last `ListAdUnitsResponse`; indicates that this is a continuation of a prior `ListAdUnits` call, and that the system should return the next page of data.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Resource name of the account to list ad units for. Example: accounts/pub-9876543210987654",
"location": "path",
"pattern": "^accounts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/adUnits",
"response": {
"$ref": "ListAdUnitsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/admob.readonly"
],
"streamingType": "NONE"
}
}
},
"apps": {
"methods": {
"list": {
"description": "List the apps under the specified AdMob account.",
"flatPath": "v1beta/accounts/{accountsId}/apps",
"httpMethod": "GET",
"id": "admob.accounts.apps.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "The maximum number of apps to return. If unspecified or 0, at most 10,000 apps will be returned. The maximum value is 20,000; values above 20,000 will be coerced to 20,000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The value returned by the last `ListAppsResponse`; indicates that this is a continuation of a prior `ListApps` call, and that the system should return the next page of data.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Resource name of the account to list apps for. Example: accounts/pub-9876543210987654",
"location": "path",
"pattern": "^accounts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/apps",
"response": {
"$ref": "ListAppsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/admob.readonly"
],
"streamingType": "NONE"
}
}
},
"mediationReport": {
"methods": {
"generate": {
"description": "Generates an AdMob mediation report based on the provided report specification. Returns result of a server-side streaming RPC. The result is returned in a sequence of responses.",
"flatPath": "v1beta/accounts/{accountsId}/mediationReport:generate",
"httpMethod": "POST",
"id": "admob.accounts.mediationReport.generate",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Resource name of the account to generate the report for. Example: accounts/pub-9876543210987654",
"location": "path",
"pattern": "^accounts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/mediationReport:generate",
"request": {
"$ref": "GenerateMediationReportRequest"
},
"response": {
"$ref": "GenerateMediationReportResponse"
},
"scopes": [
"https://www.googleapis.com/auth/admob.readonly",
"https://www.googleapis.com/auth/admob.report"
],
"streamingType": "SERVER_SIDE"
}
}
},
"networkReport": {
"methods": {
"generate": {
"description": "Generates an AdMob Network report based on the provided report specification. Returns result of a server-side streaming RPC. The result is returned in a sequence of responses.",
"flatPath": "v1beta/accounts/{accountsId}/networkReport:generate",
"httpMethod": "POST",
"id": "admob.accounts.networkReport.generate",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Resource name of the account to generate the report for. Example: accounts/pub-9876543210987654",
"location": "path",
"pattern": "^accounts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/networkReport:generate",
"request": {
"$ref": "GenerateNetworkReportRequest"
},
"response": {
"$ref": "GenerateNetworkReportResponse"
},
"scopes": [
"https://www.googleapis.com/auth/admob.readonly",
"https://www.googleapis.com/auth/admob.report"
],
"streamingType": "SERVER_SIDE"
}
}
}
}
}
},
"revision": "20230425",
"rootUrl": "https://admob.googleapis.com/",
"schemas": {
"AdSource": {
"description": "Definition of a mediation ad source.",
"id": "AdSource",
"properties": {
"adSourceId": {
"description": "ID of this ad source.",
"type": "string"
},
"name": {
"description": "Resource name of this ad source. Format is: accounts/{publisher_id}/adSources/{ad_source_id}",
"type": "string"
},
"title": {
"description": "Display name of this ad source.",
"type": "string"
}
},
"type": "object"
},
"AdUnit": {
"description": "Describes an AdMob ad unit.",
"id": "AdUnit",
"properties": {
"adFormat": {
"description": "AdFormat of the ad unit. Possible values are as follows: \"APP_OPEN\" - App Open ad format. \"BANNER\" - Banner ad format. \"BANNER_INTERSTITIAL\" - Legacy format that can be used as either banner or interstitial. This format can no longer be created but can be targeted by mediation groups. \"INTERSTITIAL\" - A full screen ad. Supported ad types are \"RICH_MEDIA\" and \"VIDEO\". \"NATIVE\" - Native ad format. \"REWARDED\" - An ad that, once viewed, gets a callback verifying the view so that a reward can be given to the user. Supported ad types are \"RICH_MEDIA\" (interactive) and video where video can not be excluded. \"REWARDED_INTERSTITIAL\" - Rewarded Interstitial ad format. Only supports video ad type. See https://support.google.com/admob/answer/9884467.",
"type": "string"
},
"adTypes": {
"description": "Ad media type supported by this ad unit. Possible values as follows: \"RICH_MEDIA\" - Text, image, and other non-video media. \"VIDEO\" - Video media.",
"items": {
"type": "string"
},
"type": "array"
},
"adUnitId": {
"description": "The externally visible ID of the ad unit which can be used to integrate with the AdMob SDK. This is a read only property. Example: ca-app-pub-9876543210987654/0123456789",
"type": "string"
},
"appId": {
"description": "The externally visible ID of the app this ad unit is associated with. Example: ca-app-pub-9876543210987654~0123456789",
"type": "string"
},
"displayName": {
"description": "The display name of the ad unit as shown in the AdMob UI, which is provided by the user. The maximum length allowed is 80 characters.",
"type": "string"
},
"name": {
"description": "Resource name for this ad unit. Format is accounts/{publisher_id}/adUnits/{ad_unit_id_fragment} Example: accounts/pub-9876543210987654/adUnits/0123456789",
"type": "string"
}
},
"type": "object"
},
"App": {
"description": "Describes an AdMob app for a specific platform (For example: Android or iOS).",
"id": "App",
"properties": {
"appApprovalState": {
"description": "Output only. The approval state for the app. The field is read-only.",
"enum": [
"APP_APPROVAL_STATE_UNSPECIFIED",
"ACTION_REQUIRED",
"IN_REVIEW",
"APPROVED"
],
"enumDescriptions": [
"Default value for an unset field. Do not use.",
"The app requires additional user action to be approved. Please refer to https://support.google.com/admob/answer/10564477 for details and next steps.",
"The app is pending review.",
"The app is approved and can serve ads."
],
"readOnly": true,
"type": "string"
},
"appId": {
"description": "The externally visible ID of the app which can be used to integrate with the AdMob SDK. This is a read only property. Example: ca-app-pub-9876543210987654~0123456789",
"type": "string"
},
"linkedAppInfo": {
"$ref": "AppLinkedAppInfo",
"description": "Immutable. The information for an app that is linked to an app store. This field is present if and only if the app is linked to an app store."
},
"manualAppInfo": {
"$ref": "AppManualAppInfo",
"description": "The information for an app that is not linked to any app store. After an app is linked, this information is still retrivable. If no name is provided for the app upon creation, a placeholder name will be used."
},
"name": {
"description": "Resource name for this app. Format is accounts/{publisher_id}/apps/{app_id_fragment} Example: accounts/pub-9876543210987654/apps/0123456789",
"type": "string"
},
"platform": {
"description": "Describes the platform of the app. Limited to \"IOS\" and \"ANDROID\".",
"type": "string"
}
},
"type": "object"
},
"AppLinkedAppInfo": {
"description": "Information from the app store if the app is linked to an app store.",
"id": "AppLinkedAppInfo",
"properties": {
"appStoreId": {
"description": "The app store ID of the app; present if and only if the app is linked to an app store. If the app is added to the Google Play store, it will be the application ID of the app. For example: \"com.example.myapp\". See https://developer.android.com/studio/build/application-id. If the app is added to the Apple App Store, it will be app store ID. For example \"105169111\". Note that setting the app store id is considered an irreversible action. Once an app is linked, it cannot be unlinked.",
"type": "string"
},
"displayName": {
"description": "Output only. Display name of the app as it appears in the app store. This is an output-only field, and may be empty if the app cannot be found in the store.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"AppManualAppInfo": {
"description": "Information provided for manual apps which are not linked to an application store (Example: Google Play, App Store).",
"id": "AppManualAppInfo",
"properties": {
"displayName": {
"description": "The display name of the app as shown in the AdMob UI, which is provided by the user. The maximum length allowed is 80 characters.",
"type": "string"
}
},
"type": "object"
},
"Date": {
"description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp",
"id": "Date",
"properties": {
"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",
"type": "integer"
},
"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",
"type": "integer"
},
"year": {
"description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"DateRange": {
"description": "Specification of a single date range. Both dates are inclusive.",
"id": "DateRange",
"properties": {
"endDate": {
"$ref": "Date",
"description": "End date of the date range, inclusive. Must be greater than or equal to the start date."
},
"startDate": {
"$ref": "Date",
"description": "Start date of the date range, inclusive. Must be less than or equal to the end date."
}
},
"type": "object"
},
"GenerateMediationReportRequest": {
"description": "Request to generate an AdMob mediation report.",
"id": "GenerateMediationReportRequest",
"properties": {
"reportSpec": {
"$ref": "MediationReportSpec",
"description": "Network report specification."
}
},
"type": "object"
},
"GenerateMediationReportResponse": {
"description": "The streaming response for the AdMob mediation report where the first response contains the report header, then a stream of row responses, and finally a footer as the last response message. For example: [{ \"header\": { \"date_range\": { \"start_date\": {\"year\": 2018, \"month\": 9, \"day\": 1}, \"end_date\": {\"year\": 2018, \"month\": 9, \"day\": 1} }, \"localization_settings\": { \"currency_code\": \"USD\", \"language_code\": \"en-US\" } } }, { \"row\": { \"dimension_values\": { \"DATE\": {\"value\": \"20180918\"}, \"APP\": { \"value\": \"ca-app-pub-8123415297019784~1001342552\", \"display_label\": \"My app name!\" } }, \"metric_values\": { \"ESTIMATED_EARNINGS\": {\"decimal_value\": \"1324746\"} } } }, { \"footer\": {\"matching_row_count\": 1} }]",
"id": "GenerateMediationReportResponse",
"properties": {
"footer": {
"$ref": "ReportFooter",
"description": "Additional information about the generated report, such as warnings about the data."
},
"header": {
"$ref": "ReportHeader",
"description": "Report generation settings that describes the report contents, such as the report date range and localization settings."
},
"row": {
"$ref": "ReportRow",
"description": "Actual report data."
}
},
"type": "object"
},
"GenerateNetworkReportRequest": {
"description": "Request to generate an AdMob Network report.",
"id": "GenerateNetworkReportRequest",
"properties": {
"reportSpec": {
"$ref": "NetworkReportSpec",
"description": "Network report specification."
}
},
"type": "object"
},
"GenerateNetworkReportResponse": {
"description": "The streaming response for the AdMob Network report where the first response contains the report header, then a stream of row responses, and finally a footer as the last response message. For example: [{ \"header\": { \"dateRange\": { \"startDate\": {\"year\": 2018, \"month\": 9, \"day\": 1}, \"endDate\": {\"year\": 2018, \"month\": 9, \"day\": 1} }, \"localizationSettings\": { \"currencyCode\": \"USD\", \"languageCode\": \"en-US\" } } }, { \"row\": { \"dimensionValues\": { \"DATE\": {\"value\": \"20180918\"}, \"APP\": { \"value\": \"ca-app-pub-8123415297019784~1001342552\", displayLabel: \"My app name!\" } }, \"metricValues\": { \"ESTIMATED_EARNINGS\": {\"microsValue\": 6500000} } } }, { \"footer\": {\"matchingRowCount\": 1} }]",
"id": "GenerateNetworkReportResponse",
"properties": {
"footer": {
"$ref": "ReportFooter",
"description": "Additional information about the generated report, such as warnings about the data."
},
"header": {
"$ref": "ReportHeader",
"description": "Report generation settings that describes the report contents, such as the report date range and localization settings."
},
"row": {
"$ref": "ReportRow",
"description": "Actual report data."
}
},
"type": "object"
},
"ListAdSourcesResponse": {
"description": "Response for the ListAdSourcesRequest.",
"id": "ListAdSourcesResponse",
"properties": {
"adSources": {
"description": "The ad sources.",
"items": {
"$ref": "AdSource"
},
"type": "array"
},
"nextPageToken": {
"description": "Used to set the `page_token` in the `ListAdSourcesRequest` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
"type": "string"
}
},
"type": "object"
},
"ListAdUnitsResponse": {
"description": "Response for the ad units list request.",
"id": "ListAdUnitsResponse",
"properties": {
"adUnits": {
"description": "The resulting ad units for the requested account.",
"items": {
"$ref": "AdUnit"
},
"type": "array"
},
"nextPageToken": {
"description": "If not empty, indicates that there may be more ad units for the request; this value should be passed in a new `ListAdUnitsRequest`.",
"type": "string"
}
},
"type": "object"
},
"ListAppsResponse": {
"description": "Response for the apps list request.",
"id": "ListAppsResponse",
"properties": {
"apps": {
"description": "The resulting apps for the requested account.",
"items": {
"$ref": "App"
},
"type": "array"
},
"nextPageToken": {
"description": "If not empty, indicates that there may be more apps for the request; this value should be passed in a new `ListAppsRequest`.",
"type": "string"
}
},
"type": "object"
},
"ListPublisherAccountsResponse": {
"description": "Response for the publisher account list request.",
"id": "ListPublisherAccountsResponse",
"properties": {
"account": {
"description": "Publisher that the client credentials can access.",
"items": {
"$ref": "PublisherAccount"
},
"type": "array"
},
"nextPageToken": {
"description": "If not empty, indicates that there might be more accounts for the request; you must pass this value in a new `ListPublisherAccountsRequest`.",
"type": "string"
}
},
"type": "object"
},
"LocalizationSettings": {
"description": "Localization settings for reports, such as currency and language. It affects how metrics are calculated.",
"id": "LocalizationSettings",
"properties": {
"currencyCode": {
"description": "Currency code of the earning related metrics, which is the 3-letter code defined in ISO 4217. The daily average rate is used for the currency conversion. Defaults to the account currency code if unspecified.",
"type": "string"
},
"languageCode": {
"description": "Language used for any localized text, such as some dimension value display labels. The language tag defined in the IETF BCP47. Defaults to 'en-US' if unspecified.",
"type": "string"
}
},
"type": "object"
},
"MediationReportSpec": {
"description": "The specification for generating an AdMob Mediation report. For example, the specification to get observed ECPM sliced by ad source and app for the 'US' and 'CN' countries can look like the following example: { \"date_range\": { \"start_date\": {\"year\": 2021, \"month\": 9, \"day\": 1}, \"end_date\": {\"year\": 2021, \"month\": 9, \"day\": 30} }, \"dimensions\": [\"AD_SOURCE\", \"APP\", \"COUNTRY\"], \"metrics\": [\"OBSERVED_ECPM\"], \"dimension_filters\": [ { \"dimension\": \"COUNTRY\", \"matches_any\": {\"values\": [{\"value\": \"US\", \"value\": \"CN\"}]} } ], \"sort_conditions\": [ {\"dimension\":\"APP\", order: \"ASCENDING\"} ], \"localization_settings\": { \"currency_code\": \"USD\", \"language_code\": \"en-US\" } } For a better understanding, you can treat the preceding specification like the following pseudo SQL: SELECT AD_SOURCE, APP, COUNTRY, OBSERVED_ECPM FROM MEDIATION_REPORT WHERE DATE \u003e= '2021-09-01' AND DATE \u003c= '2021-09-30' AND COUNTRY IN ('US', 'CN') GROUP BY AD_SOURCE, APP, COUNTRY ORDER BY APP ASC;",
"id": "MediationReportSpec",
"properties": {
"dateRange": {
"$ref": "DateRange",
"description": "The date range for which the report is generated."
},
"dimensionFilters": {
"description": "Describes which report rows to match based on their dimension values.",
"items": {
"$ref": "MediationReportSpecDimensionFilter"
},
"type": "array"
},
"dimensions": {
"description": "List of dimensions of the report. The value combination of these dimensions determines the row of the report. If no dimensions are specified, the report returns a single row of requested metrics for the entire account.",
"items": {
"enum": [
"DIMENSION_UNSPECIFIED",
"DATE",
"MONTH",
"WEEK",
"AD_SOURCE",
"AD_SOURCE_INSTANCE",
"AD_UNIT",
"APP",
"MEDIATION_GROUP",
"COUNTRY",
"FORMAT",
"PLATFORM",
"MOBILE_OS_VERSION",
"GMA_SDK_VERSION",
"APP_VERSION_NAME",
"SERVING_RESTRICTION"
],
"enumDescriptions": [
"Default value for an unset field. Do not use.",
"A date in the YYYYMMDD format (for example, \"20210701\"). Requests can specify at most one time dimension.",
"A month in the YYYYMM format (for example, \"202107\"). Requests can specify at most one time dimension.",
"The date of the first day of a week in the YYYYMMDD format (for example, \"20210701\"). Requests can specify at most one time dimension.",
"The [unique ID of the ad source](/admob/api/v1/ad_sources) (for example, \"5450213213286189855\" and \"AdMob Network\" as label value).",
"The unique ID of the ad source instance (for example, \"ca-app-pub-1234:asi:5678\" and \"AdMob (default)\" as label value).",
"The unique ID of the ad unit (for example, \"ca-app-pub-1234/8790\"). If AD_UNIT dimension is specified, then APP is included automatically.",
"The unique ID of the mobile application (for example, \"ca-app-pub-1234~1234\").",
"The unique ID of the mediation group (for example, \"ca-app-pub-1234:mg:1234\" and \"AdMob (default)\" as label value).",
"CLDR country code of the place where the ad views/clicks occur (for example, \"US\" or \"FR\"). This is a geography dimension.",
"Format of the ad unit (for example, \"banner\", \"native\"), an ad delivery dimension.",
"Mobile OS platform of the app (for example, \"Android\" or \"iOS\").",
"Mobile operating system version, e.g. \"iOS 13.5.1\".",
"GMA SDK version, e.g. \"iOS 7.62.0\".",
"For Android, the app version name can be found in versionName in PackageInfo. For iOS, the app version name can be found in CFBundleShortVersionString.",
"Restriction mode for ads serving (e.g. \"Non-personalized ads\")."
],
"type": "string"
},
"type": "array"
},
"localizationSettings": {
"$ref": "LocalizationSettings",
"description": "Localization settings of the report."
},
"maxReportRows": {
"description": "Maximum number of report data rows to return. If the value is not set, the API returns as many rows as possible, up to 100000. Acceptable values are 1-100000, inclusive. Values larger than 100000 return an error.",
"format": "int32",
"type": "integer"
},
"metrics": {
"description": "List of metrics of the report. A report must specify at least one metric.",
"items": {
"enum": [
"METRIC_UNSPECIFIED",
"AD_REQUESTS",
"CLICKS",
"ESTIMATED_EARNINGS",
"IMPRESSIONS",
"IMPRESSION_CTR",
"MATCHED_REQUESTS",
"MATCH_RATE",
"OBSERVED_ECPM"
],
"enumDescriptions": [
"Default value for an unset field. Do not use.",
"The number of requests. The value is an integer.",
"The number of times a user clicks an ad. The value is an integer.",
"The estimated earnings of the AdMob publisher. The currency unit (USD, EUR, or other) of the earning metrics are determined by the localization setting for currency. The amount is in micros. For example, $6.50 would be represented as 6500000. Estimated earnings per mediation group and per ad source instance level is supported dating back to October 20, 2019. Third-party estimated earnings will show 0 for dates prior to October 20, 2019.",
"The total number of ads shown to users. The value is an integer.",
"The ratio of clicks over impressions. The value is a double precision (approximate) decimal value.",
"The number of times ads are returned in response to a request. The value is an integer.",
"The ratio of matched ad requests over the total ad requests. The value is a double precision (approximate) decimal value.",
"The third-party ad network's estimated average eCPM. The currency unit (USD, EUR, or other) of the earning metrics are determined by the localization setting for currency. The amount is in micros. For example, $2.30 would be represented as 2300000. The estimated average eCPM per mediation group and per ad source instance level is supported dating back to October 20, 2019. Third-party estimated average eCPM will show 0 for dates prior to October 20, 2019."
],
"type": "string"
},
"type": "array"
},
"sortConditions": {
"description": "Describes the sorting of report rows. The order of the condition in the list defines its precedence; the earlier the condition, the higher its precedence. If no sort conditions are specified, the row ordering is undefined.",
"items": {
"$ref": "MediationReportSpecSortCondition"
},
"type": "array"
},
"timeZone": {
"description": "A report time zone. Accepts an IANA TZ name values, such as \"America/Los_Angeles.\" If no time zone is defined, the account default takes effect. Check default value by the get account action. **Warning:** The \"America/Los_Angeles\" is the only supported value at the moment.",
"type": "string"
}
},
"type": "object"
},
"MediationReportSpecDimensionFilter": {
"description": "Describes which report rows to match based on their dimension values.",
"id": "MediationReportSpecDimensionFilter",
"properties": {
"dimension": {
"description": "Applies the filter criterion to the specified dimension.",
"enum": [
"DIMENSION_UNSPECIFIED",
"DATE",
"MONTH",
"WEEK",
"AD_SOURCE",
"AD_SOURCE_INSTANCE",
"AD_UNIT",
"APP",
"MEDIATION_GROUP",
"COUNTRY",
"FORMAT",
"PLATFORM",
"MOBILE_OS_VERSION",
"GMA_SDK_VERSION",
"APP_VERSION_NAME",
"SERVING_RESTRICTION"
],
"enumDescriptions": [
"Default value for an unset field. Do not use.",
"A date in the YYYYMMDD format (for example, \"20210701\"). Requests can specify at most one time dimension.",
"A month in the YYYYMM format (for example, \"202107\"). Requests can specify at most one time dimension.",
"The date of the first day of a week in the YYYYMMDD format (for example, \"20210701\"). Requests can specify at most one time dimension.",
"The [unique ID of the ad source](/admob/api/v1/ad_sources) (for example, \"5450213213286189855\" and \"AdMob Network\" as label value).",
"The unique ID of the ad source instance (for example, \"ca-app-pub-1234:asi:5678\" and \"AdMob (default)\" as label value).",
"The unique ID of the ad unit (for example, \"ca-app-pub-1234/8790\"). If AD_UNIT dimension is specified, then APP is included automatically.",
"The unique ID of the mobile application (for example, \"ca-app-pub-1234~1234\").",
"The unique ID of the mediation group (for example, \"ca-app-pub-1234:mg:1234\" and \"AdMob (default)\" as label value).",
"CLDR country code of the place where the ad views/clicks occur (for example, \"US\" or \"FR\"). This is a geography dimension.",
"Format of the ad unit (for example, \"banner\", \"native\"), an ad delivery dimension.",
"Mobile OS platform of the app (for example, \"Android\" or \"iOS\").",
"Mobile operating system version, e.g. \"iOS 13.5.1\".",
"GMA SDK version, e.g. \"iOS 7.62.0\".",
"For Android, the app version name can be found in versionName in PackageInfo. For iOS, the app version name can be found in CFBundleShortVersionString.",
"Restriction mode for ads serving (e.g. \"Non-personalized ads\")."
],
"type": "string"
},
"matchesAny": {
"$ref": "StringList",
"description": "Matches a row if its value for the specified dimension is in one of the values specified in this condition."
}
},
"type": "object"
},
"MediationReportSpecSortCondition": {
"description": "Sorting direction to be applied on a dimension or a metric.",
"id": "MediationReportSpecSortCondition",
"properties": {
"dimension": {
"description": "Sort by the specified dimension.",
"enum": [
"DIMENSION_UNSPECIFIED",
"DATE",
"MONTH",
"WEEK",
"AD_SOURCE",
"AD_SOURCE_INSTANCE",
"AD_UNIT",
"APP",
"MEDIATION_GROUP",
"COUNTRY",
"FORMAT",
"PLATFORM",
"MOBILE_OS_VERSION",
"GMA_SDK_VERSION",
"APP_VERSION_NAME",
"SERVING_RESTRICTION"
],
"enumDescriptions": [
"Default value for an unset field. Do not use.",
"A date in the YYYYMMDD format (for example, \"20210701\"). Requests can specify at most one time dimension.",
"A month in the YYYYMM format (for example, \"202107\"). Requests can specify at most one time dimension.",
"The date of the first day of a week in the YYYYMMDD format (for example, \"20210701\"). Requests can specify at most one time dimension.",
"The [unique ID of the ad source](/admob/api/v1/ad_sources) (for example, \"5450213213286189855\" and \"AdMob Network\" as label value).",
"The unique ID of the ad source instance (for example, \"ca-app-pub-1234:asi:5678\" and \"AdMob (default)\" as label value).",
"The unique ID of the ad unit (for example, \"ca-app-pub-1234/8790\"). If AD_UNIT dimension is specified, then APP is included automatically.",
"The unique ID of the mobile application (for example, \"ca-app-pub-1234~1234\").",
"The unique ID of the mediation group (for example, \"ca-app-pub-1234:mg:1234\" and \"AdMob (default)\" as label value).",
"CLDR country code of the place where the ad views/clicks occur (for example, \"US\" or \"FR\"). This is a geography dimension.",
"Format of the ad unit (for example, \"banner\", \"native\"), an ad delivery dimension.",
"Mobile OS platform of the app (for example, \"Android\" or \"iOS\").",
"Mobile operating system version, e.g. \"iOS 13.5.1\".",
"GMA SDK version, e.g. \"iOS 7.62.0\".",
"For Android, the app version name can be found in versionName in PackageInfo. For iOS, the app version name can be found in CFBundleShortVersionString.",
"Restriction mode for ads serving (e.g. \"Non-personalized ads\")."
],
"type": "string"
},
"metric": {
"description": "Sort by the specified metric.",
"enum": [
"METRIC_UNSPECIFIED",
"AD_REQUESTS",
"CLICKS",
"ESTIMATED_EARNINGS",
"IMPRESSIONS",
"IMPRESSION_CTR",
"MATCHED_REQUESTS",
"MATCH_RATE",
"OBSERVED_ECPM"
],
"enumDescriptions": [
"Default value for an unset field. Do not use.",
"The number of requests. The value is an integer.",
"The number of times a user clicks an ad. The value is an integer.",
"The estimated earnings of the AdMob publisher. The currency unit (USD, EUR, or other) of the earning metrics are determined by the localization setting for currency. The amount is in micros. For example, $6.50 would be represented as 6500000. Estimated earnings per mediation group and per ad source instance level is supported dating back to October 20, 2019. Third-party estimated earnings will show 0 for dates prior to October 20, 2019.",
"The total number of ads shown to users. The value is an integer.",
"The ratio of clicks over impressions. The value is a double precision (approximate) decimal value.",
"The number of times ads are returned in response to a request. The value is an integer.",
"The ratio of matched ad requests over the total ad requests. The value is a double precision (approximate) decimal value.",
"The third-party ad network's estimated average eCPM. The currency unit (USD, EUR, or other) of the earning metrics are determined by the localization setting for currency. The amount is in micros. For example, $2.30 would be represented as 2300000. The estimated average eCPM per mediation group and per ad source instance level is supported dating back to October 20, 2019. Third-party estimated average eCPM will show 0 for dates prior to October 20, 2019."
],
"type": "string"
},
"order": {
"description": "Sorting order of the dimension or metric.",
"enum": [
"SORT_ORDER_UNSPECIFIED",
"ASCENDING",
"DESCENDING"
],
"enumDescriptions": [
"Default value for an unset field. Do not use.",
"Sort dimension value or metric value in ascending order.",
"Sort dimension value or metric value in descending order."
],
"type": "string"
}
},
"type": "object"
},
"NetworkReportSpec": {
"description": "The specification for generating an AdMob Network report. For example, the specification to get clicks and estimated earnings for only the 'US' and 'CN' countries can look like the following example: { 'date_range': { 'start_date': {'year': 2021, 'month': 9, 'day': 1}, 'end_date': {'year': 2021, 'month': 9, 'day': 30} }, 'dimensions': ['DATE', 'APP', 'COUNTRY'], 'metrics': ['CLICKS', 'ESTIMATED_EARNINGS'], 'dimension_filters': [ { 'dimension': 'COUNTRY', 'matches_any': {'values': [{'value': 'US', 'value': 'CN'}]} } ], 'sort_conditions': [ {'dimension':'APP', order: 'ASCENDING'}, {'metric':'CLICKS', order: 'DESCENDING'} ], 'localization_settings': { 'currency_code': 'USD', 'language_code': 'en-US' } } For a better understanding, you can treat the preceding specification like the following pseudo SQL: SELECT DATE, APP, COUNTRY, CLICKS, ESTIMATED_EARNINGS FROM NETWORK_REPORT WHERE DATE \u003e= '2021-09-01' AND DATE \u003c= '2021-09-30' AND COUNTRY IN ('US', 'CN') GROUP BY DATE, APP, COUNTRY ORDER BY APP ASC, CLICKS DESC;",
"id": "NetworkReportSpec",
"properties": {
"dateRange": {
"$ref": "DateRange",
"description": "The date range for which the report is generated."
},
"dimensionFilters": {
"description": "Describes which report rows to match based on their dimension values.",
"items": {
"$ref": "NetworkReportSpecDimensionFilter"
},
"type": "array"
},
"dimensions": {
"description": "List of dimensions of the report. The value combination of these dimensions determines the row of the report. If no dimensions are specified, the report returns a single row of requested metrics for the entire account.",
"items": {
"enum": [
"DIMENSION_UNSPECIFIED",
"DATE",
"MONTH",
"WEEK",
"AD_UNIT",
"APP",
"AD_TYPE",
"COUNTRY",
"FORMAT",
"PLATFORM",
"MOBILE_OS_VERSION",
"GMA_SDK_VERSION",
"APP_VERSION_NAME",
"SERVING_RESTRICTION"
],
"enumDescriptions": [
"Default value for an unset field. Do not use.",
"A date in the YYYYMMDD format (for example, \"20210701\"). Requests can specify at most one time dimension.",
"A month in the YYYYMM format (for example, \"202107\"). Requests can specify at most one time dimension.",
"The date of the first day of a week in the YYYYMMDD format (for example, \"20210701\"). Requests can specify at most one time dimension.",
"The unique ID of the ad unit (for example, \"ca-app-pub-1234/1234\"). If AD_UNIT dimension is specified, then APP is included automatically.",
"The unique ID of the mobile application (for example, \"ca-app-pub-1234~1234\").",
"Type of the ad (for example, \"text\" or \"image\"), an ad delivery dimension. **Warning:** The dimension is incompatible with [AD_REQUESTS](#Metric.ENUM_VALUES.AD_REQUESTS), [MATCH_RATE](#Metric.ENUM_VALUES.MATCH_RATE) and [IMPRESSION_RPM](#Metric.ENUM_VALUES.IMPRESSION_RPM) metrics.",
"CLDR country code of the place where the ad views/clicks occur (for example, \"US\" or \"FR\"). This is a geography dimension.",
"Format of the ad unit (for example, \"banner\", \"native\"), an ad delivery dimension.",
"Mobile OS platform of the app (for example, \"Android\" or \"iOS\").",
"Mobile operating system version, e.g. \"iOS 13.5.1\".",
"GMA SDK version, e.g. \"iOS 7.62.0\".",
"For Android, the app version name can be found in versionName in PackageInfo. For iOS, the app version name can be found in CFBundleShortVersionString.",
"Restriction mode for ads serving (e.g. \"Non-personalized ads\")."
],
"type": "string"
},
"type": "array"
},
"localizationSettings": {
"$ref": "LocalizationSettings",
"description": "Localization settings of the report."
},
"maxReportRows": {
"description": "Maximum number of report data rows to return. If the value is not set, the API returns as many rows as possible, up to 100000. Acceptable values are 1-100000, inclusive. Values larger than 100000 return an error.",
"format": "int32",
"type": "integer"
},
"metrics": {
"description": "List of metrics of the report. A report must specify at least one metric.",
"items": {
"enum": [
"METRIC_UNSPECIFIED",
"AD_REQUESTS",
"CLICKS",
"ESTIMATED_EARNINGS",
"IMPRESSIONS",
"IMPRESSION_CTR",
"IMPRESSION_RPM",
"MATCHED_REQUESTS",
"MATCH_RATE",
"SHOW_RATE"
],
"enumDescriptions": [
"Default value for an unset field. Do not use.",