1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="dfareporting_v3_3.html">Campaign Manager 360 API</a> . <a href="dfareporting_v3_3.floodlightConfigurations.html">floodlightConfigurations</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#get">get(profileId, id, x__xgafv=None)</a></code></p> 82<p class="firstline">Gets one floodlight configuration by ID.</p> 83<p class="toc_element"> 84 <code><a href="#list">list(profileId, ids=None, x__xgafv=None)</a></code></p> 85<p class="firstline">Retrieves a list of floodlight configurations, possibly filtered.</p> 86<p class="toc_element"> 87 <code><a href="#patch">patch(profileId, id, body=None, x__xgafv=None)</a></code></p> 88<p class="firstline">Updates an existing floodlight configuration. This method supports patch semantics.</p> 89<p class="toc_element"> 90 <code><a href="#update">update(profileId, body=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Updates an existing floodlight configuration.</p> 92<h3>Method Details</h3> 93<div class="method"> 94 <code class="details" id="close">close()</code> 95 <pre>Close httplib2 connections.</pre> 96</div> 97 98<div class="method"> 99 <code class="details" id="get">get(profileId, id, x__xgafv=None)</code> 100 <pre>Gets one floodlight configuration by ID. 101 102Args: 103 profileId: string, User profile ID associated with this request. (required) 104 id: string, Floodlight configuration ID. (required) 105 x__xgafv: string, V1 error format. 106 Allowed values 107 1 - v1 error format 108 2 - v2 error format 109 110Returns: 111 An object of the form: 112 113 { # Contains properties of a Floodlight configuration. 114 "accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank. 115 "advertiserId": "A String", # Advertiser ID of the parent advertiser of this floodlight configuration. 116 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 117 "dimensionName": "A String", # The name of the dimension. 118 "etag": "A String", # The eTag of this response for caching purposes. 119 "id": "A String", # The ID associated with the value if available. 120 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 121 "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. 122 "value": "A String", # The value of the dimension. 123 }, 124 "analyticsDataSharingEnabled": True or False, # Whether advertiser data is shared with Google Analytics. 125 "customViewabilityMetric": { # Custom Viewability Metric # Custom Viewability metric for the floodlight configuration. 126 "configuration": { # The attributes, like playtime and percent onscreen, that define the Custom Viewability Metric. # Configuration of the custom viewability metric. 127 "audible": True or False, # Whether the video must be audible to count an impression. 128 "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. 129 "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. 130 "viewabilityPercent": 42, # The percentage of video that must be on screen for the Custom Viewability Metric to count an impression. 131 }, 132 "id": "A String", # ID of the custom viewability metric. 133 "name": "A String", # Name of the custom viewability metric. 134 }, 135 "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. 136 "firstDayOfWeek": "A String", # Day that will be counted as the first day of the week in reports. This is a required field. 137 "id": "A String", # ID of this floodlight configuration. This is a read-only, auto-generated field. 138 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field. 139 "dimensionName": "A String", # The name of the dimension. 140 "etag": "A String", # The eTag of this response for caching purposes. 141 "id": "A String", # The ID associated with the value if available. 142 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 143 "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. 144 "value": "A String", # The value of the dimension. 145 }, 146 "inAppAttributionTrackingEnabled": True or False, # Whether in-app attribution tracking is enabled. 147 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration". 148 "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration. 149 "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. 150 "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. 151 }, 152 "naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions. 153 "omnitureSettings": { # Omniture Integration Settings. # Settings for Campaign Manager Omniture integration. 154 "omnitureCostDataEnabled": True or False, # Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true. 155 "omnitureIntegrationEnabled": True or False, # Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled. 156 }, 157 "subaccountId": "A String", # Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank. 158 "tagSettings": { # Dynamic and Image Tag Settings. # Configuration settings for dynamic and image floodlight tags. 159 "dynamicTagEnabled": True or False, # Whether dynamic floodlight tags are enabled. 160 "imageTagEnabled": True or False, # Whether image tags are enabled. 161 }, 162 "thirdPartyAuthenticationTokens": [ # List of third-party authentication tokens enabled for this configuration. 163 { # Third Party Authentication Token 164 "name": "A String", # Name of the third-party authentication token. 165 "value": "A String", # Value of the third-party authentication token. This is a read-only, auto-generated field. 166 }, 167 ], 168 "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration. 169 { # User Defined Variable configuration. 170 "dataType": "A String", # Data type for the variable. This is a required field. 171 "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: ""<>". 172 "variableType": "A String", # Variable name in the tag. This is a required field. 173 }, 174 ], 175}</pre> 176</div> 177 178<div class="method"> 179 <code class="details" id="list">list(profileId, ids=None, x__xgafv=None)</code> 180 <pre>Retrieves a list of floodlight configurations, possibly filtered. 181 182Args: 183 profileId: string, User profile ID associated with this request. (required) 184 ids: string, Set of IDs of floodlight configurations to retrieve. Required field; otherwise an empty list will be returned. (repeated) 185 x__xgafv: string, V1 error format. 186 Allowed values 187 1 - v1 error format 188 2 - v2 error format 189 190Returns: 191 An object of the form: 192 193 { # Floodlight Configuration List Response 194 "floodlightConfigurations": [ # Floodlight configuration collection. 195 { # Contains properties of a Floodlight configuration. 196 "accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank. 197 "advertiserId": "A String", # Advertiser ID of the parent advertiser of this floodlight configuration. 198 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 199 "dimensionName": "A String", # The name of the dimension. 200 "etag": "A String", # The eTag of this response for caching purposes. 201 "id": "A String", # The ID associated with the value if available. 202 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 203 "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. 204 "value": "A String", # The value of the dimension. 205 }, 206 "analyticsDataSharingEnabled": True or False, # Whether advertiser data is shared with Google Analytics. 207 "customViewabilityMetric": { # Custom Viewability Metric # Custom Viewability metric for the floodlight configuration. 208 "configuration": { # The attributes, like playtime and percent onscreen, that define the Custom Viewability Metric. # Configuration of the custom viewability metric. 209 "audible": True or False, # Whether the video must be audible to count an impression. 210 "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. 211 "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. 212 "viewabilityPercent": 42, # The percentage of video that must be on screen for the Custom Viewability Metric to count an impression. 213 }, 214 "id": "A String", # ID of the custom viewability metric. 215 "name": "A String", # Name of the custom viewability metric. 216 }, 217 "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. 218 "firstDayOfWeek": "A String", # Day that will be counted as the first day of the week in reports. This is a required field. 219 "id": "A String", # ID of this floodlight configuration. This is a read-only, auto-generated field. 220 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field. 221 "dimensionName": "A String", # The name of the dimension. 222 "etag": "A String", # The eTag of this response for caching purposes. 223 "id": "A String", # The ID associated with the value if available. 224 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 225 "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. 226 "value": "A String", # The value of the dimension. 227 }, 228 "inAppAttributionTrackingEnabled": True or False, # Whether in-app attribution tracking is enabled. 229 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration". 230 "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration. 231 "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. 232 "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. 233 }, 234 "naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions. 235 "omnitureSettings": { # Omniture Integration Settings. # Settings for Campaign Manager Omniture integration. 236 "omnitureCostDataEnabled": True or False, # Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true. 237 "omnitureIntegrationEnabled": True or False, # Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled. 238 }, 239 "subaccountId": "A String", # Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank. 240 "tagSettings": { # Dynamic and Image Tag Settings. # Configuration settings for dynamic and image floodlight tags. 241 "dynamicTagEnabled": True or False, # Whether dynamic floodlight tags are enabled. 242 "imageTagEnabled": True or False, # Whether image tags are enabled. 243 }, 244 "thirdPartyAuthenticationTokens": [ # List of third-party authentication tokens enabled for this configuration. 245 { # Third Party Authentication Token 246 "name": "A String", # Name of the third-party authentication token. 247 "value": "A String", # Value of the third-party authentication token. This is a read-only, auto-generated field. 248 }, 249 ], 250 "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration. 251 { # User Defined Variable configuration. 252 "dataType": "A String", # Data type for the variable. This is a required field. 253 "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: ""<>". 254 "variableType": "A String", # Variable name in the tag. This is a required field. 255 }, 256 ], 257 }, 258 ], 259 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfigurationsListResponse". 260}</pre> 261</div> 262 263<div class="method"> 264 <code class="details" id="patch">patch(profileId, id, body=None, x__xgafv=None)</code> 265 <pre>Updates an existing floodlight configuration. This method supports patch semantics. 266 267Args: 268 profileId: string, User profile ID associated with this request. (required) 269 id: string, FloodlightConfiguration ID. (required) 270 body: object, The request body. 271 The object takes the form of: 272 273{ # Contains properties of a Floodlight configuration. 274 "accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank. 275 "advertiserId": "A String", # Advertiser ID of the parent advertiser of this floodlight configuration. 276 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 277 "dimensionName": "A String", # The name of the dimension. 278 "etag": "A String", # The eTag of this response for caching purposes. 279 "id": "A String", # The ID associated with the value if available. 280 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 281 "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. 282 "value": "A String", # The value of the dimension. 283 }, 284 "analyticsDataSharingEnabled": True or False, # Whether advertiser data is shared with Google Analytics. 285 "customViewabilityMetric": { # Custom Viewability Metric # Custom Viewability metric for the floodlight configuration. 286 "configuration": { # The attributes, like playtime and percent onscreen, that define the Custom Viewability Metric. # Configuration of the custom viewability metric. 287 "audible": True or False, # Whether the video must be audible to count an impression. 288 "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. 289 "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. 290 "viewabilityPercent": 42, # The percentage of video that must be on screen for the Custom Viewability Metric to count an impression. 291 }, 292 "id": "A String", # ID of the custom viewability metric. 293 "name": "A String", # Name of the custom viewability metric. 294 }, 295 "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. 296 "firstDayOfWeek": "A String", # Day that will be counted as the first day of the week in reports. This is a required field. 297 "id": "A String", # ID of this floodlight configuration. This is a read-only, auto-generated field. 298 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field. 299 "dimensionName": "A String", # The name of the dimension. 300 "etag": "A String", # The eTag of this response for caching purposes. 301 "id": "A String", # The ID associated with the value if available. 302 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 303 "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. 304 "value": "A String", # The value of the dimension. 305 }, 306 "inAppAttributionTrackingEnabled": True or False, # Whether in-app attribution tracking is enabled. 307 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration". 308 "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration. 309 "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. 310 "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. 311 }, 312 "naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions. 313 "omnitureSettings": { # Omniture Integration Settings. # Settings for Campaign Manager Omniture integration. 314 "omnitureCostDataEnabled": True or False, # Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true. 315 "omnitureIntegrationEnabled": True or False, # Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled. 316 }, 317 "subaccountId": "A String", # Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank. 318 "tagSettings": { # Dynamic and Image Tag Settings. # Configuration settings for dynamic and image floodlight tags. 319 "dynamicTagEnabled": True or False, # Whether dynamic floodlight tags are enabled. 320 "imageTagEnabled": True or False, # Whether image tags are enabled. 321 }, 322 "thirdPartyAuthenticationTokens": [ # List of third-party authentication tokens enabled for this configuration. 323 { # Third Party Authentication Token 324 "name": "A String", # Name of the third-party authentication token. 325 "value": "A String", # Value of the third-party authentication token. This is a read-only, auto-generated field. 326 }, 327 ], 328 "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration. 329 { # User Defined Variable configuration. 330 "dataType": "A String", # Data type for the variable. This is a required field. 331 "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: ""<>". 332 "variableType": "A String", # Variable name in the tag. This is a required field. 333 }, 334 ], 335} 336 337 x__xgafv: string, V1 error format. 338 Allowed values 339 1 - v1 error format 340 2 - v2 error format 341 342Returns: 343 An object of the form: 344 345 { # Contains properties of a Floodlight configuration. 346 "accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank. 347 "advertiserId": "A String", # Advertiser ID of the parent advertiser of this floodlight configuration. 348 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 349 "dimensionName": "A String", # The name of the dimension. 350 "etag": "A String", # The eTag of this response for caching purposes. 351 "id": "A String", # The ID associated with the value if available. 352 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 353 "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. 354 "value": "A String", # The value of the dimension. 355 }, 356 "analyticsDataSharingEnabled": True or False, # Whether advertiser data is shared with Google Analytics. 357 "customViewabilityMetric": { # Custom Viewability Metric # Custom Viewability metric for the floodlight configuration. 358 "configuration": { # The attributes, like playtime and percent onscreen, that define the Custom Viewability Metric. # Configuration of the custom viewability metric. 359 "audible": True or False, # Whether the video must be audible to count an impression. 360 "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. 361 "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. 362 "viewabilityPercent": 42, # The percentage of video that must be on screen for the Custom Viewability Metric to count an impression. 363 }, 364 "id": "A String", # ID of the custom viewability metric. 365 "name": "A String", # Name of the custom viewability metric. 366 }, 367 "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. 368 "firstDayOfWeek": "A String", # Day that will be counted as the first day of the week in reports. This is a required field. 369 "id": "A String", # ID of this floodlight configuration. This is a read-only, auto-generated field. 370 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field. 371 "dimensionName": "A String", # The name of the dimension. 372 "etag": "A String", # The eTag of this response for caching purposes. 373 "id": "A String", # The ID associated with the value if available. 374 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 375 "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. 376 "value": "A String", # The value of the dimension. 377 }, 378 "inAppAttributionTrackingEnabled": True or False, # Whether in-app attribution tracking is enabled. 379 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration". 380 "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration. 381 "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. 382 "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. 383 }, 384 "naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions. 385 "omnitureSettings": { # Omniture Integration Settings. # Settings for Campaign Manager Omniture integration. 386 "omnitureCostDataEnabled": True or False, # Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true. 387 "omnitureIntegrationEnabled": True or False, # Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled. 388 }, 389 "subaccountId": "A String", # Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank. 390 "tagSettings": { # Dynamic and Image Tag Settings. # Configuration settings for dynamic and image floodlight tags. 391 "dynamicTagEnabled": True or False, # Whether dynamic floodlight tags are enabled. 392 "imageTagEnabled": True or False, # Whether image tags are enabled. 393 }, 394 "thirdPartyAuthenticationTokens": [ # List of third-party authentication tokens enabled for this configuration. 395 { # Third Party Authentication Token 396 "name": "A String", # Name of the third-party authentication token. 397 "value": "A String", # Value of the third-party authentication token. This is a read-only, auto-generated field. 398 }, 399 ], 400 "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration. 401 { # User Defined Variable configuration. 402 "dataType": "A String", # Data type for the variable. This is a required field. 403 "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: ""<>". 404 "variableType": "A String", # Variable name in the tag. This is a required field. 405 }, 406 ], 407}</pre> 408</div> 409 410<div class="method"> 411 <code class="details" id="update">update(profileId, body=None, x__xgafv=None)</code> 412 <pre>Updates an existing floodlight configuration. 413 414Args: 415 profileId: string, User profile ID associated with this request. (required) 416 body: object, The request body. 417 The object takes the form of: 418 419{ # Contains properties of a Floodlight configuration. 420 "accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank. 421 "advertiserId": "A String", # Advertiser ID of the parent advertiser of this floodlight configuration. 422 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 423 "dimensionName": "A String", # The name of the dimension. 424 "etag": "A String", # The eTag of this response for caching purposes. 425 "id": "A String", # The ID associated with the value if available. 426 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 427 "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. 428 "value": "A String", # The value of the dimension. 429 }, 430 "analyticsDataSharingEnabled": True or False, # Whether advertiser data is shared with Google Analytics. 431 "customViewabilityMetric": { # Custom Viewability Metric # Custom Viewability metric for the floodlight configuration. 432 "configuration": { # The attributes, like playtime and percent onscreen, that define the Custom Viewability Metric. # Configuration of the custom viewability metric. 433 "audible": True or False, # Whether the video must be audible to count an impression. 434 "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. 435 "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. 436 "viewabilityPercent": 42, # The percentage of video that must be on screen for the Custom Viewability Metric to count an impression. 437 }, 438 "id": "A String", # ID of the custom viewability metric. 439 "name": "A String", # Name of the custom viewability metric. 440 }, 441 "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. 442 "firstDayOfWeek": "A String", # Day that will be counted as the first day of the week in reports. This is a required field. 443 "id": "A String", # ID of this floodlight configuration. This is a read-only, auto-generated field. 444 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field. 445 "dimensionName": "A String", # The name of the dimension. 446 "etag": "A String", # The eTag of this response for caching purposes. 447 "id": "A String", # The ID associated with the value if available. 448 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 449 "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. 450 "value": "A String", # The value of the dimension. 451 }, 452 "inAppAttributionTrackingEnabled": True or False, # Whether in-app attribution tracking is enabled. 453 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration". 454 "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration. 455 "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. 456 "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. 457 }, 458 "naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions. 459 "omnitureSettings": { # Omniture Integration Settings. # Settings for Campaign Manager Omniture integration. 460 "omnitureCostDataEnabled": True or False, # Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true. 461 "omnitureIntegrationEnabled": True or False, # Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled. 462 }, 463 "subaccountId": "A String", # Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank. 464 "tagSettings": { # Dynamic and Image Tag Settings. # Configuration settings for dynamic and image floodlight tags. 465 "dynamicTagEnabled": True or False, # Whether dynamic floodlight tags are enabled. 466 "imageTagEnabled": True or False, # Whether image tags are enabled. 467 }, 468 "thirdPartyAuthenticationTokens": [ # List of third-party authentication tokens enabled for this configuration. 469 { # Third Party Authentication Token 470 "name": "A String", # Name of the third-party authentication token. 471 "value": "A String", # Value of the third-party authentication token. This is a read-only, auto-generated field. 472 }, 473 ], 474 "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration. 475 { # User Defined Variable configuration. 476 "dataType": "A String", # Data type for the variable. This is a required field. 477 "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: ""<>". 478 "variableType": "A String", # Variable name in the tag. This is a required field. 479 }, 480 ], 481} 482 483 x__xgafv: string, V1 error format. 484 Allowed values 485 1 - v1 error format 486 2 - v2 error format 487 488Returns: 489 An object of the form: 490 491 { # Contains properties of a Floodlight configuration. 492 "accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank. 493 "advertiserId": "A String", # Advertiser ID of the parent advertiser of this floodlight configuration. 494 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 495 "dimensionName": "A String", # The name of the dimension. 496 "etag": "A String", # The eTag of this response for caching purposes. 497 "id": "A String", # The ID associated with the value if available. 498 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 499 "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. 500 "value": "A String", # The value of the dimension. 501 }, 502 "analyticsDataSharingEnabled": True or False, # Whether advertiser data is shared with Google Analytics. 503 "customViewabilityMetric": { # Custom Viewability Metric # Custom Viewability metric for the floodlight configuration. 504 "configuration": { # The attributes, like playtime and percent onscreen, that define the Custom Viewability Metric. # Configuration of the custom viewability metric. 505 "audible": True or False, # Whether the video must be audible to count an impression. 506 "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. 507 "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. 508 "viewabilityPercent": 42, # The percentage of video that must be on screen for the Custom Viewability Metric to count an impression. 509 }, 510 "id": "A String", # ID of the custom viewability metric. 511 "name": "A String", # Name of the custom viewability metric. 512 }, 513 "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. 514 "firstDayOfWeek": "A String", # Day that will be counted as the first day of the week in reports. This is a required field. 515 "id": "A String", # ID of this floodlight configuration. This is a read-only, auto-generated field. 516 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field. 517 "dimensionName": "A String", # The name of the dimension. 518 "etag": "A String", # The eTag of this response for caching purposes. 519 "id": "A String", # The ID associated with the value if available. 520 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 521 "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. 522 "value": "A String", # The value of the dimension. 523 }, 524 "inAppAttributionTrackingEnabled": True or False, # Whether in-app attribution tracking is enabled. 525 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration". 526 "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration. 527 "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. 528 "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. 529 }, 530 "naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions. 531 "omnitureSettings": { # Omniture Integration Settings. # Settings for Campaign Manager Omniture integration. 532 "omnitureCostDataEnabled": True or False, # Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true. 533 "omnitureIntegrationEnabled": True or False, # Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled. 534 }, 535 "subaccountId": "A String", # Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank. 536 "tagSettings": { # Dynamic and Image Tag Settings. # Configuration settings for dynamic and image floodlight tags. 537 "dynamicTagEnabled": True or False, # Whether dynamic floodlight tags are enabled. 538 "imageTagEnabled": True or False, # Whether image tags are enabled. 539 }, 540 "thirdPartyAuthenticationTokens": [ # List of third-party authentication tokens enabled for this configuration. 541 { # Third Party Authentication Token 542 "name": "A String", # Name of the third-party authentication token. 543 "value": "A String", # Value of the third-party authentication token. This is a read-only, auto-generated field. 544 }, 545 ], 546 "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration. 547 { # User Defined Variable configuration. 548 "dataType": "A String", # Data type for the variable. This is a required field. 549 "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: ""<>". 550 "variableType": "A String", # Variable name in the tag. This is a required field. 551 }, 552 ], 553}</pre> 554</div> 555 556</body></html>