Method: targetingTemplates.list
Stay organized with collections
Save and categorize content based on your preferences.
Retrieves a list of targeting templates, optionally filtered. This method supports paging.
HTTP request
GET https://dfareporting.googleapis.com/dfareporting/v4/userprofiles/{profileId}/targetingTemplates
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters |
profileId |
string (int64 format)
User profile ID associated with this request.
|
Query parameters
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,
"template*2015"
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.
|
Request body
The request body must be empty.
Response body
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 |
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.
|
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/dfatrafficking
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-16 UTC.
[null,null,["Last updated 2024-10-16 UTC."],[[["\u003cp\u003eRetrieves a list of targeting templates, with optional filtering and paging capabilities.\u003c/p\u003e\n"],["\u003cp\u003eAllows searching for templates by ID, name, or advertiser ID using specific parameters.\u003c/p\u003e\n"],["\u003cp\u003eSupports customizing the results through sorting and limiting the maximum number of returned templates.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003edfatrafficking\u003c/code\u003e scope for access.\u003c/p\u003e\n"],["\u003cp\u003eReturns a response containing a list of targeting templates and a pagination token for accessing subsequent pages.\u003c/p\u003e\n"]]],[],null,["# Method: targetingTemplates.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.TargetingTemplatesListResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nRetrieves a list of targeting templates, optionally filtered. This method supports [paging](/doubleclick-advertisers/trafficking_tasks#list).\n\n### HTTP request\n\n`GET https://dfareporting.googleapis.com/dfareporting/v4/userprofiles/{profileId}/targetingTemplates`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|---------------|-----------------------------------------------------------------------------------------------------------------------------------|\n| `profile``Id` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` User profile ID associated with this request. |\n\n### Query parameters\n\n| Parameters ||\n|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `ids[]` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Select only targeting templates with these IDs. |\n| `search``String` | `string` Allows searching for objects by name or ID. Wildcards ( `*` ) are allowed. For example, `\"template*2015\"` 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\"` . |\n| `advertiser``Id` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Select only targeting templates with this advertiser ID. |\n| `max``Results` | `integer` Maximum number of results to return. |\n| `page``Token` | `string` Value of the `nextPageToken` from the previous result page. |\n| `sort``Field` | `enum (`[SortField](/doubleclick-advertisers/rest/v4/SortField)`)` Field by which to sort the list. |\n| `sort``Order` | `enum (`[SortOrder](/doubleclick-advertisers/rest/v4/SortOrder)`)` Order of sorted results. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nTargeting Template targetingTemplates.list Response\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"kind\": string, \"nextPageToken\": string, \"targetingTemplates\": [ { object (/doubleclick-advertisers/rest/v4/targetingTemplates#TargetingTemplate) } ] } ``` |\n\n| Fields ||\n|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Identifies what kind of resource this is. Value: the fixed string `\"dfareporting#targetingTemplatesListResponse\"` . |\n| `next``Page``Token` | `string` Pagination token to be used for the next list operation. |\n| `targeting``Templates[]` | `object (`[TargetingTemplate](/doubleclick-advertisers/rest/v4/targetingTemplates#TargetingTemplate)`)` Targeting template collection. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/dfatrafficking`"]]