List

Retrieves a list of creative groups, possibly filtered

9 variables
17 variables

Retrieves a list of creative 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 9 input parameters

  = Parameter name
  = Format

profileId INTEGER Required

User profile ID associated with this request

advertiserIds INTEGER

Select only creative groups that belong to these advertisers

groupNumber INTEGER

Select only creative groups that belong to this subgroup

ids INTEGER

Select only creative groups with these IDs

maxResults INTEGER

Maximum number of results to return

pageToken STRING

Value of the nextPageToken from the previous result page

searchString STRING

Allows searching for creative groups by name or ID. Wildcards () are allowed. For example, "creativegroup2015" will return creative groups with names like "creativegroup June 2015", "creativegroup April 2015", or simply "creativegroup 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativegroup" will match creative groups with the name "my creativegroup", "creativegroup 2015", or simply "creativegroup"

sortField ENUMERATION

Field by which to sort the list

sortOrder ENUMERATION

Order of sorted results

Output

This building block provides 17 output parameters

  = Parameter name
  = Format

creativeGroups[] OBJECT

Contains properties of a creative group

creativeGroups[].accountId INTEGER

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

creativeGroups[].advertiserId INTEGER

Advertiser ID of this creative group. This is a required field on insertion

creativeGroups[].advertiserIdDimensionValue OBJECT

Represents a DimensionValue resource

creativeGroups[].advertiserIdDimensionValue.dimensionName STRING

The name of the dimension

creativeGroups[].advertiserIdDimensionValue.etag STRING

The eTag of this response for caching purposes

creativeGroups[].advertiserIdDimensionValue.id STRING

The ID associated with the value if available

creativeGroups[].advertiserIdDimensionValue.kind STRING

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

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

creativeGroups[].advertiserIdDimensionValue.value STRING

The value of the dimension

creativeGroups[].groupNumber INTEGER

Subgroup of the creative group. Assign your creative groups to a subgroup in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion. Acceptable values are 1 to 2, inclusive

creativeGroups[].id INTEGER

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

creativeGroups[].kind STRING

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

creativeGroups[].name STRING

Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser

creativeGroups[].subaccountId INTEGER

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

kind STRING

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

nextPageToken STRING

Pagination token to be used for the next list operation