The Campaign Manager 360 API v3.4 is deprecated and will be sunset on Dec 24th, 2021. All users must migrate to a newer API version by that date.

REST Resource: floodlightActivities

Resource: FloodlightActivity

Contains properties of a Floodlight activity.

JSON representation
{
  "id": string,
  "name": string,
  "tagString": string,
  "expectedUrl": string,
  "secure": boolean,
  "hidden": boolean,
  "kind": string,
  "countingMethod": enum (CountingMethod),
  "tagFormat": enum (TagFormat),
  "cacheBustingType": enum (CacheBustingType),
  "userDefinedVariableTypes": [
    enum (UserDefinedVariableTypes)
  ],
  "notes": string,
  "defaultTags": [
    {
      object (FloodlightActivityDynamicTag)
    }
  ],
  "publisherTags": [
    {
      object (FloodlightActivityPublisherDynamicTag)
    }
  ],
  "floodlightActivityGroupId": string,
  "floodlightConfigurationId": string,
  "advertiserId": string,
  "subaccountId": string,
  "accountId": string,
  "floodlightActivityGroupType": enum (FloodlightActivityGroupType),
  "floodlightActivityGroupTagString": string,
  "floodlightActivityGroupName": string,
  "sslCompliant": boolean,
  "advertiserIdDimensionValue": {
    object (DimensionValue)
  },
  "floodlightConfigurationIdDimensionValue": {
    object (DimensionValue)
  },
  "idDimensionValue": {
    object (DimensionValue)
  },
  "sslRequired": boolean,
  "floodlightTagType": enum (FloodlightTagType)
}
Fields
id

string (int64 format)

ID of this floodlight activity. This is a read-only, auto-generated field.

name

string

Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.

tagString

string

Value of the

cat=

parameter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being

[a-z][A-Z][0-9][-][ _ ]

. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.

expectedUrl

string

URL where this tag will be deployed. If specified, must be less than 256 characters long.

secure

boolean

Whether this tag should use SSL.

hidden

boolean

Whether this activity is archived.

kind

string

Identifies what kind of resource this is. Value: the fixed string

"dfareporting#floodlightActivity"

.

countingMethod

enum (CountingMethod)

Counting method for conversions for this floodlight activity. This is a required field.

tagFormat

enum (TagFormat)

Tag format type for the floodlight activity. If left blank, the tag format will default to

HTML

.

cacheBustingType

enum (CacheBustingType)

Code type used for cache busting in the generated tag. Applicable only when

floodlightActivityGroupType

is

COUNTER

and

countingMethod

is

STANDARD_COUNTING

or

UNIQUE_COUNTING

.

userDefinedVariableTypes[]

enum (UserDefinedVariableTypes)

accountPermissionGroups.list of the user-defined variables used by this conversion tag. These map to the "

u[1-100]=

" in the tags. Each of these can have a user defined type.

Acceptable values are

U1

to

U100

, inclusive.

notes

string

General notes or implementation instructions for the tag.

defaultTags[]

object (FloodlightActivityDynamicTag)

Dynamic floodlight tags.

publisherTags[]

object (FloodlightActivityPublisherDynamicTag)

Publisher dynamic floodlight tags.

floodlightActivityGroupId

string (int64 format)

Floodlight activity group ID of this floodlight activity. This is a required field.

floodlightConfigurationId

string (int64 format)

Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.

advertiserId

string (int64 format)

Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.

subaccountId

string (int64 format)

Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.

accountId

string (int64 format)

Account ID of this floodlight activity. This is a read-only field that can be left blank.

floodlightActivityGroupType

enum (FloodlightActivityGroupType)

Type of the associated floodlight activity group. This is a read-only field.

floodlightActivityGroupTagString

string

Tag string of the associated floodlight activity group. This is a read-only field.

floodlightActivityGroupName

string

Name of the associated floodlight activity group. This is a read-only field.

sslCompliant

boolean

Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.

advertiserIdDimensionValue

object (DimensionValue)

Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.

floodlightConfigurationIdDimensionValue

object (DimensionValue)

Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.

idDimensionValue

object (DimensionValue)

Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.

sslRequired

boolean

Whether this floodlight activity must be SSL-compliant.

floodlightTagType

enum (FloodlightTagType)

The type of Floodlight tag this activity will generate. This is a required field.

CountingMethod

Enums
STANDARD_COUNTING
UNIQUE_COUNTING
SESSION_COUNTING
TRANSACTIONS_COUNTING
ITEMS_SOLD_COUNTING

TagFormat

Enums
HTML
XHTML

CacheBustingType

Enums
JAVASCRIPT
ACTIVE_SERVER_PAGE
JSP
PHP
COLD_FUSION

UserDefinedVariableTypes

Enums
U1
U2
U3
U4
U5
U6
U7
U8
U9
U10
U11
U12
U13
U14
U15
U16
U17
U18
U19
U20
U21
U22
U23
U24
U25
U26
U27
U28
U29
U30
U31
U32
U33
U34
U35
U36
U37
U38
U39
U40
U41
U42
U43
U44
U45
U46
U47
U48
U49
U50
U51
U52
U53
U54
U55
U56
U57
U58
U59
U60
U61
U62
U63
U64
U65
U66
U67
U68
U69
U70
U71
U72
U73
U74
U75
U76
U77
U78
U79
U80
U81
U82
U83
U84
U85
U86
U87
U88
U89
U90
U91
U92
U93
U94
U95
U96
U97
U98
U99
U100

FloodlightActivityDynamicTag

Dynamic Tag

JSON representation
{
  "id": string,
  "name": string,
  "tag": string
}
Fields
id

string (int64 format)

ID of this dynamic tag. This is a read-only, auto-generated field.

name

string

Name of this tag.

tag

string

Tag code.

FloodlightActivityPublisherDynamicTag

Publisher Dynamic Tag

JSON representation
{
  "dynamicTag": {
    object (FloodlightActivityDynamicTag)
  },
  "siteId": string,
  "directorySiteId": string,
  "clickThrough": boolean,
  "viewThrough": boolean,
  "siteIdDimensionValue": {
    object (DimensionValue)
  }
}
Fields
dynamicTag

object (FloodlightActivityDynamicTag)

Dynamic floodlight tag.

siteId

string (int64 format)

Site ID of this dynamic tag.

directorySiteId

string (int64 format)

Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the

siteId

field. When this resource is retrieved, only the

siteId

field will be populated.

clickThrough

boolean

Whether this tag is applicable only for click-throughs.

viewThrough

boolean

Whether this tag is applicable only for view-throughs.

siteIdDimensionValue

object (DimensionValue)

Dimension value for the ID of the site. This is a read-only, auto-generated field.

FloodlightActivityGroupType

Enums
COUNTER
SALE

FloodlightTagType

Enums
IFRAME
IMAGE
GLOBAL_SITE_TAG

Methods

delete

Deletes an existing floodlight activity.

generatetag

Generates a tag for a floodlight activity.

get

Gets one floodlight activity by ID.

insert

Inserts a new floodlight activity.

list

Retrieves a list of floodlight activities, possibly filtered.

patch

Updates an existing floodlight activity.

update

Updates an existing floodlight activity.