List

Retrieves a list of targeting templates, optionally filtered

8 variables
40 variables

Retrieves a list of targeting templates, optionally 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

advertiserId INTEGER

Select only targeting templates with this advertiser ID

ids INTEGER

Select only targeting templates 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 objects by name or ID. Wildcards () are allowed. For example, "template2015" will return objects with names like "template June 2015", "template April 2015", or simply "template 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 "template" will match objects with name "my template", "template 2015", or simply "template"

sortField ENUMERATION

Field by which to sort the list

sortOrder ENUMERATION

Order of sorted results

Output

This building block provides 40 output parameters

  = Parameter name
  = Format

kind STRING

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

nextPageToken STRING

Pagination token to be used for the next list operation

targetingTemplates[] OBJECT

Contains properties of a targeting template. A targeting template encapsulates targeting information which can be reused across multiple ads

targetingTemplates[].accountId INTEGER

Account ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert

targetingTemplates[].advertiserId INTEGER

Advertiser ID of this targeting template. This is a required field on insert and is read-only after insert

targetingTemplates[].advertiserIdDimensionValue OBJECT

Represents a DimensionValue resource

targetingTemplates[].advertiserIdDimensionValue.dimensionName STRING

The name of the dimension

targetingTemplates[].advertiserIdDimensionValue.etag STRING

The eTag of this response for caching purposes

targetingTemplates[].advertiserIdDimensionValue.id STRING

The ID associated with the value if available

targetingTemplates[].advertiserIdDimensionValue.kind STRING

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

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

targetingTemplates[].advertiserIdDimensionValue.value STRING

The value of the dimension

targetingTemplates[].dayPartTargeting OBJECT

Day Part Targeting

targetingTemplates[].dayPartTargeting.daysOfWeek[] ENUMERATION

targetingTemplates[].dayPartTargeting.hoursOfDay[] INTEGER

targetingTemplates[].dayPartTargeting.userLocalTime BOOLEAN

Whether or not to use the user's local time. If false, the America/New York time zone applies

targetingTemplates[].geoTargeting OBJECT

Geographical Targeting

targetingTemplates[].geoTargeting.cities[] OBJECT

Contains information about a city that can be targeted by ads

targetingTemplates[].geoTargeting.countries[] OBJECT

Contains information about a country that can be targeted by ads

targetingTemplates[].geoTargeting.excludeCountries BOOLEAN

Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad

targetingTemplates[].geoTargeting.metros[] OBJECT

Contains information about a metro region that can be targeted by ads

targetingTemplates[].geoTargeting.postalCodes[] OBJECT

Contains information about a postal code that can be targeted by ads

targetingTemplates[].geoTargeting.regions[] OBJECT

Contains information about a region that can be targeted by ads

targetingTemplates[].id INTEGER

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

targetingTemplates[].keyValueTargetingExpression OBJECT

Key Value Targeting Expression

targetingTemplates[].keyValueTargetingExpression.expression STRING

Keyword expression being targeted by the ad

targetingTemplates[].kind STRING

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

targetingTemplates[].languageTargeting OBJECT

Language Targeting

targetingTemplates[].languageTargeting.languages[] OBJECT

Contains information about a language that can be targeted by ads

targetingTemplates[].listTargetingExpression OBJECT

Remarketing List Targeting Expression

targetingTemplates[].listTargetingExpression.expression STRING

Expression describing which lists are being targeted by the ad

targetingTemplates[].name STRING

Name of this targeting template. This field is required. It must be less than 256 characters long and unique within an advertiser

targetingTemplates[].subaccountId INTEGER

Subaccount ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert

targetingTemplates[].technologyTargeting OBJECT

Technology Targeting

targetingTemplates[].technologyTargeting.browsers[] OBJECT

Contains information about a browser that can be targeted by ads

targetingTemplates[].technologyTargeting.connectionTypes[] OBJECT

Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users

targetingTemplates[].technologyTargeting.mobileCarriers[] OBJECT

Contains information about a mobile carrier that can be targeted by ads

targetingTemplates[].technologyTargeting.operatingSystemVersions[] OBJECT

Contains information about a particular version of an operating system that can be targeted by ads

targetingTemplates[].technologyTargeting.operatingSystems[] OBJECT

Contains information about an operating system that can be targeted by ads

targetingTemplates[].technologyTargeting.platformTypes[] OBJECT

Contains information about a platform type that can be targeted by ads