- [Resource: FloodlightConfiguration](https://developers.google.com/doubleclick-advertisers/rest/v5/floodlightConfigurations#FloodlightConfiguration)
  - [JSON representation](https://developers.google.com/doubleclick-advertisers/rest/v5/floodlightConfigurations#FloodlightConfiguration.SCHEMA_REPRESENTATION)
- [FirstDayOfWeek](https://developers.google.com/doubleclick-advertisers/rest/v5/floodlightConfigurations#FirstDayOfWeek)
- [NaturalSearchConversionAttributionOption](https://developers.google.com/doubleclick-advertisers/rest/v5/floodlightConfigurations#NaturalSearchConversionAttributionOption)
- [OmnitureSettings](https://developers.google.com/doubleclick-advertisers/rest/v5/floodlightConfigurations#OmnitureSettings)
  - [JSON representation](https://developers.google.com/doubleclick-advertisers/rest/v5/floodlightConfigurations#OmnitureSettings.SCHEMA_REPRESENTATION)
- [TagSettings](https://developers.google.com/doubleclick-advertisers/rest/v5/floodlightConfigurations#TagSettings)
  - [JSON representation](https://developers.google.com/doubleclick-advertisers/rest/v5/floodlightConfigurations#TagSettings.SCHEMA_REPRESENTATION)
- [UserDefinedVariableConfiguration](https://developers.google.com/doubleclick-advertisers/rest/v5/floodlightConfigurations#UserDefinedVariableConfiguration)
  - [JSON representation](https://developers.google.com/doubleclick-advertisers/rest/v5/floodlightConfigurations#UserDefinedVariableConfiguration.SCHEMA_REPRESENTATION)
- [VariableDataType](https://developers.google.com/doubleclick-advertisers/rest/v5/floodlightConfigurations#VariableDataType)
- [ThirdPartyAuthenticationToken](https://developers.google.com/doubleclick-advertisers/rest/v5/floodlightConfigurations#ThirdPartyAuthenticationToken)
  - [JSON representation](https://developers.google.com/doubleclick-advertisers/rest/v5/floodlightConfigurations#ThirdPartyAuthenticationToken.SCHEMA_REPRESENTATION)
- [CustomViewabilityMetric](https://developers.google.com/doubleclick-advertisers/rest/v5/floodlightConfigurations#CustomViewabilityMetric)
  - [JSON representation](https://developers.google.com/doubleclick-advertisers/rest/v5/floodlightConfigurations#CustomViewabilityMetric.SCHEMA_REPRESENTATION)
- [CustomViewabilityMetricConfiguration](https://developers.google.com/doubleclick-advertisers/rest/v5/floodlightConfigurations#CustomViewabilityMetricConfiguration)
  - [JSON representation](https://developers.google.com/doubleclick-advertisers/rest/v5/floodlightConfigurations#CustomViewabilityMetricConfiguration.SCHEMA_REPRESENTATION)
- [Methods](https://developers.google.com/doubleclick-advertisers/rest/v5/floodlightConfigurations#METHODS_SUMMARY)

## Resource: FloodlightConfiguration

Contains properties of a [Floodlight configuration](https://support.google.com/dcm/answer/2893922).

| JSON representation |
|---|
| ``` { "id": string, "accountId": string, "subaccountId": string, "advertiserId": string, "firstDayOfWeek": enum (`https://developers.google.com/doubleclick-advertisers/rest/v5/floodlightConfigurations#FirstDayOfWeek`), "lookbackConfiguration": { object (`https://developers.google.com/doubleclick-advertisers/rest/v5/LookbackConfiguration`) }, "naturalSearchConversionAttributionOption": enum (`https://developers.google.com/doubleclick-advertisers/rest/v5/floodlightConfigurations#NaturalSearchConversionAttributionOption`), "omnitureSettings": { object (`https://developers.google.com/doubleclick-advertisers/rest/v5/floodlightConfigurations#OmnitureSettings`) }, "exposureToConversionEnabled": boolean, "tagSettings": { object (`https://developers.google.com/doubleclick-advertisers/rest/v5/floodlightConfigurations#TagSettings`) }, "kind": string, "userDefinedVariableConfigurations": [ { object (`https://developers.google.com/doubleclick-advertisers/rest/v5/floodlightConfigurations#UserDefinedVariableConfiguration`) } ], "analyticsDataSharingEnabled": boolean, "idDimensionValue": { object (`https://developers.google.com/doubleclick-advertisers/rest/v5/DimensionValue`) }, "advertiserIdDimensionValue": { object (`https://developers.google.com/doubleclick-advertisers/rest/v5/DimensionValue`) }, "inAppAttributionTrackingEnabled": boolean, "thirdPartyAuthenticationTokens": [ { object (`https://developers.google.com/doubleclick-advertisers/rest/v5/floodlightConfigurations#ThirdPartyAuthenticationToken`) } ], "customViewabilityMetric": { object (`https://developers.google.com/doubleclick-advertisers/rest/v5/floodlightConfigurations#CustomViewabilityMetric`) } } ``` |

| Fields ||
|---|---|
| `id` | `string (https://developers.google.com/discovery/v1/type-format format)` ID of this floodlight configuration. This is a read-only, auto-generated field. |
| `accountId` | `string (https://developers.google.com/discovery/v1/type-format format)` Account ID of this floodlight configuration. This is a read-only field that can be left blank. |
| `subaccountId` | `string (https://developers.google.com/discovery/v1/type-format format)` Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank. |
| `advertiserId` | `string (https://developers.google.com/discovery/v1/type-format format)` Advertiser ID of the parent advertiser of this floodlight configuration. |
| `firstDayOfWeek` | ``enum (`https://developers.google.com/doubleclick-advertisers/rest/v5/floodlightConfigurations#FirstDayOfWeek`)`` |
| `lookbackConfiguration` | ``object (`https://developers.google.com/doubleclick-advertisers/rest/v5/LookbackConfiguration`)`` Lookback window settings for this floodlight configuration. |
| `naturalSearchConversionAttributionOption` | ``enum (`https://developers.google.com/doubleclick-advertisers/rest/v5/floodlightConfigurations#NaturalSearchConversionAttributionOption`)`` Types of attribution options for natural search conversions. |
| `omnitureSettings` | ``object (`https://developers.google.com/doubleclick-advertisers/rest/v5/floodlightConfigurations#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 (`https://developers.google.com/doubleclick-advertisers/rest/v5/floodlightConfigurations#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 (`https://developers.google.com/doubleclick-advertisers/rest/v5/floodlightConfigurations#UserDefinedVariableConfiguration`)`` floodlightConfigurations.list of user defined variables enabled for this configuration. |
| `analyticsDataSharingEnabled` | `boolean` Whether advertiser data is shared with Google Analytics. |
| `idDimensionValue` | ``object (`https://developers.google.com/doubleclick-advertisers/rest/v5/DimensionValue`)`` Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field. |
| `advertiserIdDimensionValue` | ``object (`https://developers.google.com/doubleclick-advertisers/rest/v5/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 (`https://developers.google.com/doubleclick-advertisers/rest/v5/floodlightConfigurations#ThirdPartyAuthenticationToken`)`` floodlightConfigurations.list of third-party authentication tokens enabled for this configuration. |
| `customViewabilityMetric` | ``object (`https://developers.google.com/doubleclick-advertisers/rest/v5/floodlightConfigurations#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` | `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 (`https://developers.google.com/doubleclick-advertisers/rest/v5/UserDefinedVariableType`), "dataType": enum (`https://developers.google.com/doubleclick-advertisers/rest/v5/floodlightConfigurations#VariableDataType`), "reportName": string } ``` |

| Fields ||
|---|---|
| `variableType` | ``enum (`https://developers.google.com/doubleclick-advertisers/rest/v5/UserDefinedVariableType`)`` Variable name in the tag. This is a required field. |
| `dataType` | ``enum (`https://developers.google.com/doubleclick-advertisers/rest/v5/floodlightConfigurations#VariableDataType`)`` 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: "`"<>`". |

## VariableDataType

Data types for spotlight variables.

| 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 (`https://developers.google.com/doubleclick-advertisers/rest/v5/floodlightConfigurations#CustomViewabilityMetricConfiguration`) } } ``` |

| Fields ||
|---|---|
| `id` | `string (https://developers.google.com/discovery/v1/type-format format)` ID of the custom viewability metric. |
| `name` | `string` Name of the custom viewability metric. |
| `configuration` | ``object (`https://developers.google.com/doubleclick-advertisers/rest/v5/floodlightConfigurations#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 ||
|---|---|
| ### `https://developers.google.com/doubleclick-advertisers/rest/v5/floodlightConfigurations/get` | Gets one floodlight configuration by ID. |
| ### `https://developers.google.com/doubleclick-advertisers/rest/v5/floodlightConfigurations/list` | Retrieves a list of floodlight configurations, possibly filtered. |
| ### `https://developers.google.com/doubleclick-advertisers/rest/v5/floodlightConfigurations/patch` | Updates an existing floodlight configuration. |
| ### `https://developers.google.com/doubleclick-advertisers/rest/v5/floodlightConfigurations/update` | Updates an existing floodlight configuration. |