- Resource: FloodlightConfiguration
- FirstDayOfWeek
- NaturalSearchConversionAttributionOption
- OmnitureSettings
- TagSettings
- UserDefinedVariableConfiguration
- VariableDataType
- ThirdPartyAuthenticationToken
- CustomViewabilityMetric
- CustomViewabilityMetricConfiguration
- Methods
Resource: FloodlightConfiguration
Contains properties of a Floodlight configuration.
JSON representation |
---|
{ "id": string, "accountId": string, "subaccountId": string, "advertiserId": string, "firstDayOfWeek": enum ( |
Fields | |
---|---|
id |
ID of this floodlight configuration. This is a read-only, auto-generated field. |
accountId |
Account ID of this floodlight configuration. This is a read-only field that can be left blank. |
subaccountId |
Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank. |
advertiserId |
Advertiser ID of the parent advertiser of this floodlight configuration. |
firstDayOfWeek |
|
lookbackConfiguration |
Lookback window settings for this floodlight configuration. |
naturalSearchConversionAttributionOption |
Types of attribution options for natural search conversions. |
omnitureSettings |
Settings for Campaign Manager Omniture integration. |
exposureToConversionEnabled |
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 |
Configuration settings for dynamic and image floodlight tags. |
kind |
Identifies what kind of resource this is. Value: the fixed string
. |
userDefinedVariableConfigurations[] |
floodlightConfigurations.list of user defined variables enabled for this configuration. |
analyticsDataSharingEnabled |
Whether advertiser data is shared with Google Analytics. |
idDimensionValue |
Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field. |
advertiserIdDimensionValue |
Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. |
inAppAttributionTrackingEnabled |
Whether in-app attribution tracking is enabled. |
thirdPartyAuthenticationTokens[] |
floodlightConfigurations.list of third-party authentication tokens enabled for this configuration. |
customViewabilityMetric |
Custom Viewability metric for the floodlight configuration. |
FirstDayOfWeek
Day that will be counted as the first day of the week in reports. This is a required field.
Enums | |
---|---|
SUNDAY |
|
MONDAY |
NaturalSearchConversionAttributionOption
Types of attribution options for natural search conversions.
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 |
Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled. |
omnitureCostDataEnabled |
Whether placement cost data will be sent to Omniture. This property can be enabled only if
is true. |
TagSettings
Dynamic and Image Tag Settings.
JSON representation |
---|
{ "dynamicTagEnabled": boolean, "imageTagEnabled": boolean } |
Fields | |
---|---|
dynamicTagEnabled |
Whether dynamic floodlight tags are enabled. |
imageTagEnabled |
Whether image tags are enabled. |
UserDefinedVariableConfiguration
User Defined Variable configuration.
JSON representation |
---|
{ "variableType": enum ( |
Fields | |
---|---|
variableType |
Variable name in the tag. This is a required field. |
dataType |
Data type for the variable. This is a required field. |
reportName |
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: "
". |
VariableDataType
Data types for spotlight variables.
Enums | |
---|---|
STRING |
|
NUMBER |
ThirdPartyAuthenticationToken
Third Party Authentication Token
JSON representation |
---|
{ "name": string, "value": string } |
Fields | |
---|---|
name |
Name of the third-party authentication token. |
value |
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 ( |
Fields | |
---|---|
id |
ID of the custom viewability metric. |
name |
Name of the custom viewability metric. |
configuration |
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 |
The percentage of video that must be on screen for the Custom Viewability Metric to count an impression. |
audible |
Whether the video must be audible to count an impression. |
timeMillis |
The time in milliseconds the video must play for the Custom Viewability Metric to count an impression. If both this and
are specified, the earlier of the two will be used. |
timePercent |
The percentage of video that must play for the Custom Viewability Metric to count an impression. If both this and
are specified, the earlier of the two will be used. |
Methods |
|
---|---|
|
Gets one floodlight configuration by ID. |
|
Retrieves a list of floodlight configurations, possibly filtered. |
|
Updates an existing floodlight configuration. |
|
Updates an existing floodlight configuration. |