v2.d.ts
51.8 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
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
/// <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 doubleclicksearch_v2 {
export interface Options extends GlobalOptions {
version: 'v2';
}
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;
}
/**
* Search Ads 360 API
*
* The Search Ads 360 API allows developers to automate uploading conversions and downloading reports from Search Ads 360.
*
* @example
* ```js
* const {google} = require('googleapis');
* const doubleclicksearch = google.doubleclicksearch('v2');
* ```
*/
export class Doubleclicksearch {
context: APIRequestContext;
conversion: Resource$Conversion;
reports: Resource$Reports;
savedColumns: Resource$Savedcolumns;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* A message containing availability data relevant to DoubleClick Search.
*/
export interface Schema$Availability {
/**
* DS advertiser ID.
*/
advertiserId?: string | null;
/**
* DS agency ID.
*/
agencyId?: string | null;
/**
* The time by which all conversions have been uploaded, in epoch millis UTC.
*/
availabilityTimestamp?: string | null;
/**
* The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
*/
segmentationId?: string | null;
/**
* The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
*/
segmentationName?: string | null;
/**
* The segmentation type that this availability is for (its default value is `FLOODLIGHT`).
*/
segmentationType?: string | null;
}
/**
* A conversion containing data relevant to DoubleClick Search.
*/
export interface Schema$Conversion {
/**
* DS ad group ID.
*/
adGroupId?: string | null;
/**
* DS ad ID.
*/
adId?: string | null;
/**
* DS advertiser ID.
*/
advertiserId?: string | null;
/**
* DS agency ID.
*/
agencyId?: string | null;
/**
* Available to advertisers only after contacting DoubleClick Search customer support.
*/
attributionModel?: string | null;
/**
* DS campaign ID.
*/
campaignId?: string | null;
/**
* Sales channel for the product. Acceptable values are: - "`local`": a physical store - "`online`": an online store
*/
channel?: string | null;
/**
* DS click ID for the conversion.
*/
clickId?: string | null;
/**
* For offline conversions, advertisers provide this ID. Advertisers can specify any ID that is meaningful to them. Each conversion in a request must specify a unique ID, and the combination of ID and timestamp must be unique amongst all conversions within the advertiser. For online conversions, DS copies the `dsConversionId` or `floodlightOrderId` into this property depending on the advertiser's Floodlight instructions.
*/
conversionId?: string | null;
/**
* The time at which the conversion was last modified, in epoch millis UTC.
*/
conversionModifiedTimestamp?: string | null;
/**
* The time at which the conversion took place, in epoch millis UTC.
*/
conversionTimestamp?: string | null;
/**
* Available to advertisers only after contacting DoubleClick Search customer support.
*/
countMillis?: string | null;
/**
* DS criterion (keyword) ID.
*/
criterionId?: string | null;
/**
* The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format.
*/
currencyCode?: string | null;
/**
* Custom dimensions for the conversion, which can be used to filter data in a report.
*/
customDimension?: Schema$CustomDimension[];
/**
* Custom metrics for the conversion.
*/
customMetric?: Schema$CustomMetric[];
/**
* The type of device on which the conversion occurred.
*/
deviceType?: string | null;
/**
* ID that DoubleClick Search generates for each conversion.
*/
dsConversionId?: string | null;
/**
* DS engine account ID.
*/
engineAccountId?: string | null;
/**
* The Floodlight order ID provided by the advertiser for the conversion.
*/
floodlightOrderId?: string | null;
/**
* ID that DS generates and uses to uniquely identify the inventory account that contains the product.
*/
inventoryAccountId?: string | null;
/**
* The country registered for the Merchant Center feed that contains the product. Use an ISO 3166 code to specify a country.
*/
productCountry?: string | null;
/**
* DS product group ID.
*/
productGroupId?: string | null;
/**
* The product ID (SKU).
*/
productId?: string | null;
/**
* The language registered for the Merchant Center feed that contains the product. Use an ISO 639 code to specify a language.
*/
productLanguage?: string | null;
/**
* The quantity of this conversion, in millis.
*/
quantityMillis?: string | null;
/**
* The revenue amount of this `TRANSACTION` conversion, in micros (value multiplied by 1000000, no decimal). For example, to specify a revenue value of "10" enter "10000000" (10 million) in your request.
*/
revenueMicros?: string | null;
/**
* The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
*/
segmentationId?: string | null;
/**
* The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
*/
segmentationName?: string | null;
/**
* The segmentation type of this conversion (for example, `FLOODLIGHT`).
*/
segmentationType?: string | null;
/**
* The state of the conversion, that is, either `ACTIVE` or `REMOVED`. Note: state DELETED is deprecated.
*/
state?: string | null;
/**
* The ID of the local store for which the product was advertised. Applicable only when the channel is "`local`".
*/
storeId?: string | null;
/**
* The type of the conversion, that is, either `ACTION` or `TRANSACTION`. An `ACTION` conversion is an action by the user that has no monetarily quantifiable value, while a `TRANSACTION` conversion is an action that does have a monetarily quantifiable value. Examples are email list signups (`ACTION`) versus ecommerce purchases (`TRANSACTION`).
*/
type?: string | null;
}
/**
* A list of conversions.
*/
export interface Schema$ConversionList {
/**
* The conversions being requested.
*/
conversion?: Schema$Conversion[];
/**
* Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.
*/
kind?: string | null;
}
/**
* A message containing the custom dimension.
*/
export interface Schema$CustomDimension {
/**
* Custom dimension name.
*/
name?: string | null;
/**
* Custom dimension value.
*/
value?: string | null;
}
/**
* A message containing the custom metric.
*/
export interface Schema$CustomMetric {
/**
* Custom metric name.
*/
name?: string | null;
/**
* Custom metric numeric value.
*/
value?: number | null;
}
/**
* A DoubleClick Search report. This object contains the report request, some report metadata such as currency code, and the generated report rows or report files.
*/
export interface Schema$Report {
/**
* Asynchronous report only. Contains a list of generated report files once the report has successfully completed.
*/
files?: Array<{
byteCount?: string;
url?: string;
}> | null;
/**
* Asynchronous report only. Id of the report.
*/
id?: string | null;
/**
* Asynchronous report only. True if and only if the report has completed successfully and the report files are ready to be downloaded.
*/
isReportReady?: boolean | null;
/**
* Identifies this as a Report resource. Value: the fixed string `doubleclicksearch#report`.
*/
kind?: string | null;
/**
* The request that created the report. Optional fields not specified in the original request are filled with default values.
*/
request?: Schema$ReportRequest;
/**
* The number of report rows generated by the report, not including headers.
*/
rowCount?: number | null;
/**
* Synchronous report only. Generated report rows.
*/
rows?: Schema$ReportRow[];
/**
* The currency code of all monetary values produced in the report, including values that are set by users (e.g., keyword bid settings) and metrics (e.g., cost and revenue). The currency code of a report is determined by the `statisticsCurrency` field of the report request.
*/
statisticsCurrencyCode?: string | null;
/**
* If all statistics of the report are sourced from the same time zone, this would be it. Otherwise the field is unset.
*/
statisticsTimeZone?: string | null;
}
/**
* A request object used to create a DoubleClick Search report.
*/
export interface Schema$ReportApiColumnSpec {
/**
* Name of a DoubleClick Search column to include in the report.
*/
columnName?: string | null;
/**
* Segments a report by a custom dimension. The report must be scoped to an advertiser or lower, and the custom dimension must already be set up in DoubleClick Search. The custom dimension name, which appears in DoubleClick Search, is case sensitive.\ If used in a conversion report, returns the value of the specified custom dimension for the given conversion, if set. This column does not segment the conversion report.
*/
customDimensionName?: string | null;
/**
* Name of a custom metric to include in the report. The report must be scoped to an advertiser or lower, and the custom metric must already be set up in DoubleClick Search. The custom metric name, which appears in DoubleClick Search, is case sensitive.
*/
customMetricName?: string | null;
/**
* Inclusive day in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with `startDate`.
*/
endDate?: string | null;
/**
* Synchronous report only. Set to `true` to group by this column. Defaults to `false`.
*/
groupByColumn?: boolean | null;
/**
* Text used to identify this column in the report output; defaults to `columnName` or `savedColumnName` when not specified. This can be used to prevent collisions between DoubleClick Search columns and saved columns with the same name.
*/
headerText?: string | null;
/**
* The platform that is used to provide data for the custom dimension. Acceptable values are "floodlight".
*/
platformSource?: string | null;
/**
* Returns metrics only for a specific type of product activity. Accepted values are: - "`sold`": returns metrics only for products that were sold - "`advertised`": returns metrics only for products that were advertised in a Shopping campaign, and that might or might not have been sold
*/
productReportPerspective?: string | null;
/**
* Name of a saved column to include in the report. The report must be scoped at advertiser or lower, and this saved column must already be created in the DoubleClick Search UI.
*/
savedColumnName?: string | null;
/**
* Inclusive date in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with `endDate`.
*/
startDate?: string | null;
}
/**
* A request object used to create a DoubleClick Search report.
*/
export interface Schema$ReportRequest {
/**
* The columns to include in the report. This includes both DoubleClick Search columns and saved columns. For DoubleClick Search columns, only the `columnName` parameter is required. For saved columns only the `savedColumnName` parameter is required. Both `columnName` and `savedColumnName` cannot be set in the same stanza.\ The maximum number of columns per request is 300.
*/
columns?: Schema$ReportApiColumnSpec[];
/**
* Format that the report should be returned in. Currently `csv` or `tsv` is supported.
*/
downloadFormat?: string | null;
/**
* A list of filters to be applied to the report.\ The maximum number of filters per request is 300.
*/
filters?: Array<{
column?: Schema$ReportApiColumnSpec;
operator?: string;
values?: any[];
}> | null;
/**
* Determines if removed entities should be included in the report. Defaults to `false`. Deprecated, please use `includeRemovedEntities` instead.
*/
includeDeletedEntities?: boolean | null;
/**
* Determines if removed entities should be included in the report. Defaults to `false`.
*/
includeRemovedEntities?: boolean | null;
/**
* Asynchronous report only. The maximum number of rows per report file. A large report is split into many files based on this field. Acceptable values are `1000000` to `100000000`, inclusive.
*/
maxRowsPerFile?: number | null;
/**
* Synchronous report only. A list of columns and directions defining sorting to be performed on the report rows.\ The maximum number of orderings per request is 300.
*/
orderBy?: Array<{
column?: Schema$ReportApiColumnSpec;
sortOrder?: string;
}> | null;
/**
* The reportScope is a set of IDs that are used to determine which subset of entities will be returned in the report. The full lineage of IDs from the lowest scoped level desired up through agency is required.
*/
reportScope?: {
adGroupId?: string;
adId?: string;
advertiserId?: string;
agencyId?: string;
campaignId?: string;
engineAccountId?: string;
keywordId?: string;
} | null;
/**
* Determines the type of rows that are returned in the report. For example, if you specify `reportType: keyword`, each row in the report will contain data about a keyword. See the [Types of Reports](/search-ads/v2/report-types/) reference for the columns that are available for each type.
*/
reportType?: string | null;
/**
* Synchronous report only. The maximum number of rows to return; additional rows are dropped. Acceptable values are `0` to `10000`, inclusive. Defaults to `10000`.
*/
rowCount?: number | null;
/**
* Synchronous report only. Zero-based index of the first row to return. Acceptable values are `0` to `50000`, inclusive. Defaults to `0`.
*/
startRow?: number | null;
/**
* Specifies the currency in which monetary will be returned. Possible values are: `usd`, `agency` (valid if the report is scoped to agency or lower), `advertiser` (valid if the report is scoped to * advertiser or lower), or `account` (valid if the report is scoped to engine account or lower).
*/
statisticsCurrency?: string | null;
/**
* If metrics are requested in a report, this argument will be used to restrict the metrics to a specific time range.
*/
timeRange?: {
changedAttributesSinceTimestamp?: string;
changedMetricsSinceTimestamp?: string;
endDate?: string;
startDate?: string;
} | null;
/**
* If `true`, the report would only be created if all the requested stat data are sourced from a single timezone. Defaults to `false`.
*/
verifySingleTimeZone?: boolean | null;
}
/**
* A row in a DoubleClick Search report.
*/
export interface Schema$ReportRow {
}
/**
* A saved column
*/
export interface Schema$SavedColumn {
/**
* Identifies this as a SavedColumn resource. Value: the fixed string doubleclicksearch#savedColumn.
*/
kind?: string | null;
/**
* The name of the saved column.
*/
savedColumnName?: string | null;
/**
* The type of data this saved column will produce.
*/
type?: string | null;
}
/**
* A list of saved columns. Advertisers create saved columns to report on Floodlight activities, Google Analytics goals, or custom KPIs. To request reports with saved columns, you'll need the saved column names that are available from this list.
*/
export interface Schema$SavedColumnList {
/**
* The saved columns being requested.
*/
items?: Schema$SavedColumn[];
/**
* Identifies this as a SavedColumnList resource. Value: the fixed string doubleclicksearch#savedColumnList.
*/
kind?: string | null;
}
/**
* The request to update availability.
*/
export interface Schema$UpdateAvailabilityRequest {
/**
* The availabilities being requested.
*/
availabilities?: Schema$Availability[];
}
/**
* The response to a update availability request.
*/
export interface Schema$UpdateAvailabilityResponse {
/**
* The availabilities being returned.
*/
availabilities?: Schema$Availability[];
}
export class Resource$Conversion {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Retrieves a list of conversions from a DoubleClick Search engine account.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/doubleclicksearch.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 doubleclicksearch = google.doubleclicksearch('v2');
*
* 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/doubleclicksearch'],
* });
*
* // 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 doubleclicksearch.conversion.get({
* // Numeric ID of the ad group.
* adGroupId: 'placeholder-value',
* // Numeric ID of the ad.
* adId: 'placeholder-value',
* // Numeric ID of the advertiser.
* advertiserId: 'placeholder-value',
* // Numeric ID of the agency.
* agencyId: 'placeholder-value',
* // Numeric ID of the campaign.
* campaignId: 'placeholder-value',
* // Numeric ID of the criterion.
* criterionId: 'placeholder-value',
* // Last date (inclusive) on which to retrieve conversions. Format is yyyymmdd.
* endDate: 'placeholder-value',
* // Numeric ID of the engine account.
* engineAccountId: 'placeholder-value',
* // The number of conversions to return per call.
* rowCount: 'placeholder-value',
* // First date (inclusive) on which to retrieve conversions. Format is yyyymmdd.
* startDate: 'placeholder-value',
* // The 0-based starting index for retrieving conversions results.
* startRow: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "conversion": [],
* // "kind": "my_kind"
* // }
* }
*
* 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$Conversion$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Conversion$Get, options?: MethodOptions): GaxiosPromise<Schema$ConversionList>;
get(params: Params$Resource$Conversion$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Conversion$Get, options: MethodOptions | BodyResponseCallback<Schema$ConversionList>, callback: BodyResponseCallback<Schema$ConversionList>): void;
get(params: Params$Resource$Conversion$Get, callback: BodyResponseCallback<Schema$ConversionList>): void;
get(callback: BodyResponseCallback<Schema$ConversionList>): void;
/**
* Inserts a batch of new conversions into DoubleClick Search.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/doubleclicksearch.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 doubleclicksearch = google.doubleclicksearch('v2');
*
* 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/doubleclicksearch'],
* });
*
* // 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 doubleclicksearch.conversion.insert({
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "conversion": [],
* // "kind": "my_kind"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "conversion": [],
* // "kind": "my_kind"
* // }
* }
*
* 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.
*/
insert(params: Params$Resource$Conversion$Insert, options: StreamMethodOptions): GaxiosPromise<Readable>;
insert(params?: Params$Resource$Conversion$Insert, options?: MethodOptions): GaxiosPromise<Schema$ConversionList>;
insert(params: Params$Resource$Conversion$Insert, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
insert(params: Params$Resource$Conversion$Insert, options: MethodOptions | BodyResponseCallback<Schema$ConversionList>, callback: BodyResponseCallback<Schema$ConversionList>): void;
insert(params: Params$Resource$Conversion$Insert, callback: BodyResponseCallback<Schema$ConversionList>): void;
insert(callback: BodyResponseCallback<Schema$ConversionList>): void;
/**
* Updates a batch of conversions in DoubleClick Search.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/doubleclicksearch.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 doubleclicksearch = google.doubleclicksearch('v2');
*
* 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/doubleclicksearch'],
* });
*
* // 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 doubleclicksearch.conversion.update({
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "conversion": [],
* // "kind": "my_kind"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "conversion": [],
* // "kind": "my_kind"
* // }
* }
*
* 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.
*/
update(params: Params$Resource$Conversion$Update, options: StreamMethodOptions): GaxiosPromise<Readable>;
update(params?: Params$Resource$Conversion$Update, options?: MethodOptions): GaxiosPromise<Schema$ConversionList>;
update(params: Params$Resource$Conversion$Update, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
update(params: Params$Resource$Conversion$Update, options: MethodOptions | BodyResponseCallback<Schema$ConversionList>, callback: BodyResponseCallback<Schema$ConversionList>): void;
update(params: Params$Resource$Conversion$Update, callback: BodyResponseCallback<Schema$ConversionList>): void;
update(callback: BodyResponseCallback<Schema$ConversionList>): void;
/**
* Updates the availabilities of a batch of floodlight activities in DoubleClick Search.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/doubleclicksearch.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 doubleclicksearch = google.doubleclicksearch('v2');
*
* 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/doubleclicksearch'],
* });
*
* // 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 doubleclicksearch.conversion.updateAvailability({
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "availabilities": []
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "availabilities": []
* // }
* }
*
* 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.
*/
updateAvailability(params: Params$Resource$Conversion$Updateavailability, options: StreamMethodOptions): GaxiosPromise<Readable>;
updateAvailability(params?: Params$Resource$Conversion$Updateavailability, options?: MethodOptions): GaxiosPromise<Schema$UpdateAvailabilityResponse>;
updateAvailability(params: Params$Resource$Conversion$Updateavailability, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
updateAvailability(params: Params$Resource$Conversion$Updateavailability, options: MethodOptions | BodyResponseCallback<Schema$UpdateAvailabilityResponse>, callback: BodyResponseCallback<Schema$UpdateAvailabilityResponse>): void;
updateAvailability(params: Params$Resource$Conversion$Updateavailability, callback: BodyResponseCallback<Schema$UpdateAvailabilityResponse>): void;
updateAvailability(callback: BodyResponseCallback<Schema$UpdateAvailabilityResponse>): void;
}
export interface Params$Resource$Conversion$Get extends StandardParameters {
/**
* Numeric ID of the ad group.
*/
adGroupId?: string;
/**
* Numeric ID of the ad.
*/
adId?: string;
/**
* Numeric ID of the advertiser.
*/
advertiserId?: string;
/**
* Numeric ID of the agency.
*/
agencyId?: string;
/**
* Numeric ID of the campaign.
*/
campaignId?: string;
/**
* Numeric ID of the criterion.
*/
criterionId?: string;
/**
* Last date (inclusive) on which to retrieve conversions. Format is yyyymmdd.
*/
endDate?: number;
/**
* Numeric ID of the engine account.
*/
engineAccountId?: string;
/**
* The number of conversions to return per call.
*/
rowCount?: number;
/**
* First date (inclusive) on which to retrieve conversions. Format is yyyymmdd.
*/
startDate?: number;
/**
* The 0-based starting index for retrieving conversions results.
*/
startRow?: number;
}
export interface Params$Resource$Conversion$Insert extends StandardParameters {
/**
* Request body metadata
*/
requestBody?: Schema$ConversionList;
}
export interface Params$Resource$Conversion$Update extends StandardParameters {
/**
* Request body metadata
*/
requestBody?: Schema$ConversionList;
}
export interface Params$Resource$Conversion$Updateavailability extends StandardParameters {
/**
* Request body metadata
*/
requestBody?: Schema$UpdateAvailabilityRequest;
}
export class Resource$Reports {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Generates and returns a report immediately.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/doubleclicksearch.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 doubleclicksearch = google.doubleclicksearch('v2');
*
* 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/doubleclicksearch'],
* });
*
* // 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 doubleclicksearch.reports.generate({
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "columns": [],
* // "downloadFormat": "my_downloadFormat",
* // "filters": [],
* // "includeDeletedEntities": false,
* // "includeRemovedEntities": false,
* // "maxRowsPerFile": 0,
* // "orderBy": [],
* // "reportScope": {},
* // "reportType": "my_reportType",
* // "rowCount": 0,
* // "startRow": 0,
* // "statisticsCurrency": "my_statisticsCurrency",
* // "timeRange": {},
* // "verifySingleTimeZone": false
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "files": [],
* // "id": "my_id",
* // "isReportReady": false,
* // "kind": "my_kind",
* // "request": {},
* // "rowCount": 0,
* // "rows": [],
* // "statisticsCurrencyCode": "my_statisticsCurrencyCode",
* // "statisticsTimeZone": "my_statisticsTimeZone"
* // }
* }
*
* 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$Reports$Generate, options: StreamMethodOptions): GaxiosPromise<Readable>;
generate(params?: Params$Resource$Reports$Generate, options?: MethodOptions): GaxiosPromise<Schema$Report>;
generate(params: Params$Resource$Reports$Generate, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
generate(params: Params$Resource$Reports$Generate, options: MethodOptions | BodyResponseCallback<Schema$Report>, callback: BodyResponseCallback<Schema$Report>): void;
generate(params: Params$Resource$Reports$Generate, callback: BodyResponseCallback<Schema$Report>): void;
generate(callback: BodyResponseCallback<Schema$Report>): void;
/**
* Polls for the status of a report request.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/doubleclicksearch.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 doubleclicksearch = google.doubleclicksearch('v2');
*
* 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/doubleclicksearch'],
* });
*
* // 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 doubleclicksearch.reports.get({
* // ID of the report request being polled.
* reportId: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "files": [],
* // "id": "my_id",
* // "isReportReady": false,
* // "kind": "my_kind",
* // "request": {},
* // "rowCount": 0,
* // "rows": [],
* // "statisticsCurrencyCode": "my_statisticsCurrencyCode",
* // "statisticsTimeZone": "my_statisticsTimeZone"
* // }
* }
*
* 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$Reports$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Reports$Get, options?: MethodOptions): GaxiosPromise<Schema$Report>;
get(params: Params$Resource$Reports$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Reports$Get, options: MethodOptions | BodyResponseCallback<Schema$Report>, callback: BodyResponseCallback<Schema$Report>): void;
get(params: Params$Resource$Reports$Get, callback: BodyResponseCallback<Schema$Report>): void;
get(callback: BodyResponseCallback<Schema$Report>): void;
/**
* Downloads a report file encoded in UTF-8.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/doubleclicksearch.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 doubleclicksearch = google.doubleclicksearch('v2');
*
* 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/doubleclicksearch'],
* });
*
* // 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 doubleclicksearch.reports.getFile({
* // The index of the report fragment to download.
* reportFragment: 'placeholder-value',
* // ID of the report.
* reportId: '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.
*/
getFile(params: Params$Resource$Reports$Getfile, options: StreamMethodOptions): GaxiosPromise<Readable>;
getFile(params?: Params$Resource$Reports$Getfile, options?: MethodOptions): GaxiosPromise<unknown>;
getFile(params: Params$Resource$Reports$Getfile, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
getFile(params: Params$Resource$Reports$Getfile, options: MethodOptions | BodyResponseCallback<unknown>, callback: BodyResponseCallback<unknown>): void;
getFile(params: Params$Resource$Reports$Getfile, callback: BodyResponseCallback<unknown>): void;
getFile(callback: BodyResponseCallback<unknown>): void;
/**
* Inserts a report request into the reporting system.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/doubleclicksearch.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 doubleclicksearch = google.doubleclicksearch('v2');
*
* 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/doubleclicksearch'],
* });
*
* // 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 doubleclicksearch.reports.request({
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "columns": [],
* // "downloadFormat": "my_downloadFormat",
* // "filters": [],
* // "includeDeletedEntities": false,
* // "includeRemovedEntities": false,
* // "maxRowsPerFile": 0,
* // "orderBy": [],
* // "reportScope": {},
* // "reportType": "my_reportType",
* // "rowCount": 0,
* // "startRow": 0,
* // "statisticsCurrency": "my_statisticsCurrency",
* // "timeRange": {},
* // "verifySingleTimeZone": false
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "files": [],
* // "id": "my_id",
* // "isReportReady": false,
* // "kind": "my_kind",
* // "request": {},
* // "rowCount": 0,
* // "rows": [],
* // "statisticsCurrencyCode": "my_statisticsCurrencyCode",
* // "statisticsTimeZone": "my_statisticsTimeZone"
* // }
* }
*
* 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.
*/
request(params: Params$Resource$Reports$Request, options: StreamMethodOptions): GaxiosPromise<Readable>;
request(params?: Params$Resource$Reports$Request, options?: MethodOptions): GaxiosPromise<Schema$Report>;
request(params: Params$Resource$Reports$Request, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
request(params: Params$Resource$Reports$Request, options: MethodOptions | BodyResponseCallback<Schema$Report>, callback: BodyResponseCallback<Schema$Report>): void;
request(params: Params$Resource$Reports$Request, callback: BodyResponseCallback<Schema$Report>): void;
request(callback: BodyResponseCallback<Schema$Report>): void;
}
export interface Params$Resource$Reports$Generate extends StandardParameters {
/**
* Request body metadata
*/
requestBody?: Schema$ReportRequest;
}
export interface Params$Resource$Reports$Get extends StandardParameters {
/**
* ID of the report request being polled.
*/
reportId?: string;
}
export interface Params$Resource$Reports$Getfile extends StandardParameters {
/**
* The index of the report fragment to download.
*/
reportFragment?: number;
/**
* ID of the report.
*/
reportId?: string;
}
export interface Params$Resource$Reports$Request extends StandardParameters {
/**
* Request body metadata
*/
requestBody?: Schema$ReportRequest;
}
export class Resource$Savedcolumns {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Retrieve the list of saved columns for a specified advertiser.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/doubleclicksearch.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 doubleclicksearch = google.doubleclicksearch('v2');
*
* 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/doubleclicksearch'],
* });
*
* // 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 doubleclicksearch.savedColumns.list({
* // DS ID of the advertiser.
* advertiserId: 'placeholder-value',
* // DS ID of the agency.
* agencyId: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "items": [],
* // "kind": "my_kind"
* // }
* }
*
* 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$Savedcolumns$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Savedcolumns$List, options?: MethodOptions): GaxiosPromise<Schema$SavedColumnList>;
list(params: Params$Resource$Savedcolumns$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Savedcolumns$List, options: MethodOptions | BodyResponseCallback<Schema$SavedColumnList>, callback: BodyResponseCallback<Schema$SavedColumnList>): void;
list(params: Params$Resource$Savedcolumns$List, callback: BodyResponseCallback<Schema$SavedColumnList>): void;
list(callback: BodyResponseCallback<Schema$SavedColumnList>): void;
}
export interface Params$Resource$Savedcolumns$List extends StandardParameters {
/**
* DS ID of the advertiser.
*/
advertiserId?: string;
/**
* DS ID of the agency.
*/
agencyId?: string;
}
export {};
}