FloodlightConfigurations

For a list of methods for this resource, see the end of this page.

Resource representations

Contains properties of a Floodlight configuration.

{
  "kind": "dfareporting#floodlightConfiguration",
  "id": long,
  "idDimensionValue": dimensionValues Resource,
  "accountId": long,
  "subaccountId": long,
  "advertiserId": long,
  "advertiserIdDimensionValue": dimensionValues Resource,
  "firstDayOfWeek": string,
  "lookbackConfiguration": {
    "clickDuration": integer,
    "postImpressionActivitiesDuration": integer
  },
  "naturalSearchConversionAttributionOption": string,
  "omnitureSettings": {
    "omnitureIntegrationEnabled": boolean,
    "omnitureCostDataEnabled": boolean
  },
  "exposureToConversionEnabled": boolean,
  "tagSettings": {
    "dynamicTagEnabled": boolean,
    "imageTagEnabled": boolean
  },
  "userDefinedVariableConfigurations": [
    {
      "variableType": string,
      "dataType": string,
      "reportName": string
    }
  ],
  "analyticsDataSharingEnabled": boolean,
  "inAppAttributionTrackingEnabled": boolean,
  "thirdPartyAuthenticationTokens": [
    {
      "name": string,
      "value": string
    }
  ],
  "customViewabilityMetric": {
    "id": long,
    "name": string,
    "configuration": {
      "viewabilityPercent": integer,
      "audible": boolean,
      "timeMillis": integer,
      "timePercent": integer
    }
  }
}

Property name	Value	Description
`accountId`	`long`	Account ID of this floodlight configuration. This is a read-only field that can be left blank.
`advertiserId`	`long`	Advertiser ID of the parent advertiser of this floodlight configuration.
`advertiserIdDimensionValue`	`nested object`	Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
`analyticsDataSharingEnabled`	`boolean`	Whether advertiser data is shared with Google Analytics.
`customViewabilityMetric`	`nested object`	Custom Viewability metric for the floodlight configuration.
`customViewabilityMetric.configuration`	`nested object`	Configuration of the custom viewability metric.
`customViewabilityMetric.configuration.audible`	`boolean`	Whether the video must be audible to count an impression.
`customViewabilityMetric.configuration.timeMillis`	`integer`	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.
`customViewabilityMetric.configuration.timePercent`	`integer`	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.
`customViewabilityMetric.configuration.viewabilityPercent`	`integer`	The percentage of video that must be on screen for the Custom Viewability Metric to count an impression.
`customViewabilityMetric.id`	`long`	ID of the custom viewability metric.
`customViewabilityMetric.name`	`string`	Name of the custom viewability metric.
`exposureToConversionEnabled`	`boolean`	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`	`string`	Day that will be counted as the first day of the week in reports. This is a required field. Acceptable values are: "`MONDAY`" "`SUNDAY`"
`id`	`long`	ID of this floodlight configuration. This is a read-only, auto-generated field.
`idDimensionValue`	`nested object`	Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field.
`inAppAttributionTrackingEnabled`	`boolean`	Whether in-app attribution tracking is enabled.
`kind`	`string`	Identifies what kind of resource this is. Value: the fixed string `"dfareporting#floodlightConfiguration"`.
`lookbackConfiguration`	`nested object`	Lookback window settings for this floodlight configuration.
`lookbackConfiguration.clickDuration`	`integer`	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.
`lookbackConfiguration.postImpressionActivitiesDuration`	`integer`	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`	`string`	Types of attribution options for natural search conversions. Acceptable values are: "`EXCLUDE_NATURAL_SEARCH_CONVERSION_ATTRIBUTION`" "`INCLUDE_NATURAL_SEARCH_CONVERSION_ATTRIBUTION`" "`INCLUDE_NATURAL_SEARCH_TIERED_CONVERSION_ATTRIBUTION`"
`omnitureSettings`	`nested object`	Settings for Campaign Manager Omniture integration.
`omnitureSettings.omnitureCostDataEnabled`	`boolean`	Whether placement cost data will be sent to Omniture. This property can be enabled only if `omnitureIntegrationEnabled` is true.
`omnitureSettings.omnitureIntegrationEnabled`	`boolean`	Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled.
`subaccountId`	`long`	Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.
`tagSettings`	`nested object`	Configuration settings for dynamic and image floodlight tags.
`tagSettings.dynamicTagEnabled`	`boolean`	Whether dynamic floodlight tags are enabled.
`tagSettings.imageTagEnabled`	`boolean`	Whether image tags are enabled.
`thirdPartyAuthenticationTokens[]`	`list`	List of third-party authentication tokens enabled for this configuration.
`thirdPartyAuthenticationTokens[].name`	`string`	Name of the third-party authentication token.
`thirdPartyAuthenticationTokens[].value`	`string`	Value of the third-party authentication token. This is a read-only, auto-generated field.
`userDefinedVariableConfigurations[]`	`list`	List of user defined variables enabled for this configuration.
`userDefinedVariableConfigurations[].dataType`	`string`	Data type for the variable. This is a required field. Acceptable values are: "`NUMBER`" "`STRING`"
`userDefinedVariableConfigurations[].reportName`	`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: "`"<>`".
`userDefinedVariableConfigurations[].variableType`	`string`	Variable name in the tag. This is a required field. Acceptable values are: "`U1`" "`U10`" "`U100`" "`U11`" "`U12`" "`U13`" "`U14`" "`U15`" "`U16`" "`U17`" "`U18`" "`U19`" "`U2`" "`U20`" "`U21`" "`U22`" "`U23`" "`U24`" "`U25`" "`U26`" "`U27`" "`U28`" "`U29`" "`U3`" "`U30`" "`U31`" "`U32`" "`U33`" "`U34`" "`U35`" "`U36`" "`U37`" "`U38`" "`U39`" "`U4`" "`U40`" "`U41`" "`U42`" "`U43`" "`U44`" "`U45`" "`U46`" "`U47`" "`U48`" "`U49`" "`U5`" "`U50`" "`U51`" "`U52`" "`U53`" "`U54`" "`U55`" "`U56`" "`U57`" "`U58`" "`U59`" "`U6`" "`U60`" "`U61`" "`U62`" "`U63`" "`U64`" "`U65`" "`U66`" "`U67`" "`U68`" "`U69`" "`U7`" "`U70`" "`U71`" "`U72`" "`U73`" "`U74`" "`U75`" "`U76`" "`U77`" "`U78`" "`U79`" "`U8`" "`U80`" "`U81`" "`U82`" "`U83`" "`U84`" "`U85`" "`U86`" "`U87`" "`U88`" "`U89`" "`U9`" "`U90`" "`U91`" "`U92`" "`U93`" "`U94`" "`U95`" "`U96`" "`U97`" "`U98`" "`U99`"

Methods

get: Gets one floodlight configuration by ID.
list: Retrieves a list of floodlight configurations, possibly filtered.
patch: Updates an existing floodlight configuration. This method supports patch semantics.
update: Updates an existing floodlight configuration.

Resource representations

Methods

Send feedback about...