List

Retrieves a list of floodlight activity groups, possibly filtered

10 variables
33 variables

Retrieves a list of floodlight activity groups, 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 10 input parameters

  = Parameter name
  = Format

profileId INTEGER Required

User profile ID associated with this request

advertiserId INTEGER

Select only floodlight activity groups with the specified advertiser ID. Must specify either advertiserId or floodlightConfigurationId for a non-empty result

floodlightConfigurationId INTEGER

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

ids INTEGER

Select only floodlight activity groups with the specified IDs. Must specify either 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, "floodlightactivitygroup2015" will return objects with names like "floodlightactivitygroup June 2015", "floodlightactivitygroup April 2015", or simply "floodlightactivitygroup 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 "floodlightactivitygroup" will match objects with name "my floodlightactivitygroup activity", "floodlightactivitygroup 2015", or simply "floodlightactivitygroup"

sortField ENUMERATION

Field by which to sort the list

sortOrder ENUMERATION

Order of sorted results

type ENUMERATION

Select only floodlight activity groups with the specified floodlight activity group type

Output

This building block provides 33 output parameters

  = Parameter name
  = Format

floodlightActivityGroups[] OBJECT

Contains properties of a Floodlight activity group

floodlightActivityGroups[].accountId INTEGER

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

floodlightActivityGroups[].advertiserId INTEGER

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

floodlightActivityGroups[].advertiserIdDimensionValue OBJECT

Represents a DimensionValue resource

floodlightActivityGroups[].advertiserIdDimensionValue.dimensionName STRING

The name of the dimension

floodlightActivityGroups[].advertiserIdDimensionValue.etag STRING

The eTag of this response for caching purposes

floodlightActivityGroups[].advertiserIdDimensionValue.id STRING

The ID associated with the value if available

floodlightActivityGroups[].advertiserIdDimensionValue.kind STRING

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

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

floodlightActivityGroups[].advertiserIdDimensionValue.value STRING

The value of the dimension

floodlightActivityGroups[].floodlightConfigurationId INTEGER

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

floodlightActivityGroups[].floodlightConfigurationIdDimensionValue OBJECT

Represents a DimensionValue resource

floodlightActivityGroups[].floodlightConfigurationIdDimensionValue.dimensionName STRING

The name of the dimension

floodlightActivityGroups[].floodlightConfigurationIdDimensionValue.etag STRING

The eTag of this response for caching purposes

floodlightActivityGroups[].floodlightConfigurationIdDimensionValue.id STRING

The ID associated with the value if available

floodlightActivityGroups[].floodlightConfigurationIdDimensionValue.kind STRING

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

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

floodlightActivityGroups[].floodlightConfigurationIdDimensionValue.value STRING

The value of the dimension

floodlightActivityGroups[].id INTEGER

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

floodlightActivityGroups[].idDimensionValue OBJECT

Represents a DimensionValue resource

floodlightActivityGroups[].idDimensionValue.dimensionName STRING

The name of the dimension

floodlightActivityGroups[].idDimensionValue.etag STRING

The eTag of this response for caching purposes

floodlightActivityGroups[].idDimensionValue.id STRING

The ID associated with the value if available

floodlightActivityGroups[].idDimensionValue.kind STRING

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

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

floodlightActivityGroups[].idDimensionValue.value STRING

The value of the dimension

floodlightActivityGroups[].kind STRING

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

floodlightActivityGroups[].name STRING

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

floodlightActivityGroups[].subaccountId INTEGER

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

floodlightActivityGroups[].tagString STRING

Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. 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 activity groups of the same floodlight configuration. This field is read-only after insertion

floodlightActivityGroups[].type ENUMERATION

Type of the floodlight activity group. This is a required field that is read-only after insertion

kind STRING

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

nextPageToken STRING

Pagination token to be used for the next list operation