v1.d.ts
48.1 KB
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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
/// <reference types="node" />
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosPromise, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace admob_v1 {
export interface Options extends GlobalOptions {
version: 'v1';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* 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.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* 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.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* AdMob API
*
* The AdMob API allows publishers to programmatically get information about their AdMob account.
*
* @example
* ```js
* const {google} = require('googleapis');
* const admob = google.admob('v1');
* ```
*/
export class Admob {
context: APIRequestContext;
accounts: Resource$Accounts;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Describes an AdMob ad unit.
*/
export interface Schema$AdUnit {
/**
* AdFormat of the ad unit. Possible values are as follows: "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.
*/
adFormat?: string | null;
/**
* Ad media type supported by this ad unit. Possible values as follows: "RICH_MEDIA" - Text, image, and other non-video media. "VIDEO" - Video media.
*/
adTypes?: string[] | null;
/**
* 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
*/
adUnitId?: string | null;
/**
* The externally visible ID of the app this ad unit is associated with. Example: ca-app-pub-9876543210987654~0123456789
*/
appId?: string | null;
/**
* 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.
*/
displayName?: string | null;
/**
* Resource name for this ad unit. Format is accounts/{publisher_id\}/adUnits/{ad_unit_id_fragment\} Example: accounts/pub-9876543210987654/adUnits/0123456789
*/
name?: string | null;
}
/**
* Describes an AdMob app for a specific platform (For example: Android or iOS).
*/
export interface Schema$App {
/**
* 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
*/
appId?: string | null;
/**
* 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.
*/
linkedAppInfo?: Schema$AppLinkedAppInfo;
/**
* 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.
*/
manualAppInfo?: Schema$AppManualAppInfo;
/**
* Resource name for this app. Format is accounts/{publisher_id\}/apps/{app_id_fragment\} Example: accounts/pub-9876543210987654/apps/0123456789
*/
name?: string | null;
/**
* Describes the platform of the app. Limited to "IOS" and "ANDROID".
*/
platform?: string | null;
}
/**
* Information from the app store if the app is linked to an app store.
*/
export interface Schema$AppLinkedAppInfo {
/**
* 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.
*/
appStoreId?: string | null;
/**
* 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.
*/
displayName?: string | null;
}
/**
* Information provided for manual apps which are not linked to an application store (Example: Google Play, App Store).
*/
export interface Schema$AppManualAppInfo {
/**
* 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.
*/
displayName?: string | null;
}
/**
* 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 value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
*/
export interface Schema$Date {
/**
* 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.
*/
day?: number | null;
/**
* Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
*/
month?: number | null;
/**
* Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
*/
year?: number | null;
}
/**
* Specification of a single date range. Both dates are inclusive.
*/
export interface Schema$DateRange {
/**
* End date of the date range, inclusive. Must be greater than or equal to the start date.
*/
endDate?: Schema$Date;
/**
* Start date of the date range, inclusive. Must be less than or equal to the end date.
*/
startDate?: Schema$Date;
}
/**
* Request to generate an AdMob Mediation report.
*/
export interface Schema$GenerateMediationReportRequest {
/**
* Network report specification.
*/
reportSpec?: Schema$MediationReportSpec;
}
/**
* 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\} \}]
*/
export interface Schema$GenerateMediationReportResponse {
/**
* Additional information about the generated report, such as warnings about the data.
*/
footer?: Schema$ReportFooter;
/**
* Report generation settings that describes the report contents, such as the report date range and localization settings.
*/
header?: Schema$ReportHeader;
/**
* Actual report data.
*/
row?: Schema$ReportRow;
}
/**
* Request to generate an AdMob Network report.
*/
export interface Schema$GenerateNetworkReportRequest {
/**
* Network report specification.
*/
reportSpec?: Schema$NetworkReportSpec;
}
/**
* 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\} \}]
*/
export interface Schema$GenerateNetworkReportResponse {
/**
* Additional information about the generated report, such as warnings about the data.
*/
footer?: Schema$ReportFooter;
/**
* Report generation settings that describes the report contents, such as the report date range and localization settings.
*/
header?: Schema$ReportHeader;
/**
* Actual report data.
*/
row?: Schema$ReportRow;
}
/**
* Response for the ad units list request.
*/
export interface Schema$ListAdUnitsResponse {
/**
* The resulting ad units for the requested account.
*/
adUnits?: Schema$AdUnit[];
/**
* If not empty, indicates that there may be more ad units for the request; this value should be passed in a new `ListAdUnitsRequest`.
*/
nextPageToken?: string | null;
}
/**
* Response for the apps list request.
*/
export interface Schema$ListAppsResponse {
/**
* The resulting apps for the requested account.
*/
apps?: Schema$App[];
/**
* If not empty, indicates that there may be more apps for the request; this value should be passed in a new `ListAppsRequest`.
*/
nextPageToken?: string | null;
}
/**
* Response for the publisher account list request.
*/
export interface Schema$ListPublisherAccountsResponse {
/**
* Publisher that the client credentials can access.
*/
account?: Schema$PublisherAccount[];
/**
* If not empty, indicates that there might be more accounts for the request; you must pass this value in a new `ListPublisherAccountsRequest`.
*/
nextPageToken?: string | null;
}
/**
* Localization settings for reports, such as currency and language. It affects how metrics are calculated.
*/
export interface Schema$LocalizationSettings {
/**
* 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.
*/
currencyCode?: string | null;
/**
* 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.
*/
languageCode?: string | null;
}
/**
* 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": 2018, "month": 9, "day": 1\}, "end_date": {"year": 2018, "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 \>= '2018-09-01' AND DATE <= '2018-09-30' AND COUNTRY IN ('US', 'CN') GROUP BY AD_SOURCE, APP, COUNTRY ORDER BY APP ASC;
*/
export interface Schema$MediationReportSpec {
/**
* The date range for which the report is generated.
*/
dateRange?: Schema$DateRange;
/**
* Describes which report rows to match based on their dimension values.
*/
dimensionFilters?: Schema$MediationReportSpecDimensionFilter[];
/**
* 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.
*/
dimensions?: string[] | null;
/**
* Localization settings of the report.
*/
localizationSettings?: Schema$LocalizationSettings;
/**
* 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.
*/
maxReportRows?: number | null;
/**
* List of metrics of the report. A report must specify at least one metric.
*/
metrics?: string[] | null;
/**
* 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.
*/
sortConditions?: Schema$MediationReportSpecSortCondition[];
/**
* 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.
*/
timeZone?: string | null;
}
/**
* Describes which report rows to match based on their dimension values.
*/
export interface Schema$MediationReportSpecDimensionFilter {
/**
* Applies the filter criterion to the specified dimension.
*/
dimension?: string | null;
/**
* Matches a row if its value for the specified dimension is in one of the values specified in this condition.
*/
matchesAny?: Schema$StringList;
}
/**
* Sorting direction to be applied on a dimension or a metric.
*/
export interface Schema$MediationReportSpecSortCondition {
/**
* Sort by the specified dimension.
*/
dimension?: string | null;
/**
* Sort by the specified metric.
*/
metric?: string | null;
/**
* Sorting order of the dimension or metric.
*/
order?: string | null;
}
/**
* 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': 2018, 'month': 9, 'day': 1\}, 'end_date': {'year': 2018, '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 \>= '2018-09-01' AND DATE <= '2018-09-30' AND COUNTRY IN ('US', 'CN') GROUP BY DATE, APP, COUNTRY ORDER BY APP ASC, CLICKS DESC;
*/
export interface Schema$NetworkReportSpec {
/**
* The date range for which the report is generated.
*/
dateRange?: Schema$DateRange;
/**
* Describes which report rows to match based on their dimension values.
*/
dimensionFilters?: Schema$NetworkReportSpecDimensionFilter[];
/**
* 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.
*/
dimensions?: string[] | null;
/**
* Localization settings of the report.
*/
localizationSettings?: Schema$LocalizationSettings;
/**
* 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.
*/
maxReportRows?: number | null;
/**
* List of metrics of the report. A report must specify at least one metric.
*/
metrics?: string[] | null;
/**
* 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.
*/
sortConditions?: Schema$NetworkReportSpecSortCondition[];
/**
* 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.
*/
timeZone?: string | null;
}
/**
* Describes which report rows to match based on their dimension values.
*/
export interface Schema$NetworkReportSpecDimensionFilter {
/**
* Applies the filter criterion to the specified dimension.
*/
dimension?: string | null;
/**
* Matches a row if its value for the specified dimension is in one of the values specified in this condition.
*/
matchesAny?: Schema$StringList;
}
/**
* Sorting direction to be applied on a dimension or a metric.
*/
export interface Schema$NetworkReportSpecSortCondition {
/**
* Sort by the specified dimension.
*/
dimension?: string | null;
/**
* Sort by the specified metric.
*/
metric?: string | null;
/**
* Sorting order of the dimension or metric.
*/
order?: string | null;
}
/**
* A publisher account contains information relevant to the use of this API, such as the time zone used for the reports.
*/
export interface Schema$PublisherAccount {
/**
* 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.
*/
currencyCode?: string | null;
/**
* Resource name of this account. Format is accounts/{publisher_id\}.
*/
name?: string | null;
/**
* The unique ID by which this publisher account can be identified in the API requests (for example, pub-1234567890).
*/
publisherId?: string | null;
/**
* The time zone that is used in reports that are generated for this account. The value is a time-zone ID as specified by the CLDR project, for example, "America/Los_Angeles".
*/
reportingTimeZone?: string | null;
}
/**
* Groups data available after report generation, for example, warnings and row counts. Always sent as the last message in the stream response.
*/
export interface Schema$ReportFooter {
/**
* Total number of rows that matched the request. Warning: This count does NOT always match the number of rows in the response. Do not make that assumption when processing the response.
*/
matchingRowCount?: string | null;
/**
* Warnings associated with generation of the report.
*/
warnings?: Schema$ReportWarning[];
}
/**
* Groups data helps to treat the generated report. Always sent as a first message in the stream response.
*/
export interface Schema$ReportHeader {
/**
* The date range for which the report is generated. This is identical to the range specified in the report request.
*/
dateRange?: Schema$DateRange;
/**
* Localization settings of the report. This is identical to the settings in the report request.
*/
localizationSettings?: Schema$LocalizationSettings;
/**
* The report time zone. The value is a time-zone ID as specified by the CLDR project, for example, "America/Los_Angeles".
*/
reportingTimeZone?: string | null;
}
/**
* A row of the returning report.
*/
export interface Schema$ReportRow {
/**
* Map of dimension values in a row, with keys as enum name of the dimensions.
*/
dimensionValues?: {
[key: string]: Schema$ReportRowDimensionValue;
} | null;
/**
* Map of metric values in a row, with keys as enum name of the metrics. If a metric being requested has no value returned, the map will not include it.
*/
metricValues?: {
[key: string]: Schema$ReportRowMetricValue;
} | null;
}
/**
* Representation of a dimension value.
*/
export interface Schema$ReportRowDimensionValue {
/**
* The localized string representation of the value. If unspecified, the display label should be derived from the value.
*/
displayLabel?: string | null;
/**
* Dimension value in the format specified in the report's spec Dimension enum.
*/
value?: string | null;
}
/**
* Representation of a metric value.
*/
export interface Schema$ReportRowMetricValue {
/**
* Double precision (approximate) decimal values. Rates are from 0 to 1.
*/
doubleValue?: number | null;
/**
* Metric integer value.
*/
integerValue?: string | null;
/**
* Amount in micros. One million is equivalent to one unit. Currency value is in the unit (USD, EUR or other) specified by the request. For example, $6.50 whould be represented as 6500000 micros.
*/
microsValue?: string | null;
}
/**
* Warnings associated with generation of the report.
*/
export interface Schema$ReportWarning {
/**
* Describes the details of the warning message, in English.
*/
description?: string | null;
/**
* Type of the warning.
*/
type?: string | null;
}
/**
* List of string values.
*/
export interface Schema$StringList {
/**
* The string values.
*/
values?: string[] | null;
}
export class Resource$Accounts {
context: APIRequestContext;
adUnits: Resource$Accounts$Adunits;
apps: Resource$Accounts$Apps;
mediationReport: Resource$Accounts$Mediationreport;
networkReport: Resource$Accounts$Networkreport;
constructor(context: APIRequestContext);
/**
* Gets information about the specified AdMob publisher account.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/admob.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const admob = google.admob('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/admob.readonly',
* 'https://www.googleapis.com/auth/admob.report',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await admob.accounts.get({
* // Resource name of the publisher account to retrieve. Example: accounts/pub-9876543210987654
* name: 'accounts/my-account',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "currencyCode": "my_currencyCode",
* // "name": "my_name",
* // "publisherId": "my_publisherId",
* // "reportingTimeZone": "my_reportingTimeZone"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(params: Params$Resource$Accounts$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Accounts$Get, options?: MethodOptions): GaxiosPromise<Schema$PublisherAccount>;
get(params: Params$Resource$Accounts$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Accounts$Get, options: MethodOptions | BodyResponseCallback<Schema$PublisherAccount>, callback: BodyResponseCallback<Schema$PublisherAccount>): void;
get(params: Params$Resource$Accounts$Get, callback: BodyResponseCallback<Schema$PublisherAccount>): void;
get(callback: BodyResponseCallback<Schema$PublisherAccount>): void;
/**
* 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.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/admob.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const admob = google.admob('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/admob.readonly',
* 'https://www.googleapis.com/auth/admob.report',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await admob.accounts.list({
* // Maximum number of accounts to return.
* pageSize: 'placeholder-value',
* // 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.
* pageToken: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "account": [],
* // "nextPageToken": "my_nextPageToken"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Accounts$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Accounts$List, options?: MethodOptions): GaxiosPromise<Schema$ListPublisherAccountsResponse>;
list(params: Params$Resource$Accounts$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Accounts$List, options: MethodOptions | BodyResponseCallback<Schema$ListPublisherAccountsResponse>, callback: BodyResponseCallback<Schema$ListPublisherAccountsResponse>): void;
list(params: Params$Resource$Accounts$List, callback: BodyResponseCallback<Schema$ListPublisherAccountsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListPublisherAccountsResponse>): void;
}
export interface Params$Resource$Accounts$Get extends StandardParameters {
/**
* Resource name of the publisher account to retrieve. Example: accounts/pub-9876543210987654
*/
name?: string;
}
export interface Params$Resource$Accounts$List extends StandardParameters {
/**
* Maximum number of accounts to return.
*/
pageSize?: number;
/**
* 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.
*/
pageToken?: string;
}
export class Resource$Accounts$Adunits {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* List the ad units under the specified AdMob account.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/admob.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const admob = google.admob('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/admob.readonly'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await admob.accounts.adUnits.list({
* // The maximum number of ad units to return. If unspecified or 0, at most 1000 ad units will be returned. The maximum value is 10,000; values above 10,000 will be coerced to 10,000.
* pageSize: 'placeholder-value',
* // 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.
* pageToken: 'placeholder-value',
* // Required. Resource name of the account to list ad units for. Example: accounts/pub-9876543210987654
* parent: 'accounts/my-account',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "adUnits": [],
* // "nextPageToken": "my_nextPageToken"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Accounts$Adunits$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Accounts$Adunits$List, options?: MethodOptions): GaxiosPromise<Schema$ListAdUnitsResponse>;
list(params: Params$Resource$Accounts$Adunits$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Accounts$Adunits$List, options: MethodOptions | BodyResponseCallback<Schema$ListAdUnitsResponse>, callback: BodyResponseCallback<Schema$ListAdUnitsResponse>): void;
list(params: Params$Resource$Accounts$Adunits$List, callback: BodyResponseCallback<Schema$ListAdUnitsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListAdUnitsResponse>): void;
}
export interface Params$Resource$Accounts$Adunits$List extends StandardParameters {
/**
* The maximum number of ad units to return. If unspecified or 0, at most 1000 ad units will be returned. The maximum value is 10,000; values above 10,000 will be coerced to 10,000.
*/
pageSize?: number;
/**
* 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.
*/
pageToken?: string;
/**
* Required. Resource name of the account to list ad units for. Example: accounts/pub-9876543210987654
*/
parent?: string;
}
export class Resource$Accounts$Apps {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* List the apps under the specified AdMob account.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/admob.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const admob = google.admob('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/admob.readonly'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await admob.accounts.apps.list({
* // The maximum number of apps to return. If unspecified or 0, at most 1000 apps will be returned. The maximum value is 10,000; values above 10,000 will be coerced to 10,000.
* pageSize: 'placeholder-value',
* // 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.
* pageToken: 'placeholder-value',
* // Required. Resource name of the account to list apps for. Example: accounts/pub-9876543210987654
* parent: 'accounts/my-account',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "apps": [],
* // "nextPageToken": "my_nextPageToken"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Accounts$Apps$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Accounts$Apps$List, options?: MethodOptions): GaxiosPromise<Schema$ListAppsResponse>;
list(params: Params$Resource$Accounts$Apps$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Accounts$Apps$List, options: MethodOptions | BodyResponseCallback<Schema$ListAppsResponse>, callback: BodyResponseCallback<Schema$ListAppsResponse>): void;
list(params: Params$Resource$Accounts$Apps$List, callback: BodyResponseCallback<Schema$ListAppsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListAppsResponse>): void;
}
export interface Params$Resource$Accounts$Apps$List extends StandardParameters {
/**
* The maximum number of apps to return. If unspecified or 0, at most 1000 apps will be returned. The maximum value is 10,000; values above 10,000 will be coerced to 10,000.
*/
pageSize?: number;
/**
* 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.
*/
pageToken?: string;
/**
* Required. Resource name of the account to list apps for. Example: accounts/pub-9876543210987654
*/
parent?: string;
}
export class Resource$Accounts$Mediationreport {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* 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.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/admob.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const admob = google.admob('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/admob.readonly',
* 'https://www.googleapis.com/auth/admob.report',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await admob.accounts.mediationReport.generate({
* // Resource name of the account to generate the report for. Example: accounts/pub-9876543210987654
* parent: 'accounts/my-account',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "reportSpec": {}
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "footer": {},
* // "header": {},
* // "row": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
generate(params: Params$Resource$Accounts$Mediationreport$Generate, options: StreamMethodOptions): GaxiosPromise<Readable>;
generate(params?: Params$Resource$Accounts$Mediationreport$Generate, options?: MethodOptions): GaxiosPromise<Schema$GenerateMediationReportResponse>;
generate(params: Params$Resource$Accounts$Mediationreport$Generate, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
generate(params: Params$Resource$Accounts$Mediationreport$Generate, options: MethodOptions | BodyResponseCallback<Schema$GenerateMediationReportResponse>, callback: BodyResponseCallback<Schema$GenerateMediationReportResponse>): void;
generate(params: Params$Resource$Accounts$Mediationreport$Generate, callback: BodyResponseCallback<Schema$GenerateMediationReportResponse>): void;
generate(callback: BodyResponseCallback<Schema$GenerateMediationReportResponse>): void;
}
export interface Params$Resource$Accounts$Mediationreport$Generate extends StandardParameters {
/**
* Resource name of the account to generate the report for. Example: accounts/pub-9876543210987654
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GenerateMediationReportRequest;
}
export class Resource$Accounts$Networkreport {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* 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.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/admob.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const admob = google.admob('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/admob.readonly',
* 'https://www.googleapis.com/auth/admob.report',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await admob.accounts.networkReport.generate({
* // Resource name of the account to generate the report for. Example: accounts/pub-9876543210987654
* parent: 'accounts/my-account',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "reportSpec": {}
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "footer": {},
* // "header": {},
* // "row": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
generate(params: Params$Resource$Accounts$Networkreport$Generate, options: StreamMethodOptions): GaxiosPromise<Readable>;
generate(params?: Params$Resource$Accounts$Networkreport$Generate, options?: MethodOptions): GaxiosPromise<Schema$GenerateNetworkReportResponse>;
generate(params: Params$Resource$Accounts$Networkreport$Generate, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
generate(params: Params$Resource$Accounts$Networkreport$Generate, options: MethodOptions | BodyResponseCallback<Schema$GenerateNetworkReportResponse>, callback: BodyResponseCallback<Schema$GenerateNetworkReportResponse>): void;
generate(params: Params$Resource$Accounts$Networkreport$Generate, callback: BodyResponseCallback<Schema$GenerateNetworkReportResponse>): void;
generate(callback: BodyResponseCallback<Schema$GenerateNetworkReportResponse>): void;
}
export interface Params$Resource$Accounts$Networkreport$Generate extends StandardParameters {
/**
* Resource name of the account to generate the report for. Example: accounts/pub-9876543210987654
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GenerateNetworkReportRequest;
}
export {};
}