The Campaign Manager 360 API v3.4 is deprecated and will be sunset on Dec 24th, 2021. All users must migrate to a newer API version by that date.

REST Resource: floodlightConfigurations

Resource: FloodlightConfiguration

Contains properties of a Floodlight configuration.

JSON representation
{
  "id": string,
  "accountId": string,
  "subaccountId": string,
  "advertiserId": string,
  "firstDayOfWeek": enum (FirstDayOfWeek),
  "lookbackConfiguration": {
    object (LookbackConfiguration)
  },
  "naturalSearchConversionAttributionOption": enum (NaturalSearchConversionAttributionOption),
  "omnitureSettings": {
    object (OmnitureSettings)
  },
  "exposureToConversionEnabled": boolean,
  "tagSettings": {
    object (TagSettings)
  },
  "kind": string,
  "userDefinedVariableConfigurations": [
    {
      object (UserDefinedVariableConfiguration)
    }
  ],
  "analyticsDataSharingEnabled": boolean,
  "idDimensionValue": {
    object (DimensionValue)
  },
  "advertiserIdDimensionValue": {
    object (DimensionValue)
  },
  "inAppAttributionTrackingEnabled": boolean,
  "thirdPartyAuthenticationTokens": [
    {
      object (ThirdPartyAuthenticationToken)
    }
  ],
  "customViewabilityMetric": {
    object (CustomViewabilityMetric)
  }
}
Fields
id

string (int64 format)

ID of this floodlight configuration. This is a read-only, auto-generated field.

accountId

string (int64 format)

Account ID of this floodlight configuration. This is a read-only field that can be left blank.

subaccountId

string (int64 format)

Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.

advertiserId

string (int64 format)

Advertiser ID of the parent advertiser of this floodlight configuration.

firstDayOfWeek

enum (FirstDayOfWeek)

Day that will be counted as the first day of the week in reports. This is a required field.

lookbackConfiguration

object (LookbackConfiguration)

Lookback window settings for this floodlight configuration.

naturalSearchConversionAttributionOption

enum (NaturalSearchConversionAttributionOption)

Types of attribution options for natural search conversions.

omnitureSettings

object (OmnitureSettings)

Settings for Campaign Manager Omniture integration.

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.

tagSettings

object (TagSettings)

Configuration settings for dynamic and image floodlight tags.

kind

string

Identifies what kind of resource this is. Value: the fixed string

"dfareporting#floodlightConfiguration"

.

userDefinedVariableConfigurations[]

object (UserDefinedVariableConfiguration)

accountPermissionGroups.list of user defined variables enabled for this configuration.

analyticsDataSharingEnabled

boolean

Whether advertiser data is shared with Google Analytics.

idDimensionValue

object (DimensionValue)

Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field.

advertiserIdDimensionValue

object (DimensionValue)

Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.

inAppAttributionTrackingEnabled

boolean

Whether in-app attribution tracking is enabled.

thirdPartyAuthenticationTokens[]

object (ThirdPartyAuthenticationToken)

accountPermissionGroups.list of third-party authentication tokens enabled for this configuration.

customViewabilityMetric

object (CustomViewabilityMetric)

Custom Viewability metric for the floodlight configuration.

FirstDayOfWeek

Enums
MONDAY
SUNDAY

NaturalSearchConversionAttributionOption

Enums
EXCLUDE_NATURAL_SEARCH_CONVERSION_ATTRIBUTION
INCLUDE_NATURAL_SEARCH_CONVERSION_ATTRIBUTION
INCLUDE_NATURAL_SEARCH_TIERED_CONVERSION_ATTRIBUTION

OmnitureSettings

Omniture Integration Settings.

JSON representation
{
  "omnitureIntegrationEnabled": boolean,
  "omnitureCostDataEnabled": boolean
}
Fields
omnitureIntegrationEnabled

boolean

Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled.

omnitureCostDataEnabled

boolean

Whether placement cost data will be sent to Omniture. This property can be enabled only if

omnitureIntegrationEnabled

is true.

TagSettings

Dynamic and Image Tag Settings.

JSON representation
{
  "dynamicTagEnabled": boolean,
  "imageTagEnabled": boolean
}
Fields
dynamicTagEnabled

boolean

Whether dynamic floodlight tags are enabled.

imageTagEnabled

boolean

Whether image tags are enabled.

UserDefinedVariableConfiguration

User Defined Variable configuration.

JSON representation
{
  "variableType": enum (VariableType),
  "dataType": enum (DataType),
  "reportName": string
}
Fields
variableType

enum (VariableType)

Variable name in the tag. This is a required field.

dataType

enum (DataType)

Data type for the variable. This is a required field.

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: "

"<>

".

VariableType

Enums
U1
U2
U3
U4
U5
U6
U7
U8
U9
U10
U11
U12
U13
U14
U15
U16
U17
U18
U19
U20
U21
U22
U23
U24
U25
U26
U27
U28
U29
U30
U31
U32
U33
U34
U35
U36
U37
U38
U39
U40
U41
U42
U43
U44
U45
U46
U47
U48
U49
U50
U51
U52
U53
U54
U55
U56
U57
U58
U59
U60
U61
U62
U63
U64
U65
U66
U67
U68
U69
U70
U71
U72
U73
U74
U75
U76
U77
U78
U79
U80
U81
U82
U83
U84
U85
U86
U87
U88
U89
U90
U91
U92
U93
U94
U95
U96
U97
U98
U99
U100

DataType

Enums
STRING
NUMBER

ThirdPartyAuthenticationToken

Third Party Authentication Token

JSON representation
{
  "name": string,
  "value": string
}
Fields
name

string

Name of the third-party authentication token.

value

string

Value of the third-party authentication token. This is a read-only, auto-generated field.

CustomViewabilityMetric

Custom Viewability Metric

JSON representation
{
  "id": string,
  "name": string,
  "configuration": {
    object (CustomViewabilityMetricConfiguration)
  }
}
Fields
id

string (int64 format)

ID of the custom viewability metric.

name

string

Name of the custom viewability metric.

configuration

object (CustomViewabilityMetricConfiguration)

Configuration of the custom viewability metric.

CustomViewabilityMetricConfiguration

The attributes, like playtime and percent onscreen, that define the Custom Viewability Metric.

JSON representation
{
  "viewabilityPercent": integer,
  "audible": boolean,
  "timeMillis": integer,
  "timePercent": integer
}
Fields
viewabilityPercent

integer

The percentage of video that must be on screen for the Custom Viewability Metric to count an impression.

audible

boolean

Whether the video must be audible to count an impression.

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.

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.

Methods

get

Gets one floodlight configuration by ID.

list

Retrieves a list of floodlight configurations, possibly filtered.

patch

Updates an existing floodlight configuration.

update

Updates an existing floodlight configuration.