List
|
|||||
|
|
||||
Retrieves a list of floodlight configurations, possibly filtered
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- View and manage your DoubleClick Campaign Manager's (DCM) display ad campaigns
Input
This building block consumes 2 input parameters
| Name | Format | Description |
|---|---|---|
profileId Required |
INTEGER |
User profile ID associated with this request |
ids |
INTEGER |
Set of IDs of floodlight configurations to retrieve. Required field; otherwise an empty list will be returned |
= Parameter name
= Format
|
profileId INTEGER Required User profile ID associated with this request |
|
ids INTEGER Set of IDs of floodlight configurations to retrieve. Required field; otherwise an empty list will be returned |
Output
This building block provides 50 output parameters
| Name | Format | Description |
|---|---|---|
floodlightConfigurations[] |
OBJECT |
Contains properties of a Floodlight configuration |
floodlightConfigurations[].accountId |
INTEGER |
Account ID of this floodlight configuration. This is a read-only field that can be left blank |
floodlightConfigurations[].advertiserId |
INTEGER |
Advertiser ID of the parent advertiser of this floodlight configuration |
floodlightConfigurations[].advertiserIdDimensionValue |
OBJECT |
Represents a DimensionValue resource |
floodlightConfigurations[].advertiserIdDimensionValue.dimensionName |
STRING |
The name of the dimension |
floodlightConfigurations[].advertiserIdDimensionValue.etag |
STRING |
The eTag of this response for caching purposes |
floodlightConfigurations[].advertiserIdDimensionValue.id |
STRING |
The ID associated with the value if available |
floodlightConfigurations[].advertiserIdDimensionValue.kind |
STRING |
The kind of resource this is, in this case dfareporting#dimensionValue |
floodlightConfigurations[].advertiserIdDimensionValue.matchType |
ENUMERATION |
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 |
floodlightConfigurations[].advertiserIdDimensionValue.value |
STRING |
The value of the dimension |
floodlightConfigurations[].analyticsDataSharingEnabled |
BOOLEAN |
Whether advertiser data is shared with Google Analytics |
floodlightConfigurations[].customViewabilityMetric |
OBJECT |
Custom Viewability Metric |
floodlightConfigurations[].customViewabilityMetric.configuration |
OBJECT |
The attributes, like playtime and percent onscreen, that define the Custom Viewability Metric |
floodlightConfigurations[].customViewabilityMetric.configuration.audible |
BOOLEAN |
Whether the video must be audible to count an impression |
floodlightConfigurations[].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 |
floodlightConfigurations[].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 |
floodlightConfigurations[].customViewabilityMetric.configuration.viewabilityPercent |
INTEGER |
The percentage of video that must be on screen for the Custom Viewability Metric to count an impression |
floodlightConfigurations[].customViewabilityMetric.id |
INTEGER |
ID of the custom viewability metric |
floodlightConfigurations[].customViewabilityMetric.name |
STRING |
Name of the custom viewability metric |
floodlightConfigurations[].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 |
floodlightConfigurations[].firstDayOfWeek |
ENUMERATION |
Day that will be counted as the first day of the week in reports. This is a required field |
floodlightConfigurations[].id |
INTEGER |
ID of this floodlight configuration. This is a read-only, auto-generated field |
floodlightConfigurations[].idDimensionValue |
OBJECT |
Represents a DimensionValue resource |
floodlightConfigurations[].idDimensionValue.dimensionName |
STRING |
The name of the dimension |
floodlightConfigurations[].idDimensionValue.etag |
STRING |
The eTag of this response for caching purposes |
floodlightConfigurations[].idDimensionValue.id |
STRING |
The ID associated with the value if available |
floodlightConfigurations[].idDimensionValue.kind |
STRING |
The kind of resource this is, in this case dfareporting#dimensionValue |
floodlightConfigurations[].idDimensionValue.matchType |
ENUMERATION |
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 |
floodlightConfigurations[].idDimensionValue.value |
STRING |
The value of the dimension |
floodlightConfigurations[].inAppAttributionTrackingEnabled |
BOOLEAN |
Whether in-app attribution tracking is enabled |
floodlightConfigurations[].kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration" |
floodlightConfigurations[].lookbackConfiguration |
OBJECT |
Lookback configuration settings |
floodlightConfigurations[].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 |
floodlightConfigurations[].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 |
floodlightConfigurations[].naturalSearchConversionAttributionOption |
ENUMERATION |
Types of attribution options for natural search conversions |
floodlightConfigurations[].omnitureSettings |
OBJECT |
Omniture Integration Settings |
floodlightConfigurations[].omnitureSettings.omnitureCostDataEnabled |
BOOLEAN |
Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true |
floodlightConfigurations[].omnitureSettings.omnitureIntegrationEnabled |
BOOLEAN |
Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled |
floodlightConfigurations[].subaccountId |
INTEGER |
Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank |
floodlightConfigurations[].tagSettings |
OBJECT |
Dynamic and Image Tag Settings |
floodlightConfigurations[].tagSettings.dynamicTagEnabled |
BOOLEAN |
Whether dynamic floodlight tags are enabled |
floodlightConfigurations[].tagSettings.imageTagEnabled |
BOOLEAN |
Whether image tags are enabled |
floodlightConfigurations[].thirdPartyAuthenticationTokens[] |
OBJECT |
Third Party Authentication Token |
floodlightConfigurations[].thirdPartyAuthenticationTokens[].name |
STRING |
Name of the third-party authentication token |
floodlightConfigurations[].thirdPartyAuthenticationTokens[].value |
STRING |
Value of the third-party authentication token. This is a read-only, auto-generated field |
floodlightConfigurations[].userDefinedVariableConfigurations[] |
OBJECT |
User Defined Variable configuration |
floodlightConfigurations[].userDefinedVariableConfigurations[].dataType |
ENUMERATION |
Data type for the variable. This is a required field |
floodlightConfigurations[].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: ""<>" |
floodlightConfigurations[].userDefinedVariableConfigurations[].variableType |
ENUMERATION |
Variable name in the tag. This is a required field |
kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfigurationsListResponse" |
= Parameter name
= Format
|
floodlightConfigurations[] OBJECT Contains properties of a Floodlight configuration |
|
floodlightConfigurations[].accountId INTEGER Account ID of this floodlight configuration. This is a read-only field that can be left blank |
|
floodlightConfigurations[].advertiserId INTEGER Advertiser ID of the parent advertiser of this floodlight configuration |
|
floodlightConfigurations[].advertiserIdDimensionValue OBJECT Represents a DimensionValue resource |
|
floodlightConfigurations[].advertiserIdDimensionValue.dimensionName STRING The name of the dimension |
|
floodlightConfigurations[].advertiserIdDimensionValue.etag STRING The eTag of this response for caching purposes |
|
floodlightConfigurations[].advertiserIdDimensionValue.id STRING The ID associated with the value if available |
|
floodlightConfigurations[].advertiserIdDimensionValue.kind STRING The kind of resource this is, in this case dfareporting#dimensionValue |
|
floodlightConfigurations[].advertiserIdDimensionValue.matchType ENUMERATION 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 |
|
floodlightConfigurations[].advertiserIdDimensionValue.value STRING The value of the dimension |
|
floodlightConfigurations[].analyticsDataSharingEnabled BOOLEAN Whether advertiser data is shared with Google Analytics |
|
floodlightConfigurations[].customViewabilityMetric OBJECT Custom Viewability Metric |
|
floodlightConfigurations[].customViewabilityMetric.configuration OBJECT The attributes, like playtime and percent onscreen, that define the Custom Viewability Metric |
|
floodlightConfigurations[].customViewabilityMetric.configuration.audible BOOLEAN Whether the video must be audible to count an impression |
|
floodlightConfigurations[].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 |
|
floodlightConfigurations[].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 |
|
floodlightConfigurations[].customViewabilityMetric.configuration.viewabilityPercent INTEGER The percentage of video that must be on screen for the Custom Viewability Metric to count an impression |
|
floodlightConfigurations[].customViewabilityMetric.id INTEGER ID of the custom viewability metric |
|
floodlightConfigurations[].customViewabilityMetric.name STRING Name of the custom viewability metric |
|
floodlightConfigurations[].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 |
|
floodlightConfigurations[].firstDayOfWeek ENUMERATION Day that will be counted as the first day of the week in reports. This is a required field |
|
floodlightConfigurations[].id INTEGER ID of this floodlight configuration. This is a read-only, auto-generated field |
|
floodlightConfigurations[].idDimensionValue OBJECT Represents a DimensionValue resource |
|
floodlightConfigurations[].idDimensionValue.dimensionName STRING The name of the dimension |
|
floodlightConfigurations[].idDimensionValue.etag STRING The eTag of this response for caching purposes |
|
floodlightConfigurations[].idDimensionValue.id STRING The ID associated with the value if available |
|
floodlightConfigurations[].idDimensionValue.kind STRING The kind of resource this is, in this case dfareporting#dimensionValue |
|
floodlightConfigurations[].idDimensionValue.matchType ENUMERATION 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 |
|
floodlightConfigurations[].idDimensionValue.value STRING The value of the dimension |
|
floodlightConfigurations[].inAppAttributionTrackingEnabled BOOLEAN Whether in-app attribution tracking is enabled |
|
floodlightConfigurations[].kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration" |
|
floodlightConfigurations[].lookbackConfiguration OBJECT Lookback configuration settings |
|
floodlightConfigurations[].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 |
|
floodlightConfigurations[].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 |
|
floodlightConfigurations[].naturalSearchConversionAttributionOption ENUMERATION Types of attribution options for natural search conversions |
|
floodlightConfigurations[].omnitureSettings OBJECT Omniture Integration Settings |
|
floodlightConfigurations[].omnitureSettings.omnitureCostDataEnabled BOOLEAN Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true |
|
floodlightConfigurations[].omnitureSettings.omnitureIntegrationEnabled BOOLEAN Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled |
|
floodlightConfigurations[].subaccountId INTEGER Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank |
|
floodlightConfigurations[].tagSettings OBJECT Dynamic and Image Tag Settings |
|
floodlightConfigurations[].tagSettings.dynamicTagEnabled BOOLEAN Whether dynamic floodlight tags are enabled |
|
floodlightConfigurations[].tagSettings.imageTagEnabled BOOLEAN Whether image tags are enabled |
|
floodlightConfigurations[].thirdPartyAuthenticationTokens[] OBJECT Third Party Authentication Token |
|
floodlightConfigurations[].thirdPartyAuthenticationTokens[].name STRING Name of the third-party authentication token |
|
floodlightConfigurations[].thirdPartyAuthenticationTokens[].value STRING Value of the third-party authentication token. This is a read-only, auto-generated field |
|
floodlightConfigurations[].userDefinedVariableConfigurations[] OBJECT User Defined Variable configuration |
|
floodlightConfigurations[].userDefinedVariableConfigurations[].dataType ENUMERATION Data type for the variable. This is a required field |
|
floodlightConfigurations[].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: ""<>" |
|
floodlightConfigurations[].userDefinedVariableConfigurations[].variableType ENUMERATION Variable name in the tag. This is a required field |
|
kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfigurationsListResponse" |