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
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="doubleclicksearch_v2.html">Search Ads 360 API</a> . <a href="doubleclicksearch_v2.reports.html">reports</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#generate">generate(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Generates and returns a report immediately.</p>
<p class="toc_element">
<code><a href="#get">get(reportId, x__xgafv=None)</a></code></p>
<p class="firstline">Polls for the status of a report request.</p>
<p class="toc_element">
<code><a href="#getFile">getFile(reportId, reportFragment, x__xgafv=None)</a></code></p>
<p class="firstline">Downloads a report file encoded in UTF-8.</p>
<p class="toc_element">
<code><a href="#getFile_media">getFile_media(reportId, reportFragment, x__xgafv=None)</a></code></p>
<p class="firstline">Downloads a report file encoded in UTF-8.</p>
<p class="toc_element">
<code><a href="#getIdMappingFile">getIdMappingFile(agencyId, advertiserId, x__xgafv=None)</a></code></p>
<p class="firstline">Downloads a csv file(encoded in UTF-8) that contains ID mappings between legacy SA360 and new SA360. The file includes all children entities of the given advertiser(e.g. engine accounts, campaigns, ad groups, etc.) that exist in both legacy SA360 and new SA360.</p>
<p class="toc_element">
<code><a href="#getIdMappingFile_media">getIdMappingFile_media(agencyId, advertiserId, x__xgafv=None)</a></code></p>
<p class="firstline">Downloads a csv file(encoded in UTF-8) that contains ID mappings between legacy SA360 and new SA360. The file includes all children entities of the given advertiser(e.g. engine accounts, campaigns, ad groups, etc.) that exist in both legacy SA360 and new SA360.</p>
<p class="toc_element">
<code><a href="#request">request(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Inserts a report request into the reporting system.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="generate">generate(body=None, x__xgafv=None)</code>
<pre>Generates and returns a report immediately.
Args:
body: object, The request body.
The object takes the form of:
{ # A request object used to create a DoubleClick Search report.
"columns": [ # 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.
{ # A request object used to create a DoubleClick Search report.
"columnName": "A String", # Name of a DoubleClick Search column to include in the report.
"customDimensionName": "A String", # 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.
"customMetricName": "A String", # 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.
"endDate": "A String", # 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`.
"groupByColumn": True or False, # Synchronous report only. Set to `true` to group by this column. Defaults to `false`.
"headerText": "A String", # 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.
"platformSource": "A String", # The platform that is used to provide data for the custom dimension. Acceptable values are "floodlight".
"productReportPerspective": "A String", # 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
"savedColumnName": "A String", # 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.
"startDate": "A String", # 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`.
},
],
"downloadFormat": "A String", # Format that the report should be returned in. Currently `csv` or `tsv` is supported.
"filters": [ # A list of filters to be applied to the report.\ The maximum number of filters per request is 300.
{
"column": { # A request object used to create a DoubleClick Search report. # Column to perform the filter on. This can be a DoubleClick Search column or a saved column.
"columnName": "A String", # Name of a DoubleClick Search column to include in the report.
"customDimensionName": "A String", # 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.
"customMetricName": "A String", # 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.
"endDate": "A String", # 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`.
"groupByColumn": True or False, # Synchronous report only. Set to `true` to group by this column. Defaults to `false`.
"headerText": "A String", # 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.
"platformSource": "A String", # The platform that is used to provide data for the custom dimension. Acceptable values are "floodlight".
"productReportPerspective": "A String", # 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
"savedColumnName": "A String", # 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.
"startDate": "A String", # 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`.
},
"operator": "A String", # Operator to use in the filter. See the filter reference for a list of available operators.
"values": [ # A list of values to filter the column value against.\ The maximum number of filter values per request is 300.
"",
],
},
],
"includeDeletedEntities": True or False, # Determines if removed entities should be included in the report. Defaults to `false`. Deprecated, please use `includeRemovedEntities` instead.
"includeRemovedEntities": True or False, # Determines if removed entities should be included in the report. Defaults to `false`.
"maxRowsPerFile": 42, # 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.
"orderBy": [ # 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.
{
"column": { # A request object used to create a DoubleClick Search report. # Column to perform the sort on. This can be a DoubleClick Search-defined column or a saved column.
"columnName": "A String", # Name of a DoubleClick Search column to include in the report.
"customDimensionName": "A String", # 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.
"customMetricName": "A String", # 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.
"endDate": "A String", # 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`.
"groupByColumn": True or False, # Synchronous report only. Set to `true` to group by this column. Defaults to `false`.
"headerText": "A String", # 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.
"platformSource": "A String", # The platform that is used to provide data for the custom dimension. Acceptable values are "floodlight".
"productReportPerspective": "A String", # 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
"savedColumnName": "A String", # 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.
"startDate": "A String", # 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`.
},
"sortOrder": "A String", # The sort direction, which is either `ascending` or `descending`.
},
],
"reportScope": { # 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.
"adGroupId": "A String", # DS ad group ID.
"adId": "A String", # DS ad ID.
"advertiserId": "A String", # DS advertiser ID.
"agencyId": "A String", # DS agency ID.
"campaignId": "A String", # DS campaign ID.
"engineAccountId": "A String", # DS engine account ID.
"keywordId": "A String", # DS keyword ID.
},
"reportType": "A String", # 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.
"rowCount": 42, # Synchronous report only. The maximum number of rows to return; additional rows are dropped. Acceptable values are `0` to `10000`, inclusive. Defaults to `10000`.
"startRow": 42, # Synchronous report only. Zero-based index of the first row to return. Acceptable values are `0` to `50000`, inclusive. Defaults to `0`.
"statisticsCurrency": "A String", # 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).
"timeRange": { # If metrics are requested in a report, this argument will be used to restrict the metrics to a specific time range.
"changedAttributesSinceTimestamp": "A String", # Inclusive UTC timestamp in RFC format, e.g., `2013-07-16T10:16:23.555Z`. See additional references on how changed attribute reports work.
"changedMetricsSinceTimestamp": "A String", # Inclusive UTC timestamp in RFC format, e.g., `2013-07-16T10:16:23.555Z`. See additional references on how changed metrics reports work.
"endDate": "A String", # Inclusive date in YYYY-MM-DD format.
"startDate": "A String", # Inclusive date in YYYY-MM-DD format.
},
"verifySingleTimeZone": True or False, # If `true`, the report would only be created if all the requested stat data are sourced from a single timezone. Defaults to `false`.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 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.
"files": [ # Asynchronous report only. Contains a list of generated report files once the report has successfully completed.
{
"byteCount": "A String", # The size of this report file in bytes.
"url": "A String", # Use this url to download the report file.
},
],
"id": "A String", # Asynchronous report only. Id of the report.
"isReportReady": True or False, # Asynchronous report only. True if and only if the report has completed successfully and the report files are ready to be downloaded.
"kind": "A String", # Identifies this as a Report resource. Value: the fixed string `doubleclicksearch#report`.
"request": { # A request object used to create a DoubleClick Search report. # The request that created the report. Optional fields not specified in the original request are filled with default values.
"columns": [ # 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.
{ # A request object used to create a DoubleClick Search report.
"columnName": "A String", # Name of a DoubleClick Search column to include in the report.
"customDimensionName": "A String", # 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.
"customMetricName": "A String", # 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.
"endDate": "A String", # 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`.
"groupByColumn": True or False, # Synchronous report only. Set to `true` to group by this column. Defaults to `false`.
"headerText": "A String", # 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.
"platformSource": "A String", # The platform that is used to provide data for the custom dimension. Acceptable values are "floodlight".
"productReportPerspective": "A String", # 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
"savedColumnName": "A String", # 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.
"startDate": "A String", # 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`.
},
],
"downloadFormat": "A String", # Format that the report should be returned in. Currently `csv` or `tsv` is supported.
"filters": [ # A list of filters to be applied to the report.\ The maximum number of filters per request is 300.
{
"column": { # A request object used to create a DoubleClick Search report. # Column to perform the filter on. This can be a DoubleClick Search column or a saved column.
"columnName": "A String", # Name of a DoubleClick Search column to include in the report.
"customDimensionName": "A String", # 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.
"customMetricName": "A String", # 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.
"endDate": "A String", # 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`.
"groupByColumn": True or False, # Synchronous report only. Set to `true` to group by this column. Defaults to `false`.
"headerText": "A String", # 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.
"platformSource": "A String", # The platform that is used to provide data for the custom dimension. Acceptable values are "floodlight".
"productReportPerspective": "A String", # 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
"savedColumnName": "A String", # 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.
"startDate": "A String", # 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`.
},
"operator": "A String", # Operator to use in the filter. See the filter reference for a list of available operators.
"values": [ # A list of values to filter the column value against.\ The maximum number of filter values per request is 300.
"",
],
},
],
"includeDeletedEntities": True or False, # Determines if removed entities should be included in the report. Defaults to `false`. Deprecated, please use `includeRemovedEntities` instead.
"includeRemovedEntities": True or False, # Determines if removed entities should be included in the report. Defaults to `false`.
"maxRowsPerFile": 42, # 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.
"orderBy": [ # 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.
{
"column": { # A request object used to create a DoubleClick Search report. # Column to perform the sort on. This can be a DoubleClick Search-defined column or a saved column.
"columnName": "A String", # Name of a DoubleClick Search column to include in the report.
"customDimensionName": "A String", # 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.
"customMetricName": "A String", # 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.
"endDate": "A String", # 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`.
"groupByColumn": True or False, # Synchronous report only. Set to `true` to group by this column. Defaults to `false`.
"headerText": "A String", # 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.
"platformSource": "A String", # The platform that is used to provide data for the custom dimension. Acceptable values are "floodlight".
"productReportPerspective": "A String", # 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
"savedColumnName": "A String", # 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.
"startDate": "A String", # 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`.
},
"sortOrder": "A String", # The sort direction, which is either `ascending` or `descending`.
},
],
"reportScope": { # 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.
"adGroupId": "A String", # DS ad group ID.
"adId": "A String", # DS ad ID.
"advertiserId": "A String", # DS advertiser ID.
"agencyId": "A String", # DS agency ID.
"campaignId": "A String", # DS campaign ID.
"engineAccountId": "A String", # DS engine account ID.
"keywordId": "A String", # DS keyword ID.
},
"reportType": "A String", # 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.
"rowCount": 42, # Synchronous report only. The maximum number of rows to return; additional rows are dropped. Acceptable values are `0` to `10000`, inclusive. Defaults to `10000`.
"startRow": 42, # Synchronous report only. Zero-based index of the first row to return. Acceptable values are `0` to `50000`, inclusive. Defaults to `0`.
"statisticsCurrency": "A String", # 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).
"timeRange": { # If metrics are requested in a report, this argument will be used to restrict the metrics to a specific time range.
"changedAttributesSinceTimestamp": "A String", # Inclusive UTC timestamp in RFC format, e.g., `2013-07-16T10:16:23.555Z`. See additional references on how changed attribute reports work.
"changedMetricsSinceTimestamp": "A String", # Inclusive UTC timestamp in RFC format, e.g., `2013-07-16T10:16:23.555Z`. See additional references on how changed metrics reports work.
"endDate": "A String", # Inclusive date in YYYY-MM-DD format.
"startDate": "A String", # Inclusive date in YYYY-MM-DD format.
},
"verifySingleTimeZone": True or False, # If `true`, the report would only be created if all the requested stat data are sourced from a single timezone. Defaults to `false`.
},
"rowCount": 42, # The number of report rows generated by the report, not including headers.
"rows": [ # Synchronous report only. Generated report rows.
{ # A row in a DoubleClick Search report.
"a_key": "", # Indicates the columns that are represented in this row. That is, each key corresponds to a column with a non-empty cell in this row.
},
],
"statisticsCurrencyCode": "A String", # 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.
"statisticsTimeZone": "A String", # If all statistics of the report are sourced from the same time zone, this would be it. Otherwise the field is unset.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(reportId, x__xgafv=None)</code>
<pre>Polls for the status of a report request.
Args:
reportId: string, ID of the report request being polled. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 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.
"files": [ # Asynchronous report only. Contains a list of generated report files once the report has successfully completed.
{
"byteCount": "A String", # The size of this report file in bytes.
"url": "A String", # Use this url to download the report file.
},
],
"id": "A String", # Asynchronous report only. Id of the report.
"isReportReady": True or False, # Asynchronous report only. True if and only if the report has completed successfully and the report files are ready to be downloaded.
"kind": "A String", # Identifies this as a Report resource. Value: the fixed string `doubleclicksearch#report`.
"request": { # A request object used to create a DoubleClick Search report. # The request that created the report. Optional fields not specified in the original request are filled with default values.
"columns": [ # 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.
{ # A request object used to create a DoubleClick Search report.
"columnName": "A String", # Name of a DoubleClick Search column to include in the report.
"customDimensionName": "A String", # 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.
"customMetricName": "A String", # 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.
"endDate": "A String", # 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`.
"groupByColumn": True or False, # Synchronous report only. Set to `true` to group by this column. Defaults to `false`.
"headerText": "A String", # 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.
"platformSource": "A String", # The platform that is used to provide data for the custom dimension. Acceptable values are "floodlight".
"productReportPerspective": "A String", # 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
"savedColumnName": "A String", # 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.
"startDate": "A String", # 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`.
},
],
"downloadFormat": "A String", # Format that the report should be returned in. Currently `csv` or `tsv` is supported.
"filters": [ # A list of filters to be applied to the report.\ The maximum number of filters per request is 300.
{
"column": { # A request object used to create a DoubleClick Search report. # Column to perform the filter on. This can be a DoubleClick Search column or a saved column.
"columnName": "A String", # Name of a DoubleClick Search column to include in the report.
"customDimensionName": "A String", # 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.
"customMetricName": "A String", # 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.
"endDate": "A String", # 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`.
"groupByColumn": True or False, # Synchronous report only. Set to `true` to group by this column. Defaults to `false`.
"headerText": "A String", # 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.
"platformSource": "A String", # The platform that is used to provide data for the custom dimension. Acceptable values are "floodlight".
"productReportPerspective": "A String", # 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
"savedColumnName": "A String", # 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.
"startDate": "A String", # 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`.
},
"operator": "A String", # Operator to use in the filter. See the filter reference for a list of available operators.
"values": [ # A list of values to filter the column value against.\ The maximum number of filter values per request is 300.
"",
],
},
],
"includeDeletedEntities": True or False, # Determines if removed entities should be included in the report. Defaults to `false`. Deprecated, please use `includeRemovedEntities` instead.
"includeRemovedEntities": True or False, # Determines if removed entities should be included in the report. Defaults to `false`.
"maxRowsPerFile": 42, # 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.
"orderBy": [ # 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.
{
"column": { # A request object used to create a DoubleClick Search report. # Column to perform the sort on. This can be a DoubleClick Search-defined column or a saved column.
"columnName": "A String", # Name of a DoubleClick Search column to include in the report.
"customDimensionName": "A String", # 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.
"customMetricName": "A String", # 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.
"endDate": "A String", # 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`.
"groupByColumn": True or False, # Synchronous report only. Set to `true` to group by this column. Defaults to `false`.
"headerText": "A String", # 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.
"platformSource": "A String", # The platform that is used to provide data for the custom dimension. Acceptable values are "floodlight".
"productReportPerspective": "A String", # 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
"savedColumnName": "A String", # 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.
"startDate": "A String", # 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`.
},
"sortOrder": "A String", # The sort direction, which is either `ascending` or `descending`.
},
],
"reportScope": { # 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.
"adGroupId": "A String", # DS ad group ID.
"adId": "A String", # DS ad ID.
"advertiserId": "A String", # DS advertiser ID.
"agencyId": "A String", # DS agency ID.
"campaignId": "A String", # DS campaign ID.
"engineAccountId": "A String", # DS engine account ID.
"keywordId": "A String", # DS keyword ID.
},
"reportType": "A String", # 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.
"rowCount": 42, # Synchronous report only. The maximum number of rows to return; additional rows are dropped. Acceptable values are `0` to `10000`, inclusive. Defaults to `10000`.
"startRow": 42, # Synchronous report only. Zero-based index of the first row to return. Acceptable values are `0` to `50000`, inclusive. Defaults to `0`.
"statisticsCurrency": "A String", # 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).
"timeRange": { # If metrics are requested in a report, this argument will be used to restrict the metrics to a specific time range.
"changedAttributesSinceTimestamp": "A String", # Inclusive UTC timestamp in RFC format, e.g., `2013-07-16T10:16:23.555Z`. See additional references on how changed attribute reports work.
"changedMetricsSinceTimestamp": "A String", # Inclusive UTC timestamp in RFC format, e.g., `2013-07-16T10:16:23.555Z`. See additional references on how changed metrics reports work.
"endDate": "A String", # Inclusive date in YYYY-MM-DD format.
"startDate": "A String", # Inclusive date in YYYY-MM-DD format.
},
"verifySingleTimeZone": True or False, # If `true`, the report would only be created if all the requested stat data are sourced from a single timezone. Defaults to `false`.
},
"rowCount": 42, # The number of report rows generated by the report, not including headers.
"rows": [ # Synchronous report only. Generated report rows.
{ # A row in a DoubleClick Search report.
"a_key": "", # Indicates the columns that are represented in this row. That is, each key corresponds to a column with a non-empty cell in this row.
},
],
"statisticsCurrencyCode": "A String", # 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.
"statisticsTimeZone": "A String", # If all statistics of the report are sourced from the same time zone, this would be it. Otherwise the field is unset.
}</pre>
</div>
<div class="method">
<code class="details" id="getFile">getFile(reportId, reportFragment, x__xgafv=None)</code>
<pre>Downloads a report file encoded in UTF-8.
Args:
reportId: string, ID of the report. (required)
reportFragment: integer, The index of the report fragment to download. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
</pre>
</div>
<div class="method">
<code class="details" id="getFile_media">getFile_media(reportId, reportFragment, x__xgafv=None)</code>
<pre>Downloads a report file encoded in UTF-8.
Args:
reportId: string, ID of the report. (required)
reportFragment: integer, The index of the report fragment to download. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
</pre>
</div>
<div class="method">
<code class="details" id="getIdMappingFile">getIdMappingFile(agencyId, advertiserId, x__xgafv=None)</code>
<pre>Downloads a csv file(encoded in UTF-8) that contains ID mappings between legacy SA360 and new SA360. The file includes all children entities of the given advertiser(e.g. engine accounts, campaigns, ad groups, etc.) that exist in both legacy SA360 and new SA360.
Args:
agencyId: string, Legacy SA360 agency ID. (required)
advertiserId: string, Legacy SA360 advertiser ID. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # File returned to https://developers.google.com/search-ads/v2/reference/reports/getIdMappingFile.
}</pre>
</div>
<div class="method">
<code class="details" id="getIdMappingFile_media">getIdMappingFile_media(agencyId, advertiserId, x__xgafv=None)</code>
<pre>Downloads a csv file(encoded in UTF-8) that contains ID mappings between legacy SA360 and new SA360. The file includes all children entities of the given advertiser(e.g. engine accounts, campaigns, ad groups, etc.) that exist in both legacy SA360 and new SA360.
Args:
agencyId: string, Legacy SA360 agency ID. (required)
advertiserId: string, Legacy SA360 advertiser ID. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
The media object as a string.
</pre>
</div>
<div class="method">
<code class="details" id="request">request(body=None, x__xgafv=None)</code>
<pre>Inserts a report request into the reporting system.
Args:
body: object, The request body.
The object takes the form of:
{ # A request object used to create a DoubleClick Search report.
"columns": [ # 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.
{ # A request object used to create a DoubleClick Search report.
"columnName": "A String", # Name of a DoubleClick Search column to include in the report.
"customDimensionName": "A String", # 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.
"customMetricName": "A String", # 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.
"endDate": "A String", # 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`.
"groupByColumn": True or False, # Synchronous report only. Set to `true` to group by this column. Defaults to `false`.
"headerText": "A String", # 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.
"platformSource": "A String", # The platform that is used to provide data for the custom dimension. Acceptable values are "floodlight".
"productReportPerspective": "A String", # 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
"savedColumnName": "A String", # 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.
"startDate": "A String", # 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`.
},
],
"downloadFormat": "A String", # Format that the report should be returned in. Currently `csv` or `tsv` is supported.
"filters": [ # A list of filters to be applied to the report.\ The maximum number of filters per request is 300.
{
"column": { # A request object used to create a DoubleClick Search report. # Column to perform the filter on. This can be a DoubleClick Search column or a saved column.
"columnName": "A String", # Name of a DoubleClick Search column to include in the report.
"customDimensionName": "A String", # 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.
"customMetricName": "A String", # 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.
"endDate": "A String", # 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`.
"groupByColumn": True or False, # Synchronous report only. Set to `true` to group by this column. Defaults to `false`.
"headerText": "A String", # 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.
"platformSource": "A String", # The platform that is used to provide data for the custom dimension. Acceptable values are "floodlight".
"productReportPerspective": "A String", # 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
"savedColumnName": "A String", # 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.
"startDate": "A String", # 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`.
},
"operator": "A String", # Operator to use in the filter. See the filter reference for a list of available operators.
"values": [ # A list of values to filter the column value against.\ The maximum number of filter values per request is 300.
"",
],
},
],
"includeDeletedEntities": True or False, # Determines if removed entities should be included in the report. Defaults to `false`. Deprecated, please use `includeRemovedEntities` instead.
"includeRemovedEntities": True or False, # Determines if removed entities should be included in the report. Defaults to `false`.
"maxRowsPerFile": 42, # 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.
"orderBy": [ # 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.
{
"column": { # A request object used to create a DoubleClick Search report. # Column to perform the sort on. This can be a DoubleClick Search-defined column or a saved column.
"columnName": "A String", # Name of a DoubleClick Search column to include in the report.
"customDimensionName": "A String", # 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.
"customMetricName": "A String", # 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.
"endDate": "A String", # 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`.
"groupByColumn": True or False, # Synchronous report only. Set to `true` to group by this column. Defaults to `false`.
"headerText": "A String", # 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.
"platformSource": "A String", # The platform that is used to provide data for the custom dimension. Acceptable values are "floodlight".
"productReportPerspective": "A String", # 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
"savedColumnName": "A String", # 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.
"startDate": "A String", # 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`.
},
"sortOrder": "A String", # The sort direction, which is either `ascending` or `descending`.
},
],
"reportScope": { # 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.
"adGroupId": "A String", # DS ad group ID.
"adId": "A String", # DS ad ID.
"advertiserId": "A String", # DS advertiser ID.
"agencyId": "A String", # DS agency ID.
"campaignId": "A String", # DS campaign ID.
"engineAccountId": "A String", # DS engine account ID.
"keywordId": "A String", # DS keyword ID.
},
"reportType": "A String", # 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.
"rowCount": 42, # Synchronous report only. The maximum number of rows to return; additional rows are dropped. Acceptable values are `0` to `10000`, inclusive. Defaults to `10000`.
"startRow": 42, # Synchronous report only. Zero-based index of the first row to return. Acceptable values are `0` to `50000`, inclusive. Defaults to `0`.
"statisticsCurrency": "A String", # 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).
"timeRange": { # If metrics are requested in a report, this argument will be used to restrict the metrics to a specific time range.
"changedAttributesSinceTimestamp": "A String", # Inclusive UTC timestamp in RFC format, e.g., `2013-07-16T10:16:23.555Z`. See additional references on how changed attribute reports work.
"changedMetricsSinceTimestamp": "A String", # Inclusive UTC timestamp in RFC format, e.g., `2013-07-16T10:16:23.555Z`. See additional references on how changed metrics reports work.
"endDate": "A String", # Inclusive date in YYYY-MM-DD format.
"startDate": "A String", # Inclusive date in YYYY-MM-DD format.
},
"verifySingleTimeZone": True or False, # If `true`, the report would only be created if all the requested stat data are sourced from a single timezone. Defaults to `false`.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 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.
"files": [ # Asynchronous report only. Contains a list of generated report files once the report has successfully completed.
{
"byteCount": "A String", # The size of this report file in bytes.
"url": "A String", # Use this url to download the report file.
},
],
"id": "A String", # Asynchronous report only. Id of the report.
"isReportReady": True or False, # Asynchronous report only. True if and only if the report has completed successfully and the report files are ready to be downloaded.
"kind": "A String", # Identifies this as a Report resource. Value: the fixed string `doubleclicksearch#report`.
"request": { # A request object used to create a DoubleClick Search report. # The request that created the report. Optional fields not specified in the original request are filled with default values.
"columns": [ # 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.
{ # A request object used to create a DoubleClick Search report.
"columnName": "A String", # Name of a DoubleClick Search column to include in the report.
"customDimensionName": "A String", # 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.
"customMetricName": "A String", # 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.
"endDate": "A String", # 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`.
"groupByColumn": True or False, # Synchronous report only. Set to `true` to group by this column. Defaults to `false`.
"headerText": "A String", # 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.
"platformSource": "A String", # The platform that is used to provide data for the custom dimension. Acceptable values are "floodlight".
"productReportPerspective": "A String", # 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
"savedColumnName": "A String", # 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.
"startDate": "A String", # 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`.
},
],
"downloadFormat": "A String", # Format that the report should be returned in. Currently `csv` or `tsv` is supported.
"filters": [ # A list of filters to be applied to the report.\ The maximum number of filters per request is 300.
{
"column": { # A request object used to create a DoubleClick Search report. # Column to perform the filter on. This can be a DoubleClick Search column or a saved column.
"columnName": "A String", # Name of a DoubleClick Search column to include in the report.
"customDimensionName": "A String", # 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.
"customMetricName": "A String", # 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.
"endDate": "A String", # 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`.
"groupByColumn": True or False, # Synchronous report only. Set to `true` to group by this column. Defaults to `false`.
"headerText": "A String", # 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.
"platformSource": "A String", # The platform that is used to provide data for the custom dimension. Acceptable values are "floodlight".
"productReportPerspective": "A String", # 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
"savedColumnName": "A String", # 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.
"startDate": "A String", # 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`.
},
"operator": "A String", # Operator to use in the filter. See the filter reference for a list of available operators.
"values": [ # A list of values to filter the column value against.\ The maximum number of filter values per request is 300.
"",
],
},
],
"includeDeletedEntities": True or False, # Determines if removed entities should be included in the report. Defaults to `false`. Deprecated, please use `includeRemovedEntities` instead.
"includeRemovedEntities": True or False, # Determines if removed entities should be included in the report. Defaults to `false`.
"maxRowsPerFile": 42, # 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.
"orderBy": [ # 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.
{
"column": { # A request object used to create a DoubleClick Search report. # Column to perform the sort on. This can be a DoubleClick Search-defined column or a saved column.
"columnName": "A String", # Name of a DoubleClick Search column to include in the report.
"customDimensionName": "A String", # 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.
"customMetricName": "A String", # 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.
"endDate": "A String", # 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`.
"groupByColumn": True or False, # Synchronous report only. Set to `true` to group by this column. Defaults to `false`.
"headerText": "A String", # 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.
"platformSource": "A String", # The platform that is used to provide data for the custom dimension. Acceptable values are "floodlight".
"productReportPerspective": "A String", # 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
"savedColumnName": "A String", # 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.
"startDate": "A String", # 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`.
},
"sortOrder": "A String", # The sort direction, which is either `ascending` or `descending`.
},
],
"reportScope": { # 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.
"adGroupId": "A String", # DS ad group ID.
"adId": "A String", # DS ad ID.
"advertiserId": "A String", # DS advertiser ID.
"agencyId": "A String", # DS agency ID.
"campaignId": "A String", # DS campaign ID.
"engineAccountId": "A String", # DS engine account ID.
"keywordId": "A String", # DS keyword ID.
},
"reportType": "A String", # 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.
"rowCount": 42, # Synchronous report only. The maximum number of rows to return; additional rows are dropped. Acceptable values are `0` to `10000`, inclusive. Defaults to `10000`.
"startRow": 42, # Synchronous report only. Zero-based index of the first row to return. Acceptable values are `0` to `50000`, inclusive. Defaults to `0`.
"statisticsCurrency": "A String", # 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).
"timeRange": { # If metrics are requested in a report, this argument will be used to restrict the metrics to a specific time range.
"changedAttributesSinceTimestamp": "A String", # Inclusive UTC timestamp in RFC format, e.g., `2013-07-16T10:16:23.555Z`. See additional references on how changed attribute reports work.
"changedMetricsSinceTimestamp": "A String", # Inclusive UTC timestamp in RFC format, e.g., `2013-07-16T10:16:23.555Z`. See additional references on how changed metrics reports work.
"endDate": "A String", # Inclusive date in YYYY-MM-DD format.
"startDate": "A String", # Inclusive date in YYYY-MM-DD format.
},
"verifySingleTimeZone": True or False, # If `true`, the report would only be created if all the requested stat data are sourced from a single timezone. Defaults to `false`.
},
"rowCount": 42, # The number of report rows generated by the report, not including headers.
"rows": [ # Synchronous report only. Generated report rows.
{ # A row in a DoubleClick Search report.
"a_key": "", # Indicates the columns that are represented in this row. That is, each key corresponds to a column with a non-empty cell in this row.
},
],
"statisticsCurrencyCode": "A String", # 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.
"statisticsTimeZone": "A String", # If all statistics of the report are sourced from the same time zone, this would be it. Otherwise the field is unset.
}</pre>
</div>
</body></html>
|
