REST Resource: floodlightActivities

Resource: FloodlightActivity

Contains properties of a Floodlight activity.

JSON representation 
{
  "id": string,
  "name": string,
  "tagString": string,
  "expectedUrl": string,
  "secure": boolean,
  "kind": string,
  "countingMethod": enum (CountingMethod),
  "tagFormat": enum (TagFormat),
  "cacheBustingType": enum (CacheBustingCodeType),
  "userDefinedVariableTypes": [
    enum (UserDefinedVariableType)
  ],
  "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 (TagFormat),
  "status": enum (Status),
  "attributionEnabled": boolean,
  "conversionCategory": enum (ConversionCategory)
}
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.
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 (CacheBustingCodeType)

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 (UserDefinedVariableType)

floodlightActivities.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 (TagFormat)

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

enum (Status)

The status of the activity. This can only be set to

ACTIVE

or

ARCHIVED_AND_DISABLED

. The

ARCHIVED

status is no longer supported and cannot be set for Floodlight activities. The

DISABLED_POLICY

status indicates that a Floodlight activity is violating Google policy. Contact your account manager for more information.
attributionEnabled

boolean

Whether the activity is enabled for attribution.
conversionCategory

enum (ConversionCategory)

Required. The conversion category of the activity.

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.

TagFormat

Enums
IFRAME
IMAGE
GLOBAL_SITE_TAG

Status

Enums
ACTIVE
ARCHIVED_AND_DISABLED
ARCHIVED
DISABLED_POLICY

ConversionCategory

Enum listing all conversion categories for a floodlight activity.

Enums
CONVERSION_CATEGORY_DEFAULT Unspecified category (called "Other" externally).
CONVERSION_CATEGORY_PURCHASE Purchase, sales, or "order placed" event.
CONVERSION_CATEGORY_SIGNUP Signup user action.
CONVERSION_CATEGORY_PAGE_VIEW User visiting a page.
CONVERSION_CATEGORY_DOWNLOAD Software download action (as for an app). A conversion type that is created as a download type may not have its category changed.
CONVERSION_CATEGORY_BOOM_EVENT Boom event (for user list creation). This is an internal-only category.
CONVERSION_CATEGORY_ADD_TO_CART . The addition of items to a shopping cart or bag on an advertiser site.
CONVERSION_CATEGORY_BEGIN_CHECKOUT When someone enters the checkout flow on an advertiser site.
CONVERSION_CATEGORY_SUBSCRIBE_PAID The start of a paid subscription for a product or service.
CONVERSION_CATEGORY_SUBSCRIBE_FREE The start of a free subscription for a product or service.
CONVERSION_CATEGORY_PHONE_CALL_LEAD A call to indicate interesting in an advertiser's offering. Note: this is different from support calls.
CONVERSION_CATEGORY_IMPORTED_LEAD A lead conversion imported from an external source into Google Ads.
CONVERSION_CATEGORY_SUBMIT_LEAD_FORM A submission of a form on an advertiser site indicating business interest.
CONVERSION_CATEGORY_BOOK_APPOINTMENT A booking of an appointment with an advertiser's business.
CONVERSION_CATEGORY_REQUEST_QUOTE A quote or price estimate request.
CONVERSION_CATEGORY_GET_DIRECTIONS A search for an advertiser's business location.
CONVERSION_CATEGORY_OUTBOUND_CLICK A click to an advertiser's partner site, e.g. a referral.
CONVERSION_CATEGORY_CONTACT A call, SMS, email, chat or other type of contact to an advertiser.
CONVERSION_CATEGORY_VIEW_KEY_PAGE Key page views (ex: product page, article).
CONVERSION_CATEGORY_ENGAGEMENT A website engagement event
CONVERSION_CATEGORY_STORE_VISIT A visit to a physical store location.
CONVERSION_CATEGORY_STORE_SALE A sale occurring in a physical store.
CONVERSION_CATEGORY_QUALIFIED_LEAD A lead conversion imported from an external source into Google Ads, that has been further qualified by the advertiser.
CONVERSION_CATEGORY_CONVERTED_LEAD A lead conversion imported from an external source into Google Ads, that has further completed a desired stage as defined by the lead gen advertiser.
CONVERSION_CATEGORY_IN_APP_AD_REVENUE Conversion event that provides the revenue value of impressions that were shown in-app to users.
CONVERSION_CATEGORY_MESSAGE_LEAD Message exchanges which indicate an interest in an advertiser's offering.

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.