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
|
<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_4.html">Campaign Manager 360 API</a> . <a href="dfareporting_v3_4.floodlightConfigurations.html">floodlightConfigurations</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="#get">get(profileId, id, x__xgafv=None)</a></code></p>
<p class="firstline">Gets one floodlight configuration by ID.</p>
<p class="toc_element">
<code><a href="#list">list(profileId, ids=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a list of floodlight configurations, possibly filtered.</p>
<p class="toc_element">
<code><a href="#patch">patch(profileId, id, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an existing floodlight configuration. This method supports patch semantics.</p>
<p class="toc_element">
<code><a href="#update">update(profileId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an existing floodlight configuration.</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="get">get(profileId, id, x__xgafv=None)</code>
<pre>Gets one floodlight configuration by ID.
Args:
profileId: string, User profile ID associated with this request. (required)
id: string, Floodlight configuration ID. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Contains properties of a Floodlight configuration.
"accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank.
"advertiserId": "A String", # Advertiser ID of the parent advertiser of this floodlight configuration.
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
"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.
},
"analyticsDataSharingEnabled": True or False, # Whether advertiser data is shared with Google Analytics.
"customViewabilityMetric": { # Custom Viewability Metric # Custom Viewability metric for the floodlight configuration.
"configuration": { # The attributes, like playtime and percent onscreen, that define the Custom Viewability Metric. # Configuration of the custom viewability metric.
"audible": True or False, # Whether the video must be audible to count an impression.
"timeMillis": 42, # The time in milliseconds the video must play for the Custom Viewability Metric to count an impression. If both this and timePercent are specified, the earlier of the two will be used.
"timePercent": 42, # The percentage of video that must play for the Custom Viewability Metric to count an impression. If both this and timeMillis are specified, the earlier of the two will be used.
"viewabilityPercent": 42, # The percentage of video that must be on screen for the Custom Viewability Metric to count an impression.
},
"id": "A String", # ID of the custom viewability metric.
"name": "A String", # Name of the custom viewability metric.
},
"exposureToConversionEnabled": True or False, # Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
"firstDayOfWeek": "A String", # Day that will be counted as the first day of the week in reports. This is a required field.
"id": "A String", # ID of this floodlight configuration. This is a read-only, auto-generated field.
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field.
"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.
},
"inAppAttributionTrackingEnabled": True or False, # Whether in-app attribution tracking is enabled.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
"lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
"clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
"postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
},
"naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
"omnitureSettings": { # Omniture Integration Settings. # Settings for Campaign Manager Omniture integration.
"omnitureCostDataEnabled": True or False, # Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true.
"omnitureIntegrationEnabled": True or False, # Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled.
},
"subaccountId": "A String", # Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.
"tagSettings": { # Dynamic and Image Tag Settings. # Configuration settings for dynamic and image floodlight tags.
"dynamicTagEnabled": True or False, # Whether dynamic floodlight tags are enabled.
"imageTagEnabled": True or False, # Whether image tags are enabled.
},
"thirdPartyAuthenticationTokens": [ # List of third-party authentication tokens enabled for this configuration.
{ # Third Party Authentication Token
"name": "A String", # Name of the third-party authentication token.
"value": "A String", # Value of the third-party authentication token. This is a read-only, auto-generated field.
},
],
"userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
{ # User Defined Variable configuration.
"dataType": "A String", # Data type for the variable. This is a required field.
"reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
"variableType": "A String", # Variable name in the tag. This is a required field.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(profileId, ids=None, x__xgafv=None)</code>
<pre>Retrieves a list of floodlight configurations, possibly filtered.
Args:
profileId: string, User profile ID associated with this request. (required)
ids: string, Set of IDs of floodlight configurations to retrieve. Required field; otherwise an empty list will be returned. (repeated)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Floodlight Configuration List Response
"floodlightConfigurations": [ # Floodlight configuration collection.
{ # Contains properties of a Floodlight configuration.
"accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank.
"advertiserId": "A String", # Advertiser ID of the parent advertiser of this floodlight configuration.
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
"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.
},
"analyticsDataSharingEnabled": True or False, # Whether advertiser data is shared with Google Analytics.
"customViewabilityMetric": { # Custom Viewability Metric # Custom Viewability metric for the floodlight configuration.
"configuration": { # The attributes, like playtime and percent onscreen, that define the Custom Viewability Metric. # Configuration of the custom viewability metric.
"audible": True or False, # Whether the video must be audible to count an impression.
"timeMillis": 42, # The time in milliseconds the video must play for the Custom Viewability Metric to count an impression. If both this and timePercent are specified, the earlier of the two will be used.
"timePercent": 42, # The percentage of video that must play for the Custom Viewability Metric to count an impression. If both this and timeMillis are specified, the earlier of the two will be used.
"viewabilityPercent": 42, # The percentage of video that must be on screen for the Custom Viewability Metric to count an impression.
},
"id": "A String", # ID of the custom viewability metric.
"name": "A String", # Name of the custom viewability metric.
},
"exposureToConversionEnabled": True or False, # Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
"firstDayOfWeek": "A String", # Day that will be counted as the first day of the week in reports. This is a required field.
"id": "A String", # ID of this floodlight configuration. This is a read-only, auto-generated field.
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field.
"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.
},
"inAppAttributionTrackingEnabled": True or False, # Whether in-app attribution tracking is enabled.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
"lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
"clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
"postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
},
"naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
"omnitureSettings": { # Omniture Integration Settings. # Settings for Campaign Manager Omniture integration.
"omnitureCostDataEnabled": True or False, # Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true.
"omnitureIntegrationEnabled": True or False, # Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled.
},
"subaccountId": "A String", # Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.
"tagSettings": { # Dynamic and Image Tag Settings. # Configuration settings for dynamic and image floodlight tags.
"dynamicTagEnabled": True or False, # Whether dynamic floodlight tags are enabled.
"imageTagEnabled": True or False, # Whether image tags are enabled.
},
"thirdPartyAuthenticationTokens": [ # List of third-party authentication tokens enabled for this configuration.
{ # Third Party Authentication Token
"name": "A String", # Name of the third-party authentication token.
"value": "A String", # Value of the third-party authentication token. This is a read-only, auto-generated field.
},
],
"userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
{ # User Defined Variable configuration.
"dataType": "A String", # Data type for the variable. This is a required field.
"reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
"variableType": "A String", # Variable name in the tag. This is a required field.
},
],
},
],
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfigurationsListResponse".
}</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(profileId, id, body=None, x__xgafv=None)</code>
<pre>Updates an existing floodlight configuration. This method supports patch semantics.
Args:
profileId: string, User profile ID associated with this request. (required)
id: string, FloodlightConfiguration ID. (required)
body: object, The request body.
The object takes the form of:
{ # Contains properties of a Floodlight configuration.
"accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank.
"advertiserId": "A String", # Advertiser ID of the parent advertiser of this floodlight configuration.
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
"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.
},
"analyticsDataSharingEnabled": True or False, # Whether advertiser data is shared with Google Analytics.
"customViewabilityMetric": { # Custom Viewability Metric # Custom Viewability metric for the floodlight configuration.
"configuration": { # The attributes, like playtime and percent onscreen, that define the Custom Viewability Metric. # Configuration of the custom viewability metric.
"audible": True or False, # Whether the video must be audible to count an impression.
"timeMillis": 42, # The time in milliseconds the video must play for the Custom Viewability Metric to count an impression. If both this and timePercent are specified, the earlier of the two will be used.
"timePercent": 42, # The percentage of video that must play for the Custom Viewability Metric to count an impression. If both this and timeMillis are specified, the earlier of the two will be used.
"viewabilityPercent": 42, # The percentage of video that must be on screen for the Custom Viewability Metric to count an impression.
},
"id": "A String", # ID of the custom viewability metric.
"name": "A String", # Name of the custom viewability metric.
},
"exposureToConversionEnabled": True or False, # Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
"firstDayOfWeek": "A String", # Day that will be counted as the first day of the week in reports. This is a required field.
"id": "A String", # ID of this floodlight configuration. This is a read-only, auto-generated field.
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field.
"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.
},
"inAppAttributionTrackingEnabled": True or False, # Whether in-app attribution tracking is enabled.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
"lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
"clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
"postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
},
"naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
"omnitureSettings": { # Omniture Integration Settings. # Settings for Campaign Manager Omniture integration.
"omnitureCostDataEnabled": True or False, # Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true.
"omnitureIntegrationEnabled": True or False, # Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled.
},
"subaccountId": "A String", # Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.
"tagSettings": { # Dynamic and Image Tag Settings. # Configuration settings for dynamic and image floodlight tags.
"dynamicTagEnabled": True or False, # Whether dynamic floodlight tags are enabled.
"imageTagEnabled": True or False, # Whether image tags are enabled.
},
"thirdPartyAuthenticationTokens": [ # List of third-party authentication tokens enabled for this configuration.
{ # Third Party Authentication Token
"name": "A String", # Name of the third-party authentication token.
"value": "A String", # Value of the third-party authentication token. This is a read-only, auto-generated field.
},
],
"userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
{ # User Defined Variable configuration.
"dataType": "A String", # Data type for the variable. This is a required field.
"reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
"variableType": "A String", # Variable name in the tag. This is a required field.
},
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Contains properties of a Floodlight configuration.
"accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank.
"advertiserId": "A String", # Advertiser ID of the parent advertiser of this floodlight configuration.
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
"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.
},
"analyticsDataSharingEnabled": True or False, # Whether advertiser data is shared with Google Analytics.
"customViewabilityMetric": { # Custom Viewability Metric # Custom Viewability metric for the floodlight configuration.
"configuration": { # The attributes, like playtime and percent onscreen, that define the Custom Viewability Metric. # Configuration of the custom viewability metric.
"audible": True or False, # Whether the video must be audible to count an impression.
"timeMillis": 42, # The time in milliseconds the video must play for the Custom Viewability Metric to count an impression. If both this and timePercent are specified, the earlier of the two will be used.
"timePercent": 42, # The percentage of video that must play for the Custom Viewability Metric to count an impression. If both this and timeMillis are specified, the earlier of the two will be used.
"viewabilityPercent": 42, # The percentage of video that must be on screen for the Custom Viewability Metric to count an impression.
},
"id": "A String", # ID of the custom viewability metric.
"name": "A String", # Name of the custom viewability metric.
},
"exposureToConversionEnabled": True or False, # Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
"firstDayOfWeek": "A String", # Day that will be counted as the first day of the week in reports. This is a required field.
"id": "A String", # ID of this floodlight configuration. This is a read-only, auto-generated field.
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field.
"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.
},
"inAppAttributionTrackingEnabled": True or False, # Whether in-app attribution tracking is enabled.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
"lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
"clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
"postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
},
"naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
"omnitureSettings": { # Omniture Integration Settings. # Settings for Campaign Manager Omniture integration.
"omnitureCostDataEnabled": True or False, # Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true.
"omnitureIntegrationEnabled": True or False, # Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled.
},
"subaccountId": "A String", # Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.
"tagSettings": { # Dynamic and Image Tag Settings. # Configuration settings for dynamic and image floodlight tags.
"dynamicTagEnabled": True or False, # Whether dynamic floodlight tags are enabled.
"imageTagEnabled": True or False, # Whether image tags are enabled.
},
"thirdPartyAuthenticationTokens": [ # List of third-party authentication tokens enabled for this configuration.
{ # Third Party Authentication Token
"name": "A String", # Name of the third-party authentication token.
"value": "A String", # Value of the third-party authentication token. This is a read-only, auto-generated field.
},
],
"userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
{ # User Defined Variable configuration.
"dataType": "A String", # Data type for the variable. This is a required field.
"reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
"variableType": "A String", # Variable name in the tag. This is a required field.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(profileId, body=None, x__xgafv=None)</code>
<pre>Updates an existing floodlight configuration.
Args:
profileId: string, User profile ID associated with this request. (required)
body: object, The request body.
The object takes the form of:
{ # Contains properties of a Floodlight configuration.
"accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank.
"advertiserId": "A String", # Advertiser ID of the parent advertiser of this floodlight configuration.
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
"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.
},
"analyticsDataSharingEnabled": True or False, # Whether advertiser data is shared with Google Analytics.
"customViewabilityMetric": { # Custom Viewability Metric # Custom Viewability metric for the floodlight configuration.
"configuration": { # The attributes, like playtime and percent onscreen, that define the Custom Viewability Metric. # Configuration of the custom viewability metric.
"audible": True or False, # Whether the video must be audible to count an impression.
"timeMillis": 42, # The time in milliseconds the video must play for the Custom Viewability Metric to count an impression. If both this and timePercent are specified, the earlier of the two will be used.
"timePercent": 42, # The percentage of video that must play for the Custom Viewability Metric to count an impression. If both this and timeMillis are specified, the earlier of the two will be used.
"viewabilityPercent": 42, # The percentage of video that must be on screen for the Custom Viewability Metric to count an impression.
},
"id": "A String", # ID of the custom viewability metric.
"name": "A String", # Name of the custom viewability metric.
},
"exposureToConversionEnabled": True or False, # Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
"firstDayOfWeek": "A String", # Day that will be counted as the first day of the week in reports. This is a required field.
"id": "A String", # ID of this floodlight configuration. This is a read-only, auto-generated field.
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field.
"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.
},
"inAppAttributionTrackingEnabled": True or False, # Whether in-app attribution tracking is enabled.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
"lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
"clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
"postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
},
"naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
"omnitureSettings": { # Omniture Integration Settings. # Settings for Campaign Manager Omniture integration.
"omnitureCostDataEnabled": True or False, # Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true.
"omnitureIntegrationEnabled": True or False, # Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled.
},
"subaccountId": "A String", # Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.
"tagSettings": { # Dynamic and Image Tag Settings. # Configuration settings for dynamic and image floodlight tags.
"dynamicTagEnabled": True or False, # Whether dynamic floodlight tags are enabled.
"imageTagEnabled": True or False, # Whether image tags are enabled.
},
"thirdPartyAuthenticationTokens": [ # List of third-party authentication tokens enabled for this configuration.
{ # Third Party Authentication Token
"name": "A String", # Name of the third-party authentication token.
"value": "A String", # Value of the third-party authentication token. This is a read-only, auto-generated field.
},
],
"userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
{ # User Defined Variable configuration.
"dataType": "A String", # Data type for the variable. This is a required field.
"reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
"variableType": "A String", # Variable name in the tag. This is a required field.
},
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Contains properties of a Floodlight configuration.
"accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank.
"advertiserId": "A String", # Advertiser ID of the parent advertiser of this floodlight configuration.
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
"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.
},
"analyticsDataSharingEnabled": True or False, # Whether advertiser data is shared with Google Analytics.
"customViewabilityMetric": { # Custom Viewability Metric # Custom Viewability metric for the floodlight configuration.
"configuration": { # The attributes, like playtime and percent onscreen, that define the Custom Viewability Metric. # Configuration of the custom viewability metric.
"audible": True or False, # Whether the video must be audible to count an impression.
"timeMillis": 42, # The time in milliseconds the video must play for the Custom Viewability Metric to count an impression. If both this and timePercent are specified, the earlier of the two will be used.
"timePercent": 42, # The percentage of video that must play for the Custom Viewability Metric to count an impression. If both this and timeMillis are specified, the earlier of the two will be used.
"viewabilityPercent": 42, # The percentage of video that must be on screen for the Custom Viewability Metric to count an impression.
},
"id": "A String", # ID of the custom viewability metric.
"name": "A String", # Name of the custom viewability metric.
},
"exposureToConversionEnabled": True or False, # Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
"firstDayOfWeek": "A String", # Day that will be counted as the first day of the week in reports. This is a required field.
"id": "A String", # ID of this floodlight configuration. This is a read-only, auto-generated field.
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field.
"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.
},
"inAppAttributionTrackingEnabled": True or False, # Whether in-app attribution tracking is enabled.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
"lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
"clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
"postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
},
"naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
"omnitureSettings": { # Omniture Integration Settings. # Settings for Campaign Manager Omniture integration.
"omnitureCostDataEnabled": True or False, # Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true.
"omnitureIntegrationEnabled": True or False, # Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled.
},
"subaccountId": "A String", # Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.
"tagSettings": { # Dynamic and Image Tag Settings. # Configuration settings for dynamic and image floodlight tags.
"dynamicTagEnabled": True or False, # Whether dynamic floodlight tags are enabled.
"imageTagEnabled": True or False, # Whether image tags are enabled.
},
"thirdPartyAuthenticationTokens": [ # List of third-party authentication tokens enabled for this configuration.
{ # Third Party Authentication Token
"name": "A String", # Name of the third-party authentication token.
"value": "A String", # Value of the third-party authentication token. This is a read-only, auto-generated field.
},
],
"userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
{ # User Defined Variable configuration.
"dataType": "A String", # Data type for the variable. This is a required field.
"reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
"variableType": "A String", # Variable name in the tag. This is a required field.
},
],
}</pre>
</div>
</body></html>
|
