List

Retrieves a list of floodlight activities, possibly filtered

14 variables
58 variables

Retrieves a list of floodlight activities, possibly filtered. This method supports paging

Authorization

To use this building block you will have to grant access to at least one of the following scopes:

  • View and manage your DoubleClick Campaign Manager's (DCM) display ad campaigns

Input

This building block consumes 14 input parameters

  = Parameter name
  = Format

profileId INTEGER Required

User profile ID associated with this request

advertiserId INTEGER

Select only floodlight activities for the specified advertiser ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result

floodlightActivityGroupIds INTEGER

Select only floodlight activities with the specified floodlight activity group IDs

floodlightActivityGroupName STRING

Select only floodlight activities with the specified floodlight activity group name

floodlightActivityGroupTagString STRING

Select only floodlight activities with the specified floodlight activity group tag string

floodlightActivityGroupType ENUMERATION

Select only floodlight activities with the specified floodlight activity group type

floodlightConfigurationId INTEGER

Select only floodlight activities for the specified floodlight configuration ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result

ids INTEGER

Select only floodlight activities with the specified IDs. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result

maxResults INTEGER

Maximum number of results to return

pageToken STRING

Value of the nextPageToken from the previous result page

searchString STRING

Allows searching for objects by name or ID. Wildcards () are allowed. For example, "floodlightactivity2015" will return objects with names like "floodlightactivity June 2015", "floodlightactivity April 2015", or simply "floodlightactivity 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "floodlightactivity" will match objects with name "my floodlightactivity activity", "floodlightactivity 2015", or simply "floodlightactivity"

sortField ENUMERATION

Field by which to sort the list

sortOrder ENUMERATION

Order of sorted results

tagString STRING

Select only floodlight activities with the specified tag string

Output

This building block provides 58 output parameters

  = Parameter name
  = Format

floodlightActivities[] OBJECT

Contains properties of a Floodlight activity

floodlightActivities[].accountId INTEGER

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

floodlightActivities[].advertiserId INTEGER

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

floodlightActivities[].advertiserIdDimensionValue OBJECT

Represents a DimensionValue resource

floodlightActivities[].advertiserIdDimensionValue.dimensionName STRING

The name of the dimension

floodlightActivities[].advertiserIdDimensionValue.etag STRING

The eTag of this response for caching purposes

floodlightActivities[].advertiserIdDimensionValue.id STRING

The ID associated with the value if available

floodlightActivities[].advertiserIdDimensionValue.kind STRING

The kind of resource this is, in this case dfareporting#dimensionValue

floodlightActivities[].advertiserIdDimensionValue.matchType ENUMERATION

Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT

floodlightActivities[].advertiserIdDimensionValue.value STRING

The value of the dimension

floodlightActivities[].cacheBustingType ENUMERATION

Code type used for cache busting in the generated tag. Applicable only when floodlightActivityGroupType is COUNTER and countingMethod is STANDARD_COUNTING or UNIQUE_COUNTING

floodlightActivities[].countingMethod ENUMERATION

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

floodlightActivities[].defaultTags[] OBJECT

Dynamic Tag

floodlightActivities[].defaultTags[].id INTEGER

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

floodlightActivities[].defaultTags[].name STRING

Name of this tag

floodlightActivities[].defaultTags[].tag STRING

Tag code

floodlightActivities[].expectedUrl STRING

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

floodlightActivities[].floodlightActivityGroupId INTEGER

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

floodlightActivities[].floodlightActivityGroupName STRING

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

floodlightActivities[].floodlightActivityGroupTagString STRING

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

floodlightActivities[].floodlightActivityGroupType ENUMERATION

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

floodlightActivities[].floodlightConfigurationId INTEGER

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

floodlightActivities[].floodlightConfigurationIdDimensionValue OBJECT

Represents a DimensionValue resource

floodlightActivities[].floodlightConfigurationIdDimensionValue.dimensionName STRING

The name of the dimension

floodlightActivities[].floodlightConfigurationIdDimensionValue.etag STRING

The eTag of this response for caching purposes

floodlightActivities[].floodlightConfigurationIdDimensionValue.id STRING

The ID associated with the value if available

floodlightActivities[].floodlightConfigurationIdDimensionValue.kind STRING

The kind of resource this is, in this case dfareporting#dimensionValue

floodlightActivities[].floodlightConfigurationIdDimensionValue.matchType ENUMERATION

Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT

floodlightActivities[].floodlightConfigurationIdDimensionValue.value STRING

The value of the dimension

floodlightActivities[].floodlightTagType ENUMERATION

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

floodlightActivities[].hidden BOOLEAN

Whether this activity is archived

floodlightActivities[].id INTEGER

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

floodlightActivities[].idDimensionValue OBJECT

Represents a DimensionValue resource

floodlightActivities[].idDimensionValue.dimensionName STRING

The name of the dimension

floodlightActivities[].idDimensionValue.etag STRING

The eTag of this response for caching purposes

floodlightActivities[].idDimensionValue.id STRING

The ID associated with the value if available

floodlightActivities[].idDimensionValue.kind STRING

The kind of resource this is, in this case dfareporting#dimensionValue

floodlightActivities[].idDimensionValue.matchType ENUMERATION

Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT

floodlightActivities[].idDimensionValue.value STRING

The value of the dimension

floodlightActivities[].kind STRING

Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity"

floodlightActivities[].name STRING

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

floodlightActivities[].notes STRING

General notes or implementation instructions for the tag

floodlightActivities[].publisherTags[] OBJECT

Publisher Dynamic Tag

floodlightActivities[].publisherTags[].clickThrough BOOLEAN

Whether this tag is applicable only for click-throughs

floodlightActivities[].publisherTags[].directorySiteId INTEGER

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

floodlightActivities[].publisherTags[].dynamicTag OBJECT

Dynamic Tag

floodlightActivities[].publisherTags[].siteId INTEGER

Site ID of this dynamic tag

floodlightActivities[].publisherTags[].siteIdDimensionValue OBJECT

Represents a DimensionValue resource

floodlightActivities[].publisherTags[].viewThrough BOOLEAN

Whether this tag is applicable only for view-throughs

floodlightActivities[].secure BOOLEAN

Whether this tag should use SSL

floodlightActivities[].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

floodlightActivities[].sslRequired BOOLEAN

Whether this floodlight activity must be SSL-compliant

floodlightActivities[].subaccountId INTEGER

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

floodlightActivities[].tagFormat ENUMERATION

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

floodlightActivities[].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

floodlightActivities[].userDefinedVariableTypes[] ENUMERATION

kind STRING

Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivitiesListResponse"

nextPageToken STRING

Pagination token to be used for the next list operation