v1.1.d.ts
35.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
/// <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 doubleclickbidmanager_v1_1 {
export interface Options extends GlobalOptions {
version: 'v1.1';
}
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;
}
/**
* DoubleClick Bid Manager API
*
* DoubleClick Bid Manager API allows users to manage and create campaigns and reports.
*
* @example
* ```js
* const {google} = require('googleapis');
* const doubleclickbidmanager = google.doubleclickbidmanager('v1.1');
* ```
*/
export class Doubleclickbidmanager {
context: APIRequestContext;
queries: Resource$Queries;
reports: Resource$Reports;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* A channel grouping defines a set of rules that can be used to categorize events in a path report.
*/
export interface Schema$ChannelGrouping {
/**
* The name to apply to an event that does not match any of the rules in the channel grouping.
*/
fallbackName?: string | null;
/**
* Channel Grouping name.
*/
name?: string | null;
/**
* Rules within Channel Grouping. There is a limit of 100 rules that can be set per channel grouping.
*/
rules?: Schema$Rule[];
}
/**
* DisjunctiveMatchStatement that OR's all contained filters.
*/
export interface Schema$DisjunctiveMatchStatement {
/**
* Filters. There is a limit of 100 filters that can be set per disjunctive match statement.
*/
eventFilters?: Schema$EventFilter[];
}
/**
* Defines the type of filter to be applied to the path, a DV360 event dimension filter.
*/
export interface Schema$EventFilter {
/**
* Filter on a dimension.
*/
dimensionFilter?: Schema$PathQueryOptionsFilter;
}
/**
* Filter used to match traffic data in your report.
*/
export interface Schema$FilterPair {
/**
* Filter type.
*/
type?: string | null;
/**
* Filter value.
*/
value?: string | null;
}
/**
* List queries response.
*/
export interface Schema$ListQueriesResponse {
/**
* Identifies what kind of resource this is. Value: the fixed string "doubleclickbidmanager#listQueriesResponse".
*/
kind?: string | null;
/**
* Next page's pagination token if one exists.
*/
nextPageToken?: string | null;
/**
* Retrieved queries.
*/
queries?: Schema$Query[];
}
/**
* List reports response.
*/
export interface Schema$ListReportsResponse {
/**
* Identifies what kind of resource this is. Value: the fixed string "doubleclickbidmanager#listReportsResponse".
*/
kind?: string | null;
/**
* Next page's pagination token if one exists.
*/
nextPageToken?: string | null;
/**
* Retrieved reports.
*/
reports?: Schema$Report[];
}
/**
* Additional query options.
*/
export interface Schema$Options {
/**
* Set to true and filter your report by `FILTER_INSERTION_ORDER` or `FILTER_LINE_ITEM` to include data for audience lists specifically targeted by those items.
*/
includeOnlyTargetedUserLists?: boolean | null;
/**
* Options that contain Path Filters and Custom Channel Groupings.
*/
pathQueryOptions?: Schema$PathQueryOptions;
}
/**
* Parameters of a query or report.
*/
export interface Schema$Parameters {
/**
* Filters used to match traffic data in your report.
*/
filters?: Schema$FilterPair[];
/**
* Data is grouped by the filters listed in this field.
*/
groupBys?: string[] | null;
/**
* Deprecated. This field is no longer in use.
*/
includeInviteData?: boolean | null;
/**
* Metrics to include as columns in your report.
*/
metrics?: string[] | null;
/**
* Additional query options.
*/
options?: Schema$Options;
/**
* Report type.
*/
type?: string | null;
}
/**
* Path filters specify which paths to include in a report. A path is the result of combining DV360 events based on User ID to create a workflow of users' actions. When a path filter is set, the resulting report will only include paths that match the specified event at the specified position. All other paths will be excluded.
*/
export interface Schema$PathFilter {
/**
* Filter on an event to be applied to some part of the path.
*/
eventFilters?: Schema$EventFilter[];
/**
* Indicates the position of the path the filter should match to (first, last, or any event in path).
*/
pathMatchPosition?: string | null;
}
/**
* Path Query Options for Report Options.
*/
export interface Schema$PathQueryOptions {
/**
* Custom Channel Groupings.
*/
channelGrouping?: Schema$ChannelGrouping;
/**
* Path Filters. There is a limit of 100 path filters that can be set per report.
*/
pathFilters?: Schema$PathFilter[];
}
/**
* Dimension Filter on path events.
*/
export interface Schema$PathQueryOptionsFilter {
/**
* Dimension the filter is applied to.
*/
filter?: string | null;
/**
* Indicates how the filter should be matched to the value.
*/
match?: string | null;
/**
* Value to filter on.
*/
values?: string[] | null;
}
/**
* Represents a query.
*/
export interface Schema$Query {
/**
* Identifies what kind of resource this is. Value: the fixed string "doubleclickbidmanager#query".
*/
kind?: string | null;
/**
* Query metadata.
*/
metadata?: Schema$QueryMetadata;
/**
* Query parameters.
*/
params?: Schema$Parameters;
/**
* Query ID.
*/
queryId?: string | null;
/**
* The ending time for the data that is shown in the report. Note, reportDataEndTimeMs is required if metadata.dataRange is CUSTOM_DATES and ignored otherwise.
*/
reportDataEndTimeMs?: string | null;
/**
* The starting time for the data that is shown in the report. Note, reportDataStartTimeMs is required if metadata.dataRange is CUSTOM_DATES and ignored otherwise.
*/
reportDataStartTimeMs?: string | null;
/**
* Information on how often and when to run a query.
*/
schedule?: Schema$QuerySchedule;
/**
* Canonical timezone code for report data time. Defaults to America/New_York.
*/
timezoneCode?: string | null;
}
/**
* Query metadata.
*/
export interface Schema$QueryMetadata {
/**
* Range of report data.
*/
dataRange?: string | null;
/**
* Format of the generated report.
*/
format?: string | null;
/**
* The path to the location in Google Cloud Storage where the latest report is stored.
*/
googleCloudStoragePathForLatestReport?: string | null;
/**
* The path in Google Drive for the latest report.
*/
googleDrivePathForLatestReport?: string | null;
/**
* The time when the latest report started to run.
*/
latestReportRunTimeMs?: string | null;
/**
* Locale of the generated reports. Valid values are cs CZECH de GERMAN en ENGLISH es SPANISH fr FRENCH it ITALIAN ja JAPANESE ko KOREAN pl POLISH pt-BR BRAZILIAN_PORTUGUESE ru RUSSIAN tr TURKISH uk UKRAINIAN zh-CN CHINA_CHINESE zh-TW TAIWAN_CHINESE An locale string not in the list above will generate reports in English.
*/
locale?: string | null;
/**
* Number of reports that have been generated for the query.
*/
reportCount?: number | null;
/**
* Whether the latest report is currently running.
*/
running?: boolean | null;
/**
* Whether to send an email notification when a report is ready. Default to false.
*/
sendNotification?: boolean | null;
/**
* List of email addresses which are sent email notifications when the report is finished. Separate from sendNotification.
*/
shareEmailAddress?: string[] | null;
/**
* Query title. It is used to name the reports generated from this query.
*/
title?: string | null;
}
/**
* Information on how frequently and when to run a query.
*/
export interface Schema$QuerySchedule {
/**
* Datetime to periodically run the query until.
*/
endTimeMs?: string | null;
/**
* How often the query is run.
*/
frequency?: string | null;
/**
* Time of day at which a new report will be generated, represented as minutes past midnight. Range is 0 to 1439. Only applies to scheduled reports.
*/
nextRunMinuteOfDay?: number | null;
/**
* Canonical timezone code for report generation time. Defaults to America/New_York.
*/
nextRunTimezoneCode?: string | null;
/**
* When to start running the query. Not applicable to `ONE_TIME` frequency.
*/
startTimeMs?: string | null;
}
/**
* Represents a report.
*/
export interface Schema$Report {
/**
* Key used to identify a report.
*/
key?: Schema$ReportKey;
/**
* Report metadata.
*/
metadata?: Schema$ReportMetadata;
/**
* Report parameters.
*/
params?: Schema$Parameters;
}
/**
* An explanation of a report failure.
*/
export interface Schema$ReportFailure {
/**
* Error code that shows why the report was not created.
*/
errorCode?: string | null;
}
/**
* Key used to identify a report.
*/
export interface Schema$ReportKey {
/**
* Query ID.
*/
queryId?: string | null;
/**
* Report ID.
*/
reportId?: string | null;
}
/**
* Report metadata.
*/
export interface Schema$ReportMetadata {
/**
* The path to the location in Google Cloud Storage where the report is stored.
*/
googleCloudStoragePath?: string | null;
/**
* The ending time for the data that is shown in the report.
*/
reportDataEndTimeMs?: string | null;
/**
* The starting time for the data that is shown in the report.
*/
reportDataStartTimeMs?: string | null;
/**
* Report status.
*/
status?: Schema$ReportStatus;
}
/**
* Report status.
*/
export interface Schema$ReportStatus {
/**
* If the report failed, this records the cause.
*/
failure?: Schema$ReportFailure;
/**
* The time when this report either completed successfully or failed.
*/
finishTimeMs?: string | null;
/**
* The file type of the report.
*/
format?: string | null;
/**
* The state of the report.
*/
state?: string | null;
}
/**
* A Rule defines a name, and a boolean expression in [conjunctive normal form](http: //mathworld.wolfram.com/ConjunctiveNormalForm.html){.external\} that can be // applied to a path event to determine if that name should be applied.
*/
export interface Schema$Rule {
disjunctiveMatchStatements?: Schema$DisjunctiveMatchStatement[];
/**
* Rule name.
*/
name?: string | null;
}
/**
* Request to run a stored query to generate a report.
*/
export interface Schema$RunQueryRequest {
/**
* Report data range used to generate the report.
*/
dataRange?: string | null;
/**
* The ending time for the data that is shown in the report. Note, reportDataEndTimeMs is required if dataRange is CUSTOM_DATES and ignored otherwise.
*/
reportDataEndTimeMs?: string | null;
/**
* The starting time for the data that is shown in the report. Note, reportDataStartTimeMs is required if dataRange is CUSTOM_DATES and ignored otherwise.
*/
reportDataStartTimeMs?: string | null;
/**
* Canonical timezone code for report data time. Defaults to America/New_York.
*/
timezoneCode?: string | null;
}
export class Resource$Queries {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Creates a query.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/doubleclickbidmanager.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 doubleclickbidmanager = google.doubleclickbidmanager('v1.1');
*
* 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/doubleclickbidmanager'],
* });
*
* // 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 doubleclickbidmanager.queries.createquery({
* // If true, tries to run the query asynchronously. Only applicable when the frequency is ONE_TIME.
* asynchronous: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "kind": "my_kind",
* // "metadata": {},
* // "params": {},
* // "queryId": "my_queryId",
* // "reportDataEndTimeMs": "my_reportDataEndTimeMs",
* // "reportDataStartTimeMs": "my_reportDataStartTimeMs",
* // "schedule": {},
* // "timezoneCode": "my_timezoneCode"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "kind": "my_kind",
* // "metadata": {},
* // "params": {},
* // "queryId": "my_queryId",
* // "reportDataEndTimeMs": "my_reportDataEndTimeMs",
* // "reportDataStartTimeMs": "my_reportDataStartTimeMs",
* // "schedule": {},
* // "timezoneCode": "my_timezoneCode"
* // }
* }
*
* 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.
*/
createquery(params: Params$Resource$Queries$Createquery, options: StreamMethodOptions): GaxiosPromise<Readable>;
createquery(params?: Params$Resource$Queries$Createquery, options?: MethodOptions): GaxiosPromise<Schema$Query>;
createquery(params: Params$Resource$Queries$Createquery, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
createquery(params: Params$Resource$Queries$Createquery, options: MethodOptions | BodyResponseCallback<Schema$Query>, callback: BodyResponseCallback<Schema$Query>): void;
createquery(params: Params$Resource$Queries$Createquery, callback: BodyResponseCallback<Schema$Query>): void;
createquery(callback: BodyResponseCallback<Schema$Query>): void;
/**
* Deletes a stored query as well as the associated stored reports.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/doubleclickbidmanager.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 doubleclickbidmanager = google.doubleclickbidmanager('v1.1');
*
* 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/doubleclickbidmanager'],
* });
*
* // 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 doubleclickbidmanager.queries.deletequery({
* // Query ID to delete.
* queryId: 'placeholder-value',
* });
* console.log(res.data);
* }
*
* 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.
*/
deletequery(params: Params$Resource$Queries$Deletequery, options: StreamMethodOptions): GaxiosPromise<Readable>;
deletequery(params?: Params$Resource$Queries$Deletequery, options?: MethodOptions): GaxiosPromise<void>;
deletequery(params: Params$Resource$Queries$Deletequery, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
deletequery(params: Params$Resource$Queries$Deletequery, options: MethodOptions | BodyResponseCallback<void>, callback: BodyResponseCallback<void>): void;
deletequery(params: Params$Resource$Queries$Deletequery, callback: BodyResponseCallback<void>): void;
deletequery(callback: BodyResponseCallback<void>): void;
/**
* Retrieves a stored query.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/doubleclickbidmanager.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 doubleclickbidmanager = google.doubleclickbidmanager('v1.1');
*
* 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/doubleclickbidmanager'],
* });
*
* // 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 doubleclickbidmanager.queries.getquery({
* // Query ID to retrieve.
* queryId: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "kind": "my_kind",
* // "metadata": {},
* // "params": {},
* // "queryId": "my_queryId",
* // "reportDataEndTimeMs": "my_reportDataEndTimeMs",
* // "reportDataStartTimeMs": "my_reportDataStartTimeMs",
* // "schedule": {},
* // "timezoneCode": "my_timezoneCode"
* // }
* }
*
* 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.
*/
getquery(params: Params$Resource$Queries$Getquery, options: StreamMethodOptions): GaxiosPromise<Readable>;
getquery(params?: Params$Resource$Queries$Getquery, options?: MethodOptions): GaxiosPromise<Schema$Query>;
getquery(params: Params$Resource$Queries$Getquery, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
getquery(params: Params$Resource$Queries$Getquery, options: MethodOptions | BodyResponseCallback<Schema$Query>, callback: BodyResponseCallback<Schema$Query>): void;
getquery(params: Params$Resource$Queries$Getquery, callback: BodyResponseCallback<Schema$Query>): void;
getquery(callback: BodyResponseCallback<Schema$Query>): void;
/**
* Retrieves stored queries.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/doubleclickbidmanager.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 doubleclickbidmanager = google.doubleclickbidmanager('v1.1');
*
* 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/doubleclickbidmanager'],
* });
*
* // 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 doubleclickbidmanager.queries.listqueries({
* // Maximum number of results per page. Must be between 1 and 100. Defaults to 100 if unspecified.
* pageSize: 'placeholder-value',
* // Optional pagination token.
* pageToken: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "kind": "my_kind",
* // "nextPageToken": "my_nextPageToken",
* // "queries": []
* // }
* }
*
* 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.
*/
listqueries(params: Params$Resource$Queries$Listqueries, options: StreamMethodOptions): GaxiosPromise<Readable>;
listqueries(params?: Params$Resource$Queries$Listqueries, options?: MethodOptions): GaxiosPromise<Schema$ListQueriesResponse>;
listqueries(params: Params$Resource$Queries$Listqueries, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
listqueries(params: Params$Resource$Queries$Listqueries, options: MethodOptions | BodyResponseCallback<Schema$ListQueriesResponse>, callback: BodyResponseCallback<Schema$ListQueriesResponse>): void;
listqueries(params: Params$Resource$Queries$Listqueries, callback: BodyResponseCallback<Schema$ListQueriesResponse>): void;
listqueries(callback: BodyResponseCallback<Schema$ListQueriesResponse>): void;
/**
* Runs a stored query to generate a report.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/doubleclickbidmanager.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 doubleclickbidmanager = google.doubleclickbidmanager('v1.1');
*
* 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/doubleclickbidmanager'],
* });
*
* // 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 doubleclickbidmanager.queries.runquery({
* // If true, tries to run the query asynchronously.
* asynchronous: 'placeholder-value',
* // Query ID to run.
* queryId: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "dataRange": "my_dataRange",
* // "reportDataEndTimeMs": "my_reportDataEndTimeMs",
* // "reportDataStartTimeMs": "my_reportDataStartTimeMs",
* // "timezoneCode": "my_timezoneCode"
* // }
* },
* });
* console.log(res.data);
* }
*
* 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.
*/
runquery(params: Params$Resource$Queries$Runquery, options: StreamMethodOptions): GaxiosPromise<Readable>;
runquery(params?: Params$Resource$Queries$Runquery, options?: MethodOptions): GaxiosPromise<void>;
runquery(params: Params$Resource$Queries$Runquery, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
runquery(params: Params$Resource$Queries$Runquery, options: MethodOptions | BodyResponseCallback<void>, callback: BodyResponseCallback<void>): void;
runquery(params: Params$Resource$Queries$Runquery, callback: BodyResponseCallback<void>): void;
runquery(callback: BodyResponseCallback<void>): void;
}
export interface Params$Resource$Queries$Createquery extends StandardParameters {
/**
* If true, tries to run the query asynchronously. Only applicable when the frequency is ONE_TIME.
*/
asynchronous?: boolean;
/**
* Request body metadata
*/
requestBody?: Schema$Query;
}
export interface Params$Resource$Queries$Deletequery extends StandardParameters {
/**
* Query ID to delete.
*/
queryId?: string;
}
export interface Params$Resource$Queries$Getquery extends StandardParameters {
/**
* Query ID to retrieve.
*/
queryId?: string;
}
export interface Params$Resource$Queries$Listqueries extends StandardParameters {
/**
* Maximum number of results per page. Must be between 1 and 100. Defaults to 100 if unspecified.
*/
pageSize?: number;
/**
* Optional pagination token.
*/
pageToken?: string;
}
export interface Params$Resource$Queries$Runquery extends StandardParameters {
/**
* If true, tries to run the query asynchronously.
*/
asynchronous?: boolean;
/**
* Query ID to run.
*/
queryId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$RunQueryRequest;
}
export class Resource$Reports {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Retrieves stored reports.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/doubleclickbidmanager.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 doubleclickbidmanager = google.doubleclickbidmanager('v1.1');
*
* 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/doubleclickbidmanager'],
* });
*
* // 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 doubleclickbidmanager.reports.listreports({
* // Maximum number of results per page. Must be between 1 and 100. Defaults to 100 if unspecified.
* pageSize: 'placeholder-value',
* // Optional pagination token.
* pageToken: 'placeholder-value',
* // Query ID with which the reports are associated.
* queryId: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "kind": "my_kind",
* // "nextPageToken": "my_nextPageToken",
* // "reports": []
* // }
* }
*
* 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.
*/
listreports(params: Params$Resource$Reports$Listreports, options: StreamMethodOptions): GaxiosPromise<Readable>;
listreports(params?: Params$Resource$Reports$Listreports, options?: MethodOptions): GaxiosPromise<Schema$ListReportsResponse>;
listreports(params: Params$Resource$Reports$Listreports, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
listreports(params: Params$Resource$Reports$Listreports, options: MethodOptions | BodyResponseCallback<Schema$ListReportsResponse>, callback: BodyResponseCallback<Schema$ListReportsResponse>): void;
listreports(params: Params$Resource$Reports$Listreports, callback: BodyResponseCallback<Schema$ListReportsResponse>): void;
listreports(callback: BodyResponseCallback<Schema$ListReportsResponse>): void;
}
export interface Params$Resource$Reports$Listreports extends StandardParameters {
/**
* Maximum number of results per page. Must be between 1 and 100. Defaults to 100 if unspecified.
*/
pageSize?: number;
/**
* Optional pagination token.
*/
pageToken?: string;
/**
* Query ID with which the reports are associated.
*/
queryId?: string;
}
export {};
}