Share your feedback about the Display & Video 360 API. Take the 2022 Display & Video 360 API Annual Survey.

REST Resource: floodlightGroups

Resource: FloodlightGroup

A single Floodlight group.

JSON representation
{
  "name": string,
  "floodlightGroupId": string,
  "displayName": string,
  "webTagType": enum (WebTagType),
  "lookbackWindow": {
    object (LookbackWindow)
  },
  "customVariables": {
    object
  },
  "activeViewConfig": {
    object (ActiveViewVideoViewabilityMetricConfig)
  }
}
Fields
name

string

Output only. The resource name of the Floodlight group.

floodlightGroupId

string (int64 format)

Output only. The unique ID of the Floodlight group. Assigned by the system.

displayName

string

Required. The display name of the Floodlight group.

webTagType

enum (WebTagType)

Required. The web tag type enabled for the Floodlight group.

lookbackWindow

object (LookbackWindow)

Required. The lookback window for the Floodlight group. Both clickDays and impressionDays are required. Acceptable values for both are 0 to 90, inclusive.

customVariables

object (Struct format)

User-defined custom variables owned by the Floodlight group. Use custom Floodlight variables to create reporting data that is tailored to your unique business needs. Custom Floodlight variables use the keys U1=, U2=, and so on, and can take any values that you choose to pass to them. You can use them to track virtually any type of data that you collect about your customers, such as the genre of movie that a customer purchases, the country to which the item is shipped, and so on.

Custom Floodlight variables may not be used to pass any data that could be used or recognized as personally identifiable information (PII).

Example: customVariables { fields { "U1": value { numberValue: 123.4 }, "U2": value { stringValue: "MyVariable2" }, "U3": value { stringValue: "MyVariable3" } } }

Acceptable values for keys are "U1" through "U100", inclusive. String values must be less than 64 characters long, and cannot contain the following characters: "<>.

activeViewConfig

object (ActiveViewVideoViewabilityMetricConfig)

The Active View video viewability metric configuration for the Floodlight group.

WebTagType

The possible types of web tags for a Floodlight group.

Enums
WEB_TAG_TYPE_UNSPECIFIED Type value is not specified or is unknown in this version.
WEB_TAG_TYPE_NONE No tag type.
WEB_TAG_TYPE_IMAGE Image tag.
WEB_TAG_TYPE_DYNAMIC Dynamic tag.

LookbackWindow

Specifies how many days into the past to look when determining whether to record a conversion.

JSON representation
{
  "clickDays": integer,
  "impressionDays": integer
}
Fields
clickDays

integer

Lookback window, in days, from the last time a given user clicked on one of your ads.

impressionDays

integer

Lookback window, in days, from the last time a given user viewed one of your ads.

ActiveViewVideoViewabilityMetricConfig

Configuration for custom Active View video viewability metrics.

JSON representation
{
  "displayName": string,
  "minimumViewability": enum (VideoViewabilityPercent),
  "minimumVolume": enum (VideoVolumePercent),
  "minimumDuration": enum (VideoDurationSeconds),
  "minimumQuartile": enum (VideoDurationQuartile)
}
Fields
displayName

string

Required. The display name of the custom metric.

minimumViewability

enum (VideoViewabilityPercent)

Required. The minimum percentage of the video ad's pixels visible on the screen in order for an impression to be recorded.

minimumVolume

enum (VideoVolumePercent)

Required. The minimum percentage of the video ad's volume required in order for an impression to be recorded.

minimumDuration

enum (VideoDurationSeconds)

The minimum visible video duration required (in seconds) in order for an impression to be recorded.

You must specify minimumDuration, minimumQuartile or both. If both are specified, an impression meets the metric criteria if either requirement is met (whichever happens first).

minimumQuartile

enum (VideoDurationQuartile)

The minimum visible video duration required, based on the video quartiles, in order for an impression to be recorded.

You must specify minimumDuration, minimumQuartile or both. If both are specified, an impression meets the metric criteria if either requirement is met (whichever happens first).

VideoViewabilityPercent

Possible percentage values of a video ad's visible pixels.

Enums
VIEWABILITY_PERCENT_UNSPECIFIED Value is not specified or is unknown in this version.
VIEWABILITY_PERCENT_0 0% viewable.
VIEWABILITY_PERCENT_25 25% viewable.
VIEWABILITY_PERCENT_50 50% viewable.
VIEWABILITY_PERCENT_75 75% viewable.
VIEWABILITY_PERCENT_100 100% viewable.

VideoVolumePercent

Possible percentage values of a video ad's playback volume.

Enums
VIDEO_VOLUME_PERCENT_UNSPECIFIED Value is not specified or is unknown in this version.
VIDEO_VOLUME_PERCENT_0 0% volume.
VIDEO_VOLUME_PERCENT_10 10% volume.

VideoDurationSeconds

Possible values in seconds of a video ad's visible duration.

Enums
VIDEO_DURATION_UNSPECIFIED Value is not specified or is unknown in this version.
VIDEO_DURATION_SECONDS_NONE No duration value.
VIDEO_DURATION_SECONDS_0 0 seconds.
VIDEO_DURATION_SECONDS_1 1 second.
VIDEO_DURATION_SECONDS_2 2 seconds.
VIDEO_DURATION_SECONDS_3 3 seconds.
VIDEO_DURATION_SECONDS_4 4 seconds.
VIDEO_DURATION_SECONDS_5 5 seconds.
VIDEO_DURATION_SECONDS_6 6 seconds.
VIDEO_DURATION_SECONDS_7 7 seconds.
VIDEO_DURATION_SECONDS_8 8 seconds.
VIDEO_DURATION_SECONDS_9 9 seconds.
VIDEO_DURATION_SECONDS_10 10 seconds.
VIDEO_DURATION_SECONDS_11 11 seconds.
VIDEO_DURATION_SECONDS_12 12 seconds.
VIDEO_DURATION_SECONDS_13 13 seconds.
VIDEO_DURATION_SECONDS_14 14 seconds.
VIDEO_DURATION_SECONDS_15 15 seconds.
VIDEO_DURATION_SECONDS_30 30 seconds.
VIDEO_DURATION_SECONDS_45 45 seconds.
VIDEO_DURATION_SECONDS_60 60 seconds.

VideoDurationQuartile

Possible quartile values of a video ad's visible duration.

Enums
VIDEO_DURATION_QUARTILE_UNSPECIFIED Value is not specified or is unknown in this version.
VIDEO_DURATION_QUARTILE_NONE No quartile value.
VIDEO_DURATION_QUARTILE_FIRST First quartile.
VIDEO_DURATION_QUARTILE_SECOND Second quartile (midpoint).
VIDEO_DURATION_QUARTILE_THIRD Third quartile.
VIDEO_DURATION_QUARTILE_FOURTH Fourth quartile (completion).

Methods

get

Gets a Floodlight group.

patch

Updates an existing Floodlight group.