REST Resource: floodlightGroups.floodlightActivities

  • Display & Video 360 API v3 has been sunset and users should transition to v4.

  • The FloodlightActivity resource represents a single Floodlight activity with various associated configurations and statuses.

  • Key information about a Floodlight activity includes its name, IDs, display name, serving status, associated advertisers, and remarketing settings.

  • Floodlight activity serving status can be unspecified, enabled, or disabled.

  • Remarketing configuration details whether remarketing is enabled for a specific advertiser using the Floodlight activity.

  • Methods are available to get and list Floodlight activities.

Resource: FloodlightActivity

A single Floodlight activity.

JSON representation 
{
  "name": string,
  "floodlightGroupId": string,
  "floodlightActivityId": string,
  "displayName": string,
  "servingStatus": enum (FloodlightActivityServingStatus),
  "advertiserIds": [
    string
  ],
  "remarketingConfigs": [
    {
      object (RemarketingConfig)
    }
  ],
  "sslRequired": boolean
}
Fields
name

string

Output only. The resource name of the Floodlight activity.
floodlightGroupId

string (int64 format)

Required. Immutable. The ID of the parent Floodlight group.
floodlightActivityId

string (int64 format)

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

string

Required. The display name of the Floodlight activity.
servingStatus

enum (FloodlightActivityServingStatus)

Optional. Whether the Floodlight activity is served.
advertiserIds[]

string (int64 format)

Output only. IDs of the advertisers that have access to the parent Floodlight group.

Only advertisers under the provided partner ID will be listed in this field.
remarketingConfigs[]

object (RemarketingConfig)

Output only. A list of configuration objects designating whether remarketing for this Floodlight Activity is enabled and available for a specifc advertiser.

If enabled, this Floodlight Activity generates a remarketing user list that is able to be used in targeting under the advertiser.
sslRequired

boolean

Output only. Whether tags are required to be compliant.

FloodlightActivityServingStatus

Possible serving statuses of a Floodlight activity.

Enums
FLOODLIGHT_ACTIVITY_SERVING_STATUS_UNSPECIFIED Type value is not specified or is unknown in this version.
FLOODLIGHT_ACTIVITY_SERVING_STATUS_ENABLED Enabled.
FLOODLIGHT_ACTIVITY_SERVING_STATUS_DISABLED Disabled.

RemarketingConfig

Settings that control the whether remarketing is enabled for the given identified advertiser.

JSON representation 
{
  "advertiserId": string,
  "remarketingEnabled": boolean
}
Fields
advertiserId

string (int64 format)

Output only. The ID of the advertiser.
remarketingEnabled

boolean

Output only. Whether the Floodlight activity remarketing user list is available to the identified advertiser.

Methods

get

 Gets a Floodlight activity.

list

 Lists Floodlight activities in a Floodlight group.