List

Retrieves a list of creative fields, possibly filtered

8 variables
16 variables

Retrieves a list of creative fields, 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 8 input parameters

  = Parameter name
  = Format

profileId INTEGER Required

User profile ID associated with this request

advertiserIds INTEGER

Select only creative fields that belong to these advertisers

ids INTEGER

Select only creative fields 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 fields by name or ID. Wildcards () are allowed. For example, "creativefield2015" will return creative fields with names like "creativefield June 2015", "creativefield April 2015", or simply "creativefield 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 "creativefield" will match creative fields with the name "my creativefield", "creativefield 2015", or simply "creativefield"

sortField ENUMERATION

Field by which to sort the list

sortOrder ENUMERATION

Order of sorted results

Output

This building block provides 16 output parameters

  = Parameter name
  = Format

creativeFields[] OBJECT

Contains properties of a creative field

creativeFields[].accountId INTEGER

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

creativeFields[].advertiserId INTEGER

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

creativeFields[].advertiserIdDimensionValue OBJECT

Represents a DimensionValue resource

creativeFields[].advertiserIdDimensionValue.dimensionName STRING

The name of the dimension

creativeFields[].advertiserIdDimensionValue.etag STRING

The eTag of this response for caching purposes

creativeFields[].advertiserIdDimensionValue.id STRING

The ID associated with the value if available

creativeFields[].advertiserIdDimensionValue.kind STRING

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

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

creativeFields[].advertiserIdDimensionValue.value STRING

The value of the dimension

creativeFields[].id INTEGER

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

creativeFields[].kind STRING

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

creativeFields[].name STRING

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

creativeFields[].subaccountId INTEGER

Subaccount ID of this creative field. 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#creativeFieldsListResponse"

nextPageToken STRING

Pagination token to be used for the next list operation