Method: targetingTemplates.list

AI-generated Key Takeaways

This page describes how to retrieve a list of targeting templates, optionally filtered, supporting paging.
The HTTP request uses a GET method with a specific URL structure including a profileId path parameter.
Optional query parameters are available to filter and control the results, such as ids , searchString , advertiserId , maxResults , pageToken , sortField , and sortOrder .
The request body for this method must be empty.
The response body contains a list of targeting templates, including kind , nextPageToken , and targetingTemplates .
This operation requires authorization using the https://www.googleapis.com/auth/dfatrafficking OAuth scope.

Retrieves a list of targeting templates, optionally filtered. This method supports paging .

GET https://dfareporting.googleapis.com/dfareporting/v4/userprofiles/{profileId}/targetingTemplates

The URL uses gRPC Transcoding syntax.

Parameters

Parameters
`profileId`	`string ( int64 format)` User profile ID associated with this request.

profileId

string ( int64 format)

User profile ID associated with this request.

Parameters
`ids[]`	`string ( int64 format)` Select only targeting templates with these IDs.
`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"` .
`advertiserId`	`string ( int64 format)` Select only targeting templates with this advertiser ID.
`maxResults`	`integer` Maximum number of results to return.
`pageToken`	`string` Value of the `nextPageToken` from the previous result page.
`sortField`	`enum ( SortField )` Field by which to sort the list.
`sortOrder`	`enum ( SortOrder )` Order of sorted results.

The request body must be empty.

Targeting Template targetingTemplates.list Response

If successful, the response body contains data with the following structure:

JSON representation
{ "kind" : string , "nextPageToken" : string , "targetingTemplates" : [ { object ( `TargetingTemplate` ) } ] }

Fields

Fields
`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 ( TargetingTemplate )` Targeting template collection.

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

Targeting template collection.

Requires the following OAuth scope: