-
Notifications
You must be signed in to change notification settings - Fork 1.2k
/
admob-api.json
2383 lines (2383 loc) · 115 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"
},
"scopes": [
"https://www.googleapis.com/auth/admob.readonly",
"https://www.googleapis.com/auth/admob.report"
],
"streamingType": "NONE"
}
},
"resources": {
"adapters": {
"methods": {
"list": {
"description": "List the adapters of the ad source.",
"flatPath": "v1beta/accounts/{accountsId}/adSources/{adSourcesId}/adapters",
"httpMethod": "GET",
"id": "admob.accounts.adSources.adapters.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "The maximum number of adapters to return. If unspecified or 0, at most 10,000 adapters 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": "A page token, received from a previous `ListAdapters` call. Provide this to retrieve the subsequent page.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent which owns this collection of adapters. Format: accounts/{publisher_id}/adSources/{ad_source_id}",
"location": "path",
"pattern": "^accounts/[^/]+/adSources/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/adapters",
"response": {
"$ref": "ListAdaptersResponse"
},
"scopes": [
"https://www.googleapis.com/auth/admob.readonly"
],
"streamingType": "NONE"
}
}
}
}
},
"adUnitMappings": {
"methods": {
"batchCreate": {
"description": "Batch create the ad unit mappings under the specific AdMob account. The maximum allowed batch size is 100. This method has limited access. If you see a 403 permission denied error, please reach out to your account manager for access.",
"flatPath": "v1beta/accounts/{accountsId}/adUnitMappings:batchCreate",
"httpMethod": "POST",
"id": "admob.accounts.adUnitMappings.batchCreate",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The AdMob account which owns this collection of ad unit mappings. Format: accounts/{publisher_id} See https://support.google.com/admob/answer/2784578 for instructions on how to find your AdMob publisher ID.",
"location": "path",
"pattern": "^accounts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/adUnitMappings:batchCreate",
"request": {
"$ref": "BatchCreateAdUnitMappingsRequest"
},
"response": {
"$ref": "BatchCreateAdUnitMappingsResponse"
},
"streamingType": "NONE"
}
}
},
"adUnits": {
"methods": {
"create": {
"description": "Creates an ad unit under the specified AdMob account. This method has limited access. If you see a 403 permission denied error, please reach out to your account manager for access.",
"flatPath": "v1beta/accounts/{accountsId}/adUnits",
"httpMethod": "POST",
"id": "admob.accounts.adUnits.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Resource name of the account to create the specified ad unit for. Example: accounts/pub-9876543210987654",
"location": "path",
"pattern": "^accounts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/adUnits",
"request": {
"$ref": "AdUnit"
},
"response": {
"$ref": "AdUnit"
},
"streamingType": "NONE"
},
"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"
}
},
"resources": {
"adUnitMappings": {
"methods": {
"create": {
"description": "Create an ad unit mapping under the specific AdMob account and ad unit. This method has limited access. If you see a 403 permission denied error, please reach out to your account manager for access.",
"flatPath": "v1beta/accounts/{accountsId}/adUnits/{adUnitsId}/adUnitMappings",
"httpMethod": "POST",
"id": "admob.accounts.adUnits.adUnitMappings.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent which owns the ad unit mapping. Format: accounts/{publisher_id}/adUnits/{ad_unit_id}",
"location": "path",
"pattern": "^accounts/[^/]+/adUnits/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/adUnitMappings",
"request": {
"$ref": "AdUnitMapping"
},
"response": {
"$ref": "AdUnitMapping"
},
"streamingType": "NONE"
},
"list": {
"description": "List ad unit mappings under the specified AdMob account and ad unit. This method has limited access. If you see a 403 permission denied error, please reach out to your account manager for access.",
"flatPath": "v1beta/accounts/{accountsId}/adUnits/{adUnitsId}/adUnitMappings",
"httpMethod": "GET",
"id": "admob.accounts.adUnits.adUnitMappings.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "The filter string that uses [EBNF grammar syntax](https://google.aip.dev/assets/misc/ebnf-filtering.txt). Possible field to filter by is: - \"DISPLAY_NAME\" Possible filter function is: - `IN`: Used to filter fields that represent a singleton including \"DISPLAY_NAME\". The filter functions can be added together using `AND`. `OR` functionality is not supported. Example: filter: IN(DISPLAY_NAME, \"Test Ad Unit Mapping 1\", \"Test Ad Unit Mapping 2\")",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "The maximum number of ad unit mappings to return. If unspecified or 0, at most 10,000 ad unit mappings 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": "A page token, received from a previous `ListAdUnitMappings` call. Provide this to retrieve the subsequent page.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent which owns this collection of ad unit mappings. Format: accounts/{publisher_id}/adUnits/{ad_unit_id}",
"location": "path",
"pattern": "^accounts/[^/]+/adUnits/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/adUnitMappings",
"response": {
"$ref": "ListAdUnitMappingsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/admob.readonly"
],
"streamingType": "NONE"
}
}
}
}
},
"apps": {
"methods": {
"create": {
"description": "Creates an app under the specified AdMob account. This method has limited access. If you see a 403 permission denied error, please reach out to your account manager for access.",
"flatPath": "v1beta/accounts/{accountsId}/apps",
"httpMethod": "POST",
"id": "admob.accounts.apps.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Resource name of the account for which the app is being created. Example: accounts/pub-9876543210987654",
"location": "path",
"pattern": "^accounts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/apps",
"request": {
"$ref": "App"
},
"response": {
"$ref": "App"
},
"streamingType": "NONE"
},
"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"
}
}
},
"campaignReport": {
"methods": {
"generate": {
"description": "Generates Campaign Report based on provided specifications.",
"flatPath": "v1beta/accounts/{accountsId}/campaignReport:generate",
"httpMethod": "POST",
"id": "admob.accounts.campaignReport.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}/campaignReport:generate",
"request": {
"$ref": "GenerateCampaignReportRequest"
},
"response": {
"$ref": "GenerateCampaignReportResponse"
},
"scopes": [
"https://www.googleapis.com/auth/admob.readonly",
"https://www.googleapis.com/auth/admob.report"
],
"streamingType": "NONE"
}
}
},
"mediationGroups": {
"methods": {
"create": {
"description": "Create a mediation group under the specific AdMob account. This method has limited access. If you see a 403 permission denied error, please reach out to your account manager for access.",
"flatPath": "v1beta/accounts/{accountsId}/mediationGroups",
"httpMethod": "POST",
"id": "admob.accounts.mediationGroups.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent which owns the mediation group. Format: accounts/{publisher_id}",
"location": "path",
"pattern": "^accounts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/mediationGroups",
"request": {
"$ref": "MediationGroup"
},
"response": {
"$ref": "MediationGroup"
},
"streamingType": "NONE"
},
"list": {
"description": "List mediation groups under the specified AdMob account. This method has limited access. If you see a 403 permission denied error, please reach out to your account manager for access.",
"flatPath": "v1beta/accounts/{accountsId}/mediationGroups",
"httpMethod": "GET",
"id": "admob.accounts.mediationGroups.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "The filter string that uses [EBNF grammar syntax](https://google.aip.dev/assets/misc/ebnf-filtering.txt). Possible fields to filter by are: - \"AD_SOURCE_IDS\" - \"AD_UNIT_IDS\" - \"APP_IDS\" - \"DISPLAY_NAME\" - \"FORMAT\" - \"MEDIATION_GROUP_ID\" - \"PLATFORM\" - \"STATE\" - \"TARGETED_REGION_CODES\" Possible filter functions are: - `IN`: Used to filter fields that represent a singleton including \"MEDIATION_GROUP_ID\", \"DISPLAY_NAME\", \"STATE\", \"PLATFORM\", and \"FORMAT\". - `CONTAINS_ANY`: Used to filter fields that represent a collection including \"AD_SOURCE_IDS\", \"AD_UNIT_IDS\", \"APP_IDS\", and \"TARGETED_REGION_CODES\". The filter functions can be added together using `AND`. `OR` functionality is not supported. Example: filter: IN(DISPLAY_NAME, \"Test Group 1\", \"Test Group 2\") AND IN(PLATFORM, \"ANDROID\") AND CONTAINS_ANY(AD_SOURCE_IDS, \"5450213213286189855\")",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "The maximum number of mediation groups to return. If unspecified or 0, at most 10,000 mediation groups 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 `ListMediationGroupsResponse`; indicates that this is a continuation of a prior `ListMediationGroups` 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 mediation groups for. Example: accounts/pub-9876543210987654",
"location": "path",
"pattern": "^accounts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/mediationGroups",
"response": {
"$ref": "ListMediationGroupsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/admob.readonly"
],
"streamingType": "NONE"
},
"patch": {
"description": "Update the specified mediation group under the specified AdMob account. This method has limited access. If you see a 403 permission denied error, please reach out to your account manager for access.",
"flatPath": "v1beta/accounts/{accountsId}/mediationGroups/{mediationGroupsId}",
"httpMethod": "PATCH",
"id": "admob.accounts.mediationGroups.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Resource name for this mediation group. Format is: accounts/{publisher_id}/mediationGroups/{mediation_group_id} Example: accounts/pub-9876543210987654/mediationGroups/0123456789",
"location": "path",
"pattern": "^accounts/[^/]+/mediationGroups/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "List of mediation group fields to be updated. Updates to repeated fields such as items in a list will fully replace the existing value(s) with the new value(s). Updates to individual values in a map can be done by indexing by the key. The following field masks are supported for mediation group updates: - \"mediation_group_lines[\\\"{mediation_group_line_id}\\\"]\" clang-format off - \"mediation_group_lines[\\\"{mediation_group_line_id}\\\"].ad_unit_mappings[\\\"{ad_unit_id}\\\"]\" clang-format on - \"mediation_group_lines[\\\"{mediation_group_line_id}\\\"].cpm_micros\" - \"mediation_group_lines[\\\"{mediation_group_line_id}\\\"].cpm_mode\" - \"mediation_group_lines[\\\"{mediation_group_line_id}\\\"].state\" - \"mediation_group_lines[\\\"{mediation_group_line_id}\\\"].display_name\" - \"targeting.ad_unit_ids\" To update a mediation group with a new mediation group line, use a distinct negative number for the \"mediation_group_line_id\". For Example: update_mask { paths: \"mediation_group_lines[\\\"123456789012345\\\"].cpm_micros\" }",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+name}",
"request": {
"$ref": "MediationGroup"
},
"response": {
"$ref": "MediationGroup"
},
"streamingType": "NONE"
}
},
"resources": {
"mediationAbExperiments": {
"methods": {
"create": {
"description": "Create an A/B testing experiment for a specified AdMob account and a mediation group. This method has limited access. If you see a 403 permission denied error, please reach out to your account manager for access.",
"flatPath": "v1beta/accounts/{accountsId}/mediationGroups/{mediationGroupsId}/mediationAbExperiments",
"httpMethod": "POST",
"id": "admob.accounts.mediationGroups.mediationAbExperiments.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent which owns the mediation group. Format: accounts/{publisher_id}/mediationGroups/{mediation_group_id}",
"location": "path",
"pattern": "^accounts/[^/]+/mediationGroups/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/mediationAbExperiments",
"request": {
"$ref": "MediationAbExperiment"
},
"response": {
"$ref": "MediationAbExperiment"
},
"streamingType": "NONE"
},
"stop": {
"description": "Stop the mediation A/B experiment and choose a variant. This method has limited access. If you see a 403 permission denied error, please reach out to your account manager for access.",
"flatPath": "v1beta/accounts/{accountsId}/mediationGroups/{mediationGroupsId}/mediationAbExperiments:stop",
"httpMethod": "POST",
"id": "admob.accounts.mediationGroups.mediationAbExperiments.stop",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Name of the mediation group, the experiment for which to choose a variant for. Example: accounts/pub-9876543210987654/mediationGroups/0123456789/ mediationAbExperiments",
"location": "path",
"pattern": "^accounts/[^/]+/mediationGroups/[^/]+/mediationAbExperiments$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}:stop",
"request": {
"$ref": "StopMediationAbExperimentRequest"
},
"response": {
"$ref": "MediationAbExperiment"
},
"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": "20231113",
"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"
},
"rewardSettings": {
"$ref": "AdUnitRewardSettings",
"description": "Optional. Settings for a rewarded ad unit. This can be set or unset only when the ad_format is \"REWARDED\"."
}
},
"type": "object"
},
"AdUnitMapping": {
"description": "Settings to map an AdMob ad unit to a 3rd party ad unit.",
"id": "AdUnitMapping",
"properties": {
"adUnitConfigurations": {
"additionalProperties": {
"type": "string"
},
"description": "Settings for the specified ad unit to make an ad request to 3rd party ad network. Key-value pairs with values set by the user for the keys requested by the ad network. Please see https://support.google.com/admob/answer/3245073 for details on how to configure the network settings.",
"type": "object"
},
"adapterId": {
"description": "The ID of mediation ad source adapter used by this ad unit mapping. The adapter determines the information needed in the ad_network_settings.",
"format": "int64",
"type": "string"
},
"displayName": {
"description": "Optional. The display name of this ad unit mapping instance.",
"type": "string"
},
"name": {
"description": "Resource name of this ad unit mapping. Format is: accounts/{publisher_id}/adUnits/{ad_unit_id_fragment}/adUnitMappings/{ad_unit_mapping_id} Example: accounts/pub-1234567890123456/adUnits/0123456789/adUnitMappings/987654321",
"type": "string"
},
"state": {
"description": "Output only. The status of this ad unit mapping.",
"enum": [
"STATE_UNSPECIFIED",
"ENABLED"
],
"enumDescriptions": [
"The default value.",
"The ad unit mapping is active and used to serve ads or collecting stats."
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"AdUnitRewardSettings": {
"description": "Settings for a rewarded ad unit.",
"id": "AdUnitRewardSettings",
"properties": {
"unitAmount": {
"description": "Reward amount for this ad unit.",
"format": "int64",
"type": "string"
},
"unitType": {
"description": "Reward item for this ad unit.",
"type": "string"
}
},
"type": "object"
},
"Adapter": {
"description": "Describes adapters supported by each mediation ad source. Adapters correspond to a specific SDK implementation of the ad source, and are each associated with a single platform and a list of supported ad unit formats. Adapters may also require setting some configurations to perform ad requests. Configurations can be specified in the AdUnitMapping by setting the [ad_unit_configurations](#AdUnitMapping.ad_unit_configurations) key/value pairs. For example, the ad_unit_configurations can be used to pass various IDs to the adapter's third-party SDK.",
"id": "Adapter",
"properties": {
"adapterConfigMetadata": {
"description": "Output only. Configuration metadata associated with this adapter.",
"items": {
"$ref": "AdapterAdapterConfigMetadata"
},
"readOnly": true,
"type": "array"
},
"adapterId": {
"description": "Output only. ID of this adapter. It is used to set [adapter_id](#AdUnitMapping.adapter_id).",
"readOnly": true,
"type": "string"
},
"formats": {
"description": "Output only. Indicates the formats of the ad units supported by this adapter.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"name": {
"description": "Output only. Resource name of the adapter. Format is: accounts/{publisher_id}/adSources/{ad_source_id}/adapters/{adapter_id}.",
"readOnly": true,
"type": "string"
},
"platform": {
"description": "Output only. Mobile application platform supported by this adapter. Supported values are: IOS, ANDROID, WINDOWS_PHONE",
"readOnly": true,
"type": "string"
},
"title": {
"description": "Output only. The display name of this adapter.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"AdapterAdapterConfigMetadata": {
"description": "Configuration metadata associated with this adapter. They are used to define the ad_unit_configurations associated with AdUnitMappings for the this adapter.",
"id": "AdapterAdapterConfigMetadata",
"properties": {
"adapterConfigMetadataId": {
"description": "This is used to fill the key of the [ad_unit_configurations](#AdUnitMapping.ad_unit_configurations).",
"type": "string"
},
"adapterConfigMetadataLabel": {
"description": "Name of the adapter configuration metadata.",
"type": "string"
},
"isRequired": {
"description": "Whether this metadata is required for configuring the AdUnitMappings.",
"type": "boolean"
}
},
"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": {
"androidAppStores": {
"description": "Optional. The app store information for published Android apps. This field is only used for apps on the Android platform and will be ignored if the PLATFORM is set to iOS. The default value is the Google Play App store. This field can be updated after app is created. If the app is not published, this field will not be included in the response.",
"items": {
"enum": [
"ANDROID_APP_STORE_UNSPECIFIED",
"GOOGLE_PLAY_APP_STORE",
"AMAZON_APP_STORE",
"OPPO_APP_STORE",
"SAMSUNG_APP_STORE",
"VIVO_APP_STORE",
"XIAOMI_APP_STORE"
],
"enumDescriptions": [
"Default value for an unset field. Do not use.",