FloodlightActivities

For a list of methods for this resource, see the end of this page.

Resource representations

Contains properties of a Floodlight activity.

{
  "kind": "dfareporting#floodlightActivity",
  "id": long,
  "idDimensionValue": dimensionValues Resource,
  "name": string,
  "tagString": string,
  "expectedUrl": string,
  "secure": boolean,
  "hidden": boolean,
  "imageTagEnabled": boolean,
  "countingMethod": string,
  "tagFormat": string,
  "cacheBustingType": string,
  "userDefinedVariableTypes": [
    string
  ],
  "notes": string,
  "defaultTags": [
    {
      "id": long,
      "name": string,
      "tag": string
    }
  ],
  "publisherTags": [
    {
      "dynamicTag": {
        "id": long,
        "name": string,
        "tag": string
      },
      "siteId": long,
      "siteIdDimensionValue": dimensionValues Resource,
      "directorySiteId": long,
      "clickThrough": boolean,
      "viewThrough": boolean
    }
  ],
  "floodlightActivityGroupId": long,
  "floodlightConfigurationId": long,
  "floodlightConfigurationIdDimensionValue": dimensionValues Resource,
  "advertiserId": long,
  "advertiserIdDimensionValue": dimensionValues Resource,
  "subaccountId": long,
  "accountId": long,
  "floodlightActivityGroupType": string,
  "floodlightActivityGroupTagString": string,
  "floodlightActivityGroupName": string,
  "sslCompliant": boolean,
  "sslRequired": boolean
}
Property name Value Description Notes
accountId long Account ID of this floodlight activity. This is a read-only field that can be left blank.
advertiserId long 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.
advertiserIdDimensionValue nested object Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
cacheBustingType string Code type used for cache busting in the generated tag. Applicable only when floodlightActivityGroupType is COUNTER and countingMethod is STANDARD_COUNTING or UNIQUE_COUNTING.

Acceptable values are:
  • "ACTIVE_SERVER_PAGE"
  • "COLD_FUSION"
  • "JAVASCRIPT"
  • "JSP"
  • "PHP"
countingMethod string Counting method for conversions for this floodlight activity. This is a required field.

Acceptable values are:
  • "ITEMS_SOLD_COUNTING":
    Count each conversion, plus the total number of items sold and the total revenue for these sales.
  • "SESSION_COUNTING":
    Count one conversion per user per session. Session length is set by the site where the floodlight tag is deployed.
  • "STANDARD_COUNTING": Count every conversion.
  • "TRANSACTIONS_COUNTING":
    Count all conversions, plus the total number of sales that take place and the total revenue for these transactions.
  • "UNIQUE_COUNTING":
    Count the first conversion for each unique user during each 24-hour day, from midnight to midnight, America/New York time.
defaultTags[] list Dynamic floodlight tags.
defaultTags[].id long ID of this dynamic tag. This is a read-only, auto-generated field.
defaultTags[].name string Name of this tag.
defaultTags[].tag string Tag code.
expectedUrl string URL where this tag will be deployed. If specified, must be less than 256 characters long.
floodlightActivityGroupId long Floodlight activity group ID of this floodlight activity. This is a required field.
floodlightActivityGroupName string Name 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.
floodlightActivityGroupType string Type of the associated floodlight activity group. This is a read-only field.

Acceptable values are:
  • "COUNTER"
  • "SALE"
floodlightConfigurationId long 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.
floodlightConfigurationIdDimensionValue nested object Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
hidden boolean Whether this activity is archived.
id long ID of this floodlight activity. This is a read-only, auto-generated field.
idDimensionValue nested object Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
imageTagEnabled boolean Whether the image tag is enabled for this activity.
kind string Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
name string Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
notes string General notes or implementation instructions for the tag.
publisherTags[] list Publisher dynamic floodlight tags.
publisherTags[].clickThrough boolean Whether this tag is applicable only for click-throughs.
publisherTags[].directorySiteId long 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.
publisherTags[].dynamicTag nested object Dynamic floodlight tag.
publisherTags[].dynamicTag.id long ID of this dynamic tag. This is a read-only, auto-generated field.
publisherTags[].dynamicTag.name string Name of this tag.
publisherTags[].dynamicTag.tag string Tag code.
publisherTags[].siteId long Site ID of this dynamic tag.
publisherTags[].siteIdDimensionValue nested object Dimension value for the ID of the site. This is a read-only, auto-generated field.
publisherTags[].viewThrough boolean Whether this tag is applicable only for view-throughs.
secure boolean Whether this tag should use SSL.
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.
sslRequired boolean Whether this floodlight activity must be SSL-compliant.
subaccountId long Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
tagFormat string Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.

Acceptable values are:
  • "HTML"
  • "XHTML"
tagString string Value of the cat= paramter 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.
userDefinedVariableTypes[] list 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.

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. This method supports paging.
patch
Updates an existing floodlight activity. This method supports patch semantics.
update
Updates an existing floodlight activity.

Send feedback about...

DoubleClick Campaign Manager
DoubleClick Campaign Manager