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
|
<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="doubleclickbidmanager_v1_1.html">DoubleClick Bid Manager API</a> . <a href="doubleclickbidmanager_v1_1.queries.html">queries</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="#createquery">createquery(asynchronous=None, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a query.</p>
<p class="toc_element">
<code><a href="#deletequery">deletequery(queryId, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a stored query as well as the associated stored reports.</p>
<p class="toc_element">
<code><a href="#getquery">getquery(queryId, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a stored query.</p>
<p class="toc_element">
<code><a href="#listqueries">listqueries(pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves stored queries.</p>
<p class="toc_element">
<code><a href="#listqueries_next">listqueries_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#runquery">runquery(queryId, asynchronous=None, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Runs a stored query to generate a report.</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="createquery">createquery(asynchronous=None, body=None, x__xgafv=None)</code>
<pre>Creates a query.
Args:
body: object, The request body.
The object takes the form of:
{ # Represents a query.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "doubleclickbidmanager#query".
"metadata": { # Query metadata. # Query metadata.
"dataRange": "A String", # Range of report data.
"format": "A String", # Format of the generated report.
"googleCloudStoragePathForLatestReport": "A String", # The path to the location in Google Cloud Storage where the latest report is stored.
"googleDrivePathForLatestReport": "A String", # The path in Google Drive for the latest report.
"latestReportRunTimeMs": "A String", # The time when the latest report started to run.
"locale": "A String", # Locale of the generated reports. Valid values are cs CZECH de GERMAN en ENGLISH es SPANISH fr FRENCH it ITALIAN ja JAPANESE ko KOREAN pl POLISH pt-BR BRAZILIAN_PORTUGUESE ru RUSSIAN tr TURKISH uk UKRAINIAN zh-CN CHINA_CHINESE zh-TW TAIWAN_CHINESE An locale string not in the list above will generate reports in English.
"reportCount": 42, # Number of reports that have been generated for the query.
"running": True or False, # Whether the latest report is currently running.
"sendNotification": True or False, # Whether to send an email notification when a report is ready. Default to false.
"shareEmailAddress": [ # List of email addresses which are sent email notifications when the report is finished. Separate from sendNotification.
"A String",
],
"title": "A String", # Query title. It is used to name the reports generated from this query.
},
"params": { # Parameters of a query or report. # Query parameters.
"filters": [ # Filters used to match traffic data in your report.
{ # Filter used to match traffic data in your report.
"type": "A String", # Filter type.
"value": "A String", # Filter value.
},
],
"groupBys": [ # Data is grouped by the filters listed in this field.
"A String",
],
"includeInviteData": True or False, # Deprecated. This field is no longer in use.
"metrics": [ # Metrics to include as columns in your report.
"A String",
],
"options": { # Additional query options. # Additional query options.
"includeOnlyTargetedUserLists": True or False, # Set to true and filter your report by `FILTER_INSERTION_ORDER` or `FILTER_LINE_ITEM` to include data for audience lists specifically targeted by those items.
"pathQueryOptions": { # Path Query Options for Report Options. # Options that contain Path Filters and Custom Channel Groupings.
"channelGrouping": { # A channel grouping defines a set of rules that can be used to categorize events in a path report. # Custom Channel Groupings.
"fallbackName": "A String", # The name to apply to an event that does not match any of the rules in the channel grouping.
"name": "A String", # Channel Grouping name.
"rules": [ # Rules within Channel Grouping. There is a limit of 100 rules that can be set per channel grouping.
{ # A Rule defines a name, and a boolean expression in [conjunctive normal form](http: //mathworld.wolfram.com/ConjunctiveNormalForm.html){.external} that can be // applied to a path event to determine if that name should be applied.
"disjunctiveMatchStatements": [
{ # DisjunctiveMatchStatement that OR's all contained filters.
"eventFilters": [ # Filters. There is a limit of 100 filters that can be set per disjunctive match statement.
{ # Defines the type of filter to be applied to the path, a DV360 event dimension filter.
"dimensionFilter": { # Dimension Filter on path events. # Filter on a dimension.
"filter": "A String", # Dimension the filter is applied to.
"match": "A String", # Indicates how the filter should be matched to the value.
"values": [ # Value to filter on.
"A String",
],
},
},
],
},
],
"name": "A String", # Rule name.
},
],
},
"pathFilters": [ # Path Filters. There is a limit of 100 path filters that can be set per report.
{ # Path filters specify which paths to include in a report. A path is the result of combining DV360 events based on User ID to create a workflow of users' actions. When a path filter is set, the resulting report will only include paths that match the specified event at the specified position. All other paths will be excluded.
"eventFilters": [ # Filter on an event to be applied to some part of the path.
{ # Defines the type of filter to be applied to the path, a DV360 event dimension filter.
"dimensionFilter": { # Dimension Filter on path events. # Filter on a dimension.
"filter": "A String", # Dimension the filter is applied to.
"match": "A String", # Indicates how the filter should be matched to the value.
"values": [ # Value to filter on.
"A String",
],
},
},
],
"pathMatchPosition": "A String", # Indicates the position of the path the filter should match to (first, last, or any event in path).
},
],
},
},
"type": "A String", # Report type.
},
"queryId": "A String", # Query ID.
"reportDataEndTimeMs": "A String", # The ending time for the data that is shown in the report. Note, reportDataEndTimeMs is required if metadata.dataRange is CUSTOM_DATES and ignored otherwise.
"reportDataStartTimeMs": "A String", # The starting time for the data that is shown in the report. Note, reportDataStartTimeMs is required if metadata.dataRange is CUSTOM_DATES and ignored otherwise.
"schedule": { # Information on how frequently and when to run a query. # Information on how often and when to run a query.
"endTimeMs": "A String", # Datetime to periodically run the query until.
"frequency": "A String", # How often the query is run.
"nextRunMinuteOfDay": 42, # Time of day at which a new report will be generated, represented as minutes past midnight. Range is 0 to 1439. Only applies to scheduled reports.
"nextRunTimezoneCode": "A String", # Canonical timezone code for report generation time. Defaults to America/New_York.
"startTimeMs": "A String", # When to start running the query. Not applicable to `ONE_TIME` frequency.
},
"timezoneCode": "A String", # Canonical timezone code for report data time. Defaults to America/New_York.
}
asynchronous: boolean, If true, tries to run the query asynchronously. Only applicable when the frequency is ONE_TIME.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents a query.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "doubleclickbidmanager#query".
"metadata": { # Query metadata. # Query metadata.
"dataRange": "A String", # Range of report data.
"format": "A String", # Format of the generated report.
"googleCloudStoragePathForLatestReport": "A String", # The path to the location in Google Cloud Storage where the latest report is stored.
"googleDrivePathForLatestReport": "A String", # The path in Google Drive for the latest report.
"latestReportRunTimeMs": "A String", # The time when the latest report started to run.
"locale": "A String", # Locale of the generated reports. Valid values are cs CZECH de GERMAN en ENGLISH es SPANISH fr FRENCH it ITALIAN ja JAPANESE ko KOREAN pl POLISH pt-BR BRAZILIAN_PORTUGUESE ru RUSSIAN tr TURKISH uk UKRAINIAN zh-CN CHINA_CHINESE zh-TW TAIWAN_CHINESE An locale string not in the list above will generate reports in English.
"reportCount": 42, # Number of reports that have been generated for the query.
"running": True or False, # Whether the latest report is currently running.
"sendNotification": True or False, # Whether to send an email notification when a report is ready. Default to false.
"shareEmailAddress": [ # List of email addresses which are sent email notifications when the report is finished. Separate from sendNotification.
"A String",
],
"title": "A String", # Query title. It is used to name the reports generated from this query.
},
"params": { # Parameters of a query or report. # Query parameters.
"filters": [ # Filters used to match traffic data in your report.
{ # Filter used to match traffic data in your report.
"type": "A String", # Filter type.
"value": "A String", # Filter value.
},
],
"groupBys": [ # Data is grouped by the filters listed in this field.
"A String",
],
"includeInviteData": True or False, # Deprecated. This field is no longer in use.
"metrics": [ # Metrics to include as columns in your report.
"A String",
],
"options": { # Additional query options. # Additional query options.
"includeOnlyTargetedUserLists": True or False, # Set to true and filter your report by `FILTER_INSERTION_ORDER` or `FILTER_LINE_ITEM` to include data for audience lists specifically targeted by those items.
"pathQueryOptions": { # Path Query Options for Report Options. # Options that contain Path Filters and Custom Channel Groupings.
"channelGrouping": { # A channel grouping defines a set of rules that can be used to categorize events in a path report. # Custom Channel Groupings.
"fallbackName": "A String", # The name to apply to an event that does not match any of the rules in the channel grouping.
"name": "A String", # Channel Grouping name.
"rules": [ # Rules within Channel Grouping. There is a limit of 100 rules that can be set per channel grouping.
{ # A Rule defines a name, and a boolean expression in [conjunctive normal form](http: //mathworld.wolfram.com/ConjunctiveNormalForm.html){.external} that can be // applied to a path event to determine if that name should be applied.
"disjunctiveMatchStatements": [
{ # DisjunctiveMatchStatement that OR's all contained filters.
"eventFilters": [ # Filters. There is a limit of 100 filters that can be set per disjunctive match statement.
{ # Defines the type of filter to be applied to the path, a DV360 event dimension filter.
"dimensionFilter": { # Dimension Filter on path events. # Filter on a dimension.
"filter": "A String", # Dimension the filter is applied to.
"match": "A String", # Indicates how the filter should be matched to the value.
"values": [ # Value to filter on.
"A String",
],
},
},
],
},
],
"name": "A String", # Rule name.
},
],
},
"pathFilters": [ # Path Filters. There is a limit of 100 path filters that can be set per report.
{ # Path filters specify which paths to include in a report. A path is the result of combining DV360 events based on User ID to create a workflow of users' actions. When a path filter is set, the resulting report will only include paths that match the specified event at the specified position. All other paths will be excluded.
"eventFilters": [ # Filter on an event to be applied to some part of the path.
{ # Defines the type of filter to be applied to the path, a DV360 event dimension filter.
"dimensionFilter": { # Dimension Filter on path events. # Filter on a dimension.
"filter": "A String", # Dimension the filter is applied to.
"match": "A String", # Indicates how the filter should be matched to the value.
"values": [ # Value to filter on.
"A String",
],
},
},
],
"pathMatchPosition": "A String", # Indicates the position of the path the filter should match to (first, last, or any event in path).
},
],
},
},
"type": "A String", # Report type.
},
"queryId": "A String", # Query ID.
"reportDataEndTimeMs": "A String", # The ending time for the data that is shown in the report. Note, reportDataEndTimeMs is required if metadata.dataRange is CUSTOM_DATES and ignored otherwise.
"reportDataStartTimeMs": "A String", # The starting time for the data that is shown in the report. Note, reportDataStartTimeMs is required if metadata.dataRange is CUSTOM_DATES and ignored otherwise.
"schedule": { # Information on how frequently and when to run a query. # Information on how often and when to run a query.
"endTimeMs": "A String", # Datetime to periodically run the query until.
"frequency": "A String", # How often the query is run.
"nextRunMinuteOfDay": 42, # Time of day at which a new report will be generated, represented as minutes past midnight. Range is 0 to 1439. Only applies to scheduled reports.
"nextRunTimezoneCode": "A String", # Canonical timezone code for report generation time. Defaults to America/New_York.
"startTimeMs": "A String", # When to start running the query. Not applicable to `ONE_TIME` frequency.
},
"timezoneCode": "A String", # Canonical timezone code for report data time. Defaults to America/New_York.
}</pre>
</div>
<div class="method">
<code class="details" id="deletequery">deletequery(queryId, x__xgafv=None)</code>
<pre>Deletes a stored query as well as the associated stored reports.
Args:
queryId: string, Query ID to delete. (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="getquery">getquery(queryId, x__xgafv=None)</code>
<pre>Retrieves a stored query.
Args:
queryId: string, Query ID to retrieve. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents a query.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "doubleclickbidmanager#query".
"metadata": { # Query metadata. # Query metadata.
"dataRange": "A String", # Range of report data.
"format": "A String", # Format of the generated report.
"googleCloudStoragePathForLatestReport": "A String", # The path to the location in Google Cloud Storage where the latest report is stored.
"googleDrivePathForLatestReport": "A String", # The path in Google Drive for the latest report.
"latestReportRunTimeMs": "A String", # The time when the latest report started to run.
"locale": "A String", # Locale of the generated reports. Valid values are cs CZECH de GERMAN en ENGLISH es SPANISH fr FRENCH it ITALIAN ja JAPANESE ko KOREAN pl POLISH pt-BR BRAZILIAN_PORTUGUESE ru RUSSIAN tr TURKISH uk UKRAINIAN zh-CN CHINA_CHINESE zh-TW TAIWAN_CHINESE An locale string not in the list above will generate reports in English.
"reportCount": 42, # Number of reports that have been generated for the query.
"running": True or False, # Whether the latest report is currently running.
"sendNotification": True or False, # Whether to send an email notification when a report is ready. Default to false.
"shareEmailAddress": [ # List of email addresses which are sent email notifications when the report is finished. Separate from sendNotification.
"A String",
],
"title": "A String", # Query title. It is used to name the reports generated from this query.
},
"params": { # Parameters of a query or report. # Query parameters.
"filters": [ # Filters used to match traffic data in your report.
{ # Filter used to match traffic data in your report.
"type": "A String", # Filter type.
"value": "A String", # Filter value.
},
],
"groupBys": [ # Data is grouped by the filters listed in this field.
"A String",
],
"includeInviteData": True or False, # Deprecated. This field is no longer in use.
"metrics": [ # Metrics to include as columns in your report.
"A String",
],
"options": { # Additional query options. # Additional query options.
"includeOnlyTargetedUserLists": True or False, # Set to true and filter your report by `FILTER_INSERTION_ORDER` or `FILTER_LINE_ITEM` to include data for audience lists specifically targeted by those items.
"pathQueryOptions": { # Path Query Options for Report Options. # Options that contain Path Filters and Custom Channel Groupings.
"channelGrouping": { # A channel grouping defines a set of rules that can be used to categorize events in a path report. # Custom Channel Groupings.
"fallbackName": "A String", # The name to apply to an event that does not match any of the rules in the channel grouping.
"name": "A String", # Channel Grouping name.
"rules": [ # Rules within Channel Grouping. There is a limit of 100 rules that can be set per channel grouping.
{ # A Rule defines a name, and a boolean expression in [conjunctive normal form](http: //mathworld.wolfram.com/ConjunctiveNormalForm.html){.external} that can be // applied to a path event to determine if that name should be applied.
"disjunctiveMatchStatements": [
{ # DisjunctiveMatchStatement that OR's all contained filters.
"eventFilters": [ # Filters. There is a limit of 100 filters that can be set per disjunctive match statement.
{ # Defines the type of filter to be applied to the path, a DV360 event dimension filter.
"dimensionFilter": { # Dimension Filter on path events. # Filter on a dimension.
"filter": "A String", # Dimension the filter is applied to.
"match": "A String", # Indicates how the filter should be matched to the value.
"values": [ # Value to filter on.
"A String",
],
},
},
],
},
],
"name": "A String", # Rule name.
},
],
},
"pathFilters": [ # Path Filters. There is a limit of 100 path filters that can be set per report.
{ # Path filters specify which paths to include in a report. A path is the result of combining DV360 events based on User ID to create a workflow of users' actions. When a path filter is set, the resulting report will only include paths that match the specified event at the specified position. All other paths will be excluded.
"eventFilters": [ # Filter on an event to be applied to some part of the path.
{ # Defines the type of filter to be applied to the path, a DV360 event dimension filter.
"dimensionFilter": { # Dimension Filter on path events. # Filter on a dimension.
"filter": "A String", # Dimension the filter is applied to.
"match": "A String", # Indicates how the filter should be matched to the value.
"values": [ # Value to filter on.
"A String",
],
},
},
],
"pathMatchPosition": "A String", # Indicates the position of the path the filter should match to (first, last, or any event in path).
},
],
},
},
"type": "A String", # Report type.
},
"queryId": "A String", # Query ID.
"reportDataEndTimeMs": "A String", # The ending time for the data that is shown in the report. Note, reportDataEndTimeMs is required if metadata.dataRange is CUSTOM_DATES and ignored otherwise.
"reportDataStartTimeMs": "A String", # The starting time for the data that is shown in the report. Note, reportDataStartTimeMs is required if metadata.dataRange is CUSTOM_DATES and ignored otherwise.
"schedule": { # Information on how frequently and when to run a query. # Information on how often and when to run a query.
"endTimeMs": "A String", # Datetime to periodically run the query until.
"frequency": "A String", # How often the query is run.
"nextRunMinuteOfDay": 42, # Time of day at which a new report will be generated, represented as minutes past midnight. Range is 0 to 1439. Only applies to scheduled reports.
"nextRunTimezoneCode": "A String", # Canonical timezone code for report generation time. Defaults to America/New_York.
"startTimeMs": "A String", # When to start running the query. Not applicable to `ONE_TIME` frequency.
},
"timezoneCode": "A String", # Canonical timezone code for report data time. Defaults to America/New_York.
}</pre>
</div>
<div class="method">
<code class="details" id="listqueries">listqueries(pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Retrieves stored queries.
Args:
pageSize: integer, Maximum number of results per page. Must be between 1 and 100. Defaults to 100 if unspecified.
pageToken: string, Optional pagination token.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # List queries response.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "doubleclickbidmanager#listQueriesResponse".
"nextPageToken": "A String", # Next page's pagination token if one exists.
"queries": [ # Retrieved queries.
{ # Represents a query.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "doubleclickbidmanager#query".
"metadata": { # Query metadata. # Query metadata.
"dataRange": "A String", # Range of report data.
"format": "A String", # Format of the generated report.
"googleCloudStoragePathForLatestReport": "A String", # The path to the location in Google Cloud Storage where the latest report is stored.
"googleDrivePathForLatestReport": "A String", # The path in Google Drive for the latest report.
"latestReportRunTimeMs": "A String", # The time when the latest report started to run.
"locale": "A String", # Locale of the generated reports. Valid values are cs CZECH de GERMAN en ENGLISH es SPANISH fr FRENCH it ITALIAN ja JAPANESE ko KOREAN pl POLISH pt-BR BRAZILIAN_PORTUGUESE ru RUSSIAN tr TURKISH uk UKRAINIAN zh-CN CHINA_CHINESE zh-TW TAIWAN_CHINESE An locale string not in the list above will generate reports in English.
"reportCount": 42, # Number of reports that have been generated for the query.
"running": True or False, # Whether the latest report is currently running.
"sendNotification": True or False, # Whether to send an email notification when a report is ready. Default to false.
"shareEmailAddress": [ # List of email addresses which are sent email notifications when the report is finished. Separate from sendNotification.
"A String",
],
"title": "A String", # Query title. It is used to name the reports generated from this query.
},
"params": { # Parameters of a query or report. # Query parameters.
"filters": [ # Filters used to match traffic data in your report.
{ # Filter used to match traffic data in your report.
"type": "A String", # Filter type.
"value": "A String", # Filter value.
},
],
"groupBys": [ # Data is grouped by the filters listed in this field.
"A String",
],
"includeInviteData": True or False, # Deprecated. This field is no longer in use.
"metrics": [ # Metrics to include as columns in your report.
"A String",
],
"options": { # Additional query options. # Additional query options.
"includeOnlyTargetedUserLists": True or False, # Set to true and filter your report by `FILTER_INSERTION_ORDER` or `FILTER_LINE_ITEM` to include data for audience lists specifically targeted by those items.
"pathQueryOptions": { # Path Query Options for Report Options. # Options that contain Path Filters and Custom Channel Groupings.
"channelGrouping": { # A channel grouping defines a set of rules that can be used to categorize events in a path report. # Custom Channel Groupings.
"fallbackName": "A String", # The name to apply to an event that does not match any of the rules in the channel grouping.
"name": "A String", # Channel Grouping name.
"rules": [ # Rules within Channel Grouping. There is a limit of 100 rules that can be set per channel grouping.
{ # A Rule defines a name, and a boolean expression in [conjunctive normal form](http: //mathworld.wolfram.com/ConjunctiveNormalForm.html){.external} that can be // applied to a path event to determine if that name should be applied.
"disjunctiveMatchStatements": [
{ # DisjunctiveMatchStatement that OR's all contained filters.
"eventFilters": [ # Filters. There is a limit of 100 filters that can be set per disjunctive match statement.
{ # Defines the type of filter to be applied to the path, a DV360 event dimension filter.
"dimensionFilter": { # Dimension Filter on path events. # Filter on a dimension.
"filter": "A String", # Dimension the filter is applied to.
"match": "A String", # Indicates how the filter should be matched to the value.
"values": [ # Value to filter on.
"A String",
],
},
},
],
},
],
"name": "A String", # Rule name.
},
],
},
"pathFilters": [ # Path Filters. There is a limit of 100 path filters that can be set per report.
{ # Path filters specify which paths to include in a report. A path is the result of combining DV360 events based on User ID to create a workflow of users' actions. When a path filter is set, the resulting report will only include paths that match the specified event at the specified position. All other paths will be excluded.
"eventFilters": [ # Filter on an event to be applied to some part of the path.
{ # Defines the type of filter to be applied to the path, a DV360 event dimension filter.
"dimensionFilter": { # Dimension Filter on path events. # Filter on a dimension.
"filter": "A String", # Dimension the filter is applied to.
"match": "A String", # Indicates how the filter should be matched to the value.
"values": [ # Value to filter on.
"A String",
],
},
},
],
"pathMatchPosition": "A String", # Indicates the position of the path the filter should match to (first, last, or any event in path).
},
],
},
},
"type": "A String", # Report type.
},
"queryId": "A String", # Query ID.
"reportDataEndTimeMs": "A String", # The ending time for the data that is shown in the report. Note, reportDataEndTimeMs is required if metadata.dataRange is CUSTOM_DATES and ignored otherwise.
"reportDataStartTimeMs": "A String", # The starting time for the data that is shown in the report. Note, reportDataStartTimeMs is required if metadata.dataRange is CUSTOM_DATES and ignored otherwise.
"schedule": { # Information on how frequently and when to run a query. # Information on how often and when to run a query.
"endTimeMs": "A String", # Datetime to periodically run the query until.
"frequency": "A String", # How often the query is run.
"nextRunMinuteOfDay": 42, # Time of day at which a new report will be generated, represented as minutes past midnight. Range is 0 to 1439. Only applies to scheduled reports.
"nextRunTimezoneCode": "A String", # Canonical timezone code for report generation time. Defaults to America/New_York.
"startTimeMs": "A String", # When to start running the query. Not applicable to `ONE_TIME` frequency.
},
"timezoneCode": "A String", # Canonical timezone code for report data time. Defaults to America/New_York.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="listqueries_next">listqueries_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="runquery">runquery(queryId, asynchronous=None, body=None, x__xgafv=None)</code>
<pre>Runs a stored query to generate a report.
Args:
queryId: string, Query ID to run. (required)
body: object, The request body.
The object takes the form of:
{ # Request to run a stored query to generate a report.
"dataRange": "A String", # Report data range used to generate the report.
"reportDataEndTimeMs": "A String", # The ending time for the data that is shown in the report. Note, reportDataEndTimeMs is required if dataRange is CUSTOM_DATES and ignored otherwise.
"reportDataStartTimeMs": "A String", # The starting time for the data that is shown in the report. Note, reportDataStartTimeMs is required if dataRange is CUSTOM_DATES and ignored otherwise.
"timezoneCode": "A String", # Canonical timezone code for report data time. Defaults to America/New_York.
}
asynchronous: boolean, If true, tries to run the query asynchronously.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
</pre>
</div>
</body></html>
|
