1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
|
<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="dfareporting_v3_5.html">Campaign Manager 360 API</a> . <a href="dfareporting_v3_5.reports.html">reports</a> . <a href="dfareporting_v3_5.reports.compatibleFields.html">compatibleFields</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="#query">query(profileId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns the fields that are compatible to be selected in the respective sections of a report criteria, given the fields already selected in the input report and user permissions.</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="query">query(profileId, body=None, x__xgafv=None)</code>
<pre>Returns the fields that are compatible to be selected in the respective sections of a report criteria, given the fields already selected in the input report and user permissions.
Args:
profileId: string, The Campaign Manager 360 user profile ID. (required)
body: object, The request body.
The object takes the form of:
{ # Represents a Report resource.
"accountId": "A String", # The account ID to which this report belongs.
"criteria": { # The report criteria for a report of type "STANDARD".
"activities": { # Represents an activity group. # Activity group.
"filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
{ # Represents a DimensionValue resource.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"value": "A String", # The value of the dimension.
},
],
"kind": "A String", # The kind of resource this is, in this case dfareporting#activities.
"metricNames": [ # List of names of floodlight activity metrics.
"A String",
],
},
"customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
"filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
{ # Represents a DimensionValue resource.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"value": "A String", # The value of the dimension.
},
],
"kind": "A String", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
},
"dateRange": { # Represents a date range. # The date range for which this report should be run.
"endDate": "A String",
"kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
"relativeDateRange": "A String", # The date range relative to the date of when the report is run.
"startDate": "A String",
},
"dimensionFilters": [ # The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
{ # Represents a DimensionValue resource.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"value": "A String", # The value of the dimension.
},
],
"dimensions": [ # The list of standard dimensions the report should include.
{ # Represents a sorted dimension.
"kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
"name": "A String", # The name of the dimension.
"sortOrder": "A String", # An optional sort order for the dimension column.
},
],
"metricNames": [ # The list of names of metrics the report should include.
"A String",
],
},
"crossDimensionReachCriteria": { # The report criteria for a report of type "CROSS_DIMENSION_REACH".
"breakdown": [ # The list of dimensions the report should include.
{ # Represents a sorted dimension.
"kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
"name": "A String", # The name of the dimension.
"sortOrder": "A String", # An optional sort order for the dimension column.
},
],
"dateRange": { # Represents a date range. # The date range this report should be run for.
"endDate": "A String",
"kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
"relativeDateRange": "A String", # The date range relative to the date of when the report is run.
"startDate": "A String",
},
"dimension": "A String", # The dimension option.
"dimensionFilters": [ # The list of filters on which dimensions are filtered.
{ # Represents a DimensionValue resource.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"value": "A String", # The value of the dimension.
},
],
"metricNames": [ # The list of names of metrics the report should include.
"A String",
],
"overlapMetricNames": [ # The list of names of overlap metrics the report should include.
"A String",
],
"pivoted": True or False, # Whether the report is pivoted or not. Defaults to true.
},
"delivery": { # The report's email delivery settings.
"emailOwner": True or False, # Whether the report should be emailed to the report owner.
"emailOwnerDeliveryType": "A String", # The type of delivery for the owner to receive, if enabled.
"message": "A String", # The message to be sent with each email.
"recipients": [ # The list of recipients to which to email the report.
{ # Represents a recipient.
"deliveryType": "A String", # The delivery type for the recipient.
"email": "A String", # The email address of the recipient.
"kind": "A String", # The kind of resource this is, in this case dfareporting#recipient.
},
],
},
"etag": "A String", # The eTag of this response for caching purposes.
"fileName": "A String", # The filename used when generating report files for this report.
"floodlightCriteria": { # The report criteria for a report of type "FLOODLIGHT".
"customRichMediaEvents": [ # The list of custom rich media events to include.
{ # Represents a DimensionValue resource.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"value": "A String", # The value of the dimension.
},
],
"dateRange": { # Represents a date range. # The date range this report should be run for.
"endDate": "A String",
"kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
"relativeDateRange": "A String", # The date range relative to the date of when the report is run.
"startDate": "A String",
},
"dimensionFilters": [ # The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
{ # Represents a DimensionValue resource.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"value": "A String", # The value of the dimension.
},
],
"dimensions": [ # The list of dimensions the report should include.
{ # Represents a sorted dimension.
"kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
"name": "A String", # The name of the dimension.
"sortOrder": "A String", # An optional sort order for the dimension column.
},
],
"floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"value": "A String", # The value of the dimension.
},
"metricNames": [ # The list of names of metrics the report should include.
"A String",
],
"reportProperties": { # The properties of the report.
"includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
"includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
"includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
},
},
"format": "A String", # The output format of the report. If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format.
"id": "A String", # The unique ID identifying this report resource.
"kind": "A String", # The kind of resource this is, in this case dfareporting#report.
"lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
"name": "A String", # The name of the report.
"ownerProfileId": "A String", # The user profile id of the owner of this report.
"pathAttributionCriteria": { # The report criteria for a report of type "PATH_ATTRIBUTION".
"activityFilters": [ # The list of 'dfa:activity' values to filter on.
{ # Represents a DimensionValue resource.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"value": "A String", # The value of the dimension.
},
],
"customChannelGrouping": { # Represents a DfaReporting channel grouping. # Channel Grouping.
"fallbackName": "A String", # ChannelGrouping fallback name.
"kind": "A String", # The kind of resource this is, in this case dfareporting#channelGrouping.
"name": "A String", # ChannelGrouping name.
"rules": [ # The rules contained within this channel grouping.
{ # Represents a DfaReporting channel grouping rule.
"disjunctiveMatchStatements": [ # The disjunctive match statements contained within this rule.
{ # Represents a Disjunctive Match Statement resource, which is a conjunction (and) of disjunctive (or) boolean statements.
"eventFilters": [ # The event filters contained within this disjunctive match statement.
{ # Represents a DfaReporting event filter.
"dimensionFilter": { # Represents a PathReportDimensionValue resource. # The dimension filter contained within this EventFilter.
"dimensionName": "A String", # The name of the dimension.
"ids": [ # The possible ID's associated with the value if available.
"A String",
],
"kind": "A String", # The kind of resource this is, in this case dfareporting#pathReportDimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"values": [ # The possible values of the dimension.
"A String",
],
},
"kind": "A String", # The kind of resource this is, in this case dfareporting#eventFilter.
},
],
"kind": "A String", # The kind of resource this is, in this case dfareporting#disjunctiveMatchStatement.
},
],
"kind": "A String", # The kind of resource this is, in this case dfareporting#channelGroupingRule.
"name": "A String", # Rule name.
},
],
},
"dateRange": { # Represents a date range. # The date range this report should be run for.
"endDate": "A String",
"kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
"relativeDateRange": "A String", # The date range relative to the date of when the report is run.
"startDate": "A String",
},
"dimensions": [ # The list of dimensions the report should include.
{ # Represents a sorted dimension.
"kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
"name": "A String", # The name of the dimension.
"sortOrder": "A String", # An optional sort order for the dimension column.
},
],
"floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"value": "A String", # The value of the dimension.
},
"metricNames": [ # The list of names of metrics the report should include.
"A String",
],
"pathFilters": [ # Path Filters.
{ # Represents a DfaReporting path filter.
"eventFilters": [ # Event filters in path report.
{ # Represents a DfaReporting event filter.
"dimensionFilter": { # Represents a PathReportDimensionValue resource. # The dimension filter contained within this EventFilter.
"dimensionName": "A String", # The name of the dimension.
"ids": [ # The possible ID's associated with the value if available.
"A String",
],
"kind": "A String", # The kind of resource this is, in this case dfareporting#pathReportDimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"values": [ # The possible values of the dimension.
"A String",
],
},
"kind": "A String", # The kind of resource this is, in this case dfareporting#eventFilter.
},
],
"kind": "A String", # The kind of resource this is, in this case dfareporting#pathFilter.
"pathMatchPosition": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
},
],
},
"pathCriteria": { # The report criteria for a report of type "PATH".
"activityFilters": [ # The list of 'dfa:activity' values to filter on.
{ # Represents a DimensionValue resource.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"value": "A String", # The value of the dimension.
},
],
"customChannelGrouping": { # Represents a DfaReporting channel grouping. # Channel Grouping.
"fallbackName": "A String", # ChannelGrouping fallback name.
"kind": "A String", # The kind of resource this is, in this case dfareporting#channelGrouping.
"name": "A String", # ChannelGrouping name.
"rules": [ # The rules contained within this channel grouping.
{ # Represents a DfaReporting channel grouping rule.
"disjunctiveMatchStatements": [ # The disjunctive match statements contained within this rule.
{ # Represents a Disjunctive Match Statement resource, which is a conjunction (and) of disjunctive (or) boolean statements.
"eventFilters": [ # The event filters contained within this disjunctive match statement.
{ # Represents a DfaReporting event filter.
"dimensionFilter": { # Represents a PathReportDimensionValue resource. # The dimension filter contained within this EventFilter.
"dimensionName": "A String", # The name of the dimension.
"ids": [ # The possible ID's associated with the value if available.
"A String",
],
"kind": "A String", # The kind of resource this is, in this case dfareporting#pathReportDimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"values": [ # The possible values of the dimension.
"A String",
],
},
"kind": "A String", # The kind of resource this is, in this case dfareporting#eventFilter.
},
],
"kind": "A String", # The kind of resource this is, in this case dfareporting#disjunctiveMatchStatement.
},
],
"kind": "A String", # The kind of resource this is, in this case dfareporting#channelGroupingRule.
"name": "A String", # Rule name.
},
],
},
"dateRange": { # Represents a date range. # The date range this report should be run for.
"endDate": "A String",
"kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
"relativeDateRange": "A String", # The date range relative to the date of when the report is run.
"startDate": "A String",
},
"dimensions": [ # The list of dimensions the report should include.
{ # Represents a sorted dimension.
"kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
"name": "A String", # The name of the dimension.
"sortOrder": "A String", # An optional sort order for the dimension column.
},
],
"floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"value": "A String", # The value of the dimension.
},
"metricNames": [ # The list of names of metrics the report should include.
"A String",
],
"pathFilters": [ # Path Filters.
{ # Represents a DfaReporting path filter.
"eventFilters": [ # Event filters in path report.
{ # Represents a DfaReporting event filter.
"dimensionFilter": { # Represents a PathReportDimensionValue resource. # The dimension filter contained within this EventFilter.
"dimensionName": "A String", # The name of the dimension.
"ids": [ # The possible ID's associated with the value if available.
"A String",
],
"kind": "A String", # The kind of resource this is, in this case dfareporting#pathReportDimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"values": [ # The possible values of the dimension.
"A String",
],
},
"kind": "A String", # The kind of resource this is, in this case dfareporting#eventFilter.
},
],
"kind": "A String", # The kind of resource this is, in this case dfareporting#pathFilter.
"pathMatchPosition": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
},
],
},
"pathToConversionCriteria": { # The report criteria for a report of type "PATH_TO_CONVERSION".
"activityFilters": [ # The list of 'dfa:activity' values to filter on.
{ # Represents a DimensionValue resource.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"value": "A String", # The value of the dimension.
},
],
"conversionDimensions": [ # The list of conversion dimensions the report should include.
{ # Represents a sorted dimension.
"kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
"name": "A String", # The name of the dimension.
"sortOrder": "A String", # An optional sort order for the dimension column.
},
],
"customFloodlightVariables": [ # The list of custom floodlight variables the report should include.
{ # Represents a sorted dimension.
"kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
"name": "A String", # The name of the dimension.
"sortOrder": "A String", # An optional sort order for the dimension column.
},
],
"customRichMediaEvents": [ # The list of custom rich media events to include.
{ # Represents a DimensionValue resource.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"value": "A String", # The value of the dimension.
},
],
"dateRange": { # Represents a date range. # The date range this report should be run for.
"endDate": "A String",
"kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
"relativeDateRange": "A String", # The date range relative to the date of when the report is run.
"startDate": "A String",
},
"floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"value": "A String", # The value of the dimension.
},
"metricNames": [ # The list of names of metrics the report should include.
"A String",
],
"perInteractionDimensions": [ # The list of per interaction dimensions the report should include.
{ # Represents a sorted dimension.
"kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
"name": "A String", # The name of the dimension.
"sortOrder": "A String", # An optional sort order for the dimension column.
},
],
"reportProperties": { # The properties of the report.
"clicksLookbackWindow": 42, # CM360 checks to see if a click interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
"impressionsLookbackWindow": 42, # CM360 checks to see if an impression interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
"includeAttributedIPConversions": True or False, # Deprecated: has no effect.
"includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
"includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
"maximumClickInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
"maximumImpressionInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
"maximumInteractionGap": 42, # The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.
"pivotOnInteractionPath": True or False, # Enable pivoting on interaction path.
},
},
"reachCriteria": { # The report criteria for a report of type "REACH".
"activities": { # Represents an activity group. # Activity group.
"filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
{ # Represents a DimensionValue resource.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"value": "A String", # The value of the dimension.
},
],
"kind": "A String", # The kind of resource this is, in this case dfareporting#activities.
"metricNames": [ # List of names of floodlight activity metrics.
"A String",
],
},
"customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
"filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
{ # Represents a DimensionValue resource.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"value": "A String", # The value of the dimension.
},
],
"kind": "A String", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
},
"dateRange": { # Represents a date range. # The date range this report should be run for.
"endDate": "A String",
"kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
"relativeDateRange": "A String", # The date range relative to the date of when the report is run.
"startDate": "A String",
},
"dimensionFilters": [ # The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
{ # Represents a DimensionValue resource.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"value": "A String", # The value of the dimension.
},
],
"dimensions": [ # The list of dimensions the report should include.
{ # Represents a sorted dimension.
"kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
"name": "A String", # The name of the dimension.
"sortOrder": "A String", # An optional sort order for the dimension column.
},
],
"enableAllDimensionCombinations": True or False, # Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last 42 days.
"metricNames": [ # The list of names of metrics the report should include.
"A String",
],
"reachByFrequencyMetricNames": [ # The list of names of Reach By Frequency metrics the report should include.
"A String",
],
},
"schedule": { # The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY".
"active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
"every": 42, # Defines every how many days, weeks or months the report should be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or "MONTHLY".
"expirationDate": "A String",
"repeats": "A String", # The interval for which the report is repeated. Note: - "DAILY" also requires field "every" to be set. - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set. - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
"repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
"A String",
],
"runsOnDayOfMonth": "A String", # Enum to define for "MONTHLY" scheduled reports whether reports should be repeated on the same day of the month as "startDate" or the same day of the week of the month. Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" would run subsequent reports on the first Monday of the month.
"startDate": "A String",
"timezone": "A String", # The timezone when the report will run.
},
"subAccountId": "A String", # The subaccount ID to which this report belongs if applicable.
"type": "A String", # The type of the report.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents a response to the queryCompatibleFields method.
"crossDimensionReachReportCompatibleFields": { # Represents fields that are compatible to be selected for a report of type "CROSS_DIMENSION_REACH". # Contains items that are compatible to be selected for a report of type "CROSS_DIMENSION_REACH".
"breakdown": [ # Dimensions which are compatible to be selected in the "breakdown" section of the report.
{ # Represents a dimension.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimension.
"name": "A String", # The dimension name, e.g. dfa:advertiser
},
],
"dimensionFilters": [ # Dimensions which are compatible to be selected in the "dimensionFilters" section of the report.
{ # Represents a dimension.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimension.
"name": "A String", # The dimension name, e.g. dfa:advertiser
},
],
"kind": "A String", # The kind of resource this is, in this case dfareporting#crossDimensionReachReportCompatibleFields.
"metrics": [ # Metrics which are compatible to be selected in the "metricNames" section of the report.
{ # Represents a metric.
"kind": "A String", # The kind of resource this is, in this case dfareporting#metric.
"name": "A String", # The metric name, e.g. dfa:impressions
},
],
"overlapMetrics": [ # Metrics which are compatible to be selected in the "overlapMetricNames" section of the report.
{ # Represents a metric.
"kind": "A String", # The kind of resource this is, in this case dfareporting#metric.
"name": "A String", # The metric name, e.g. dfa:impressions
},
],
},
"floodlightReportCompatibleFields": { # Represents fields that are compatible to be selected for a report of type "FlOODLIGHT". # Contains items that are compatible to be selected for a report of type "FLOODLIGHT".
"dimensionFilters": [ # Dimensions which are compatible to be selected in the "dimensionFilters" section of the report.
{ # Represents a dimension.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimension.
"name": "A String", # The dimension name, e.g. dfa:advertiser
},
],
"dimensions": [ # Dimensions which are compatible to be selected in the "dimensions" section of the report.
{ # Represents a dimension.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimension.
"name": "A String", # The dimension name, e.g. dfa:advertiser
},
],
"kind": "A String", # The kind of resource this is, in this case dfareporting#floodlightReportCompatibleFields.
"metrics": [ # Metrics which are compatible to be selected in the "metricNames" section of the report.
{ # Represents a metric.
"kind": "A String", # The kind of resource this is, in this case dfareporting#metric.
"name": "A String", # The metric name, e.g. dfa:impressions
},
],
},
"kind": "A String", # The kind of resource this is, in this case dfareporting#compatibleFields.
"pathAttributionReportCompatibleFields": { # Represents fields that are compatible to be selected for a report of type "PATH". # Contains items that are compatible to be selected for a report of type "PATH_ATTRIBUTION".
"channelGroupings": [ # Dimensions which are compatible to be selected in the "channelGroupings" section of the report.
{ # Represents a dimension.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimension.
"name": "A String", # The dimension name, e.g. dfa:advertiser
},
],
"dimensions": [ # Dimensions which are compatible to be selected in the "dimensions" section of the report.
{ # Represents a dimension.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimension.
"name": "A String", # The dimension name, e.g. dfa:advertiser
},
],
"kind": "A String", # The kind of resource this is, in this case dfareporting#pathReportCompatibleFields.
"metrics": [ # Metrics which are compatible to be selected in the "metricNames" section of the report.
{ # Represents a metric.
"kind": "A String", # The kind of resource this is, in this case dfareporting#metric.
"name": "A String", # The metric name, e.g. dfa:impressions
},
],
"pathFilters": [ # Dimensions which are compatible to be selected in the "pathFilters" section of the report.
{ # Represents a dimension.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimension.
"name": "A String", # The dimension name, e.g. dfa:advertiser
},
],
},
"pathReportCompatibleFields": { # Represents fields that are compatible to be selected for a report of type "PATH". # Contains items that are compatible to be selected for a report of type "PATH".
"channelGroupings": [ # Dimensions which are compatible to be selected in the "channelGroupings" section of the report.
{ # Represents a dimension.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimension.
"name": "A String", # The dimension name, e.g. dfa:advertiser
},
],
"dimensions": [ # Dimensions which are compatible to be selected in the "dimensions" section of the report.
{ # Represents a dimension.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimension.
"name": "A String", # The dimension name, e.g. dfa:advertiser
},
],
"kind": "A String", # The kind of resource this is, in this case dfareporting#pathReportCompatibleFields.
"metrics": [ # Metrics which are compatible to be selected in the "metricNames" section of the report.
{ # Represents a metric.
"kind": "A String", # The kind of resource this is, in this case dfareporting#metric.
"name": "A String", # The metric name, e.g. dfa:impressions
},
],
"pathFilters": [ # Dimensions which are compatible to be selected in the "pathFilters" section of the report.
{ # Represents a dimension.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimension.
"name": "A String", # The dimension name, e.g. dfa:advertiser
},
],
},
"pathToConversionReportCompatibleFields": { # Represents fields that are compatible to be selected for a report of type "PATH_TO_CONVERSION". # Contains items that are compatible to be selected for a report of type "PATH_TO_CONVERSION".
"conversionDimensions": [ # Conversion dimensions which are compatible to be selected in the "conversionDimensions" section of the report.
{ # Represents a dimension.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimension.
"name": "A String", # The dimension name, e.g. dfa:advertiser
},
],
"customFloodlightVariables": [ # Custom floodlight variables which are compatible to be selected in the "customFloodlightVariables" section of the report.
{ # Represents a dimension.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimension.
"name": "A String", # The dimension name, e.g. dfa:advertiser
},
],
"kind": "A String", # The kind of resource this is, in this case dfareporting#pathToConversionReportCompatibleFields.
"metrics": [ # Metrics which are compatible to be selected in the "metricNames" section of the report.
{ # Represents a metric.
"kind": "A String", # The kind of resource this is, in this case dfareporting#metric.
"name": "A String", # The metric name, e.g. dfa:impressions
},
],
"perInteractionDimensions": [ # Per-interaction dimensions which are compatible to be selected in the "perInteractionDimensions" section of the report.
{ # Represents a dimension.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimension.
"name": "A String", # The dimension name, e.g. dfa:advertiser
},
],
},
"reachReportCompatibleFields": { # Represents fields that are compatible to be selected for a report of type "REACH". # Contains items that are compatible to be selected for a report of type "REACH".
"dimensionFilters": [ # Dimensions which are compatible to be selected in the "dimensionFilters" section of the report.
{ # Represents a dimension.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimension.
"name": "A String", # The dimension name, e.g. dfa:advertiser
},
],
"dimensions": [ # Dimensions which are compatible to be selected in the "dimensions" section of the report.
{ # Represents a dimension.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimension.
"name": "A String", # The dimension name, e.g. dfa:advertiser
},
],
"kind": "A String", # The kind of resource this is, in this case dfareporting#reachReportCompatibleFields.
"metrics": [ # Metrics which are compatible to be selected in the "metricNames" section of the report.
{ # Represents a metric.
"kind": "A String", # The kind of resource this is, in this case dfareporting#metric.
"name": "A String", # The metric name, e.g. dfa:impressions
},
],
"pivotedActivityMetrics": [ # Metrics which are compatible to be selected as activity metrics to pivot on in the "activities" section of the report.
{ # Represents a metric.
"kind": "A String", # The kind of resource this is, in this case dfareporting#metric.
"name": "A String", # The metric name, e.g. dfa:impressions
},
],
"reachByFrequencyMetrics": [ # Metrics which are compatible to be selected in the "reachByFrequencyMetricNames" section of the report.
{ # Represents a metric.
"kind": "A String", # The kind of resource this is, in this case dfareporting#metric.
"name": "A String", # The metric name, e.g. dfa:impressions
},
],
},
"reportCompatibleFields": { # Represents fields that are compatible to be selected for a report of type "STANDARD". # Contains items that are compatible to be selected for a report of type "STANDARD".
"dimensionFilters": [ # Dimensions which are compatible to be selected in the "dimensionFilters" section of the report.
{ # Represents a dimension.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimension.
"name": "A String", # The dimension name, e.g. dfa:advertiser
},
],
"dimensions": [ # Dimensions which are compatible to be selected in the "dimensions" section of the report.
{ # Represents a dimension.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimension.
"name": "A String", # The dimension name, e.g. dfa:advertiser
},
],
"kind": "A String", # The kind of resource this is, in this case dfareporting#reportCompatibleFields.
"metrics": [ # Metrics which are compatible to be selected in the "metricNames" section of the report.
{ # Represents a metric.
"kind": "A String", # The kind of resource this is, in this case dfareporting#metric.
"name": "A String", # The metric name, e.g. dfa:impressions
},
],
"pivotedActivityMetrics": [ # Metrics which are compatible to be selected as activity metrics to pivot on in the "activities" section of the report.
{ # Represents a metric.
"kind": "A String", # The kind of resource this is, in this case dfareporting#metric.
"name": "A String", # The metric name, e.g. dfa:impressions
},
],
},
}</pre>
</div>
</body></html>
|
