Method: dynamicTargetingKeys.list
Stay organized with collections
Save and categorize content based on your preferences.
Retrieves a list of dynamic targeting keys.
HTTP request
GET https://dfareporting.googleapis.com/dfareporting/v4/userprofiles/{profileId}/dynamicTargetingKeys
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters |
profileId |
string (int64 format)
User profile ID associated with this request.
|
Query parameters
Parameters |
names[] |
string
Select only dynamic targeting keys exactly matching these names.
|
objectType |
enum (ObjectType )
Select only dynamic targeting keys with this object type.
|
objectId |
string (int64 format)
Select only dynamic targeting keys with this object ID.
|
advertiserId |
string (int64 format)
Select only dynamic targeting keys whose object has this advertiser ID.
|
Request body
The request body must be empty.
Response body
Dynamic Targeting Key dynamicTargetingKeys.list Response
If successful, the response body contains data with the following structure:
JSON representation |
{
"kind": string,
"dynamicTargetingKeys": [
{
object (DynamicTargetingKey )
}
]
} |
Fields |
kind |
string
Identifies what kind of resource this is. Value: the fixed string
"dfareporting#dynamicTargetingKeysListResponse"
.
|
dynamicTargetingKeys[] |
object (DynamicTargetingKey )
Dynamic targeting key 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 dynamic targeting keys for a specified user profile using the provided \u003ccode\u003eprofileId\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eAllows filtering of dynamic targeting keys by name, object type, object ID, and advertiser ID using query parameters.\u003c/p\u003e\n"],["\u003cp\u003eThe response includes a collection of dynamic targeting keys matching the specified criteria, along with resource kind information.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003edfatrafficking\u003c/code\u003e scope for access.\u003c/p\u003e\n"],["\u003cp\u003eThe request body should be empty for this \u003ccode\u003eGET\u003c/code\u003e request.\u003c/p\u003e\n"]]],[],null,["# Method: dynamicTargetingKeys.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.DynamicTargetingKeysListResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nRetrieves a list of dynamic targeting keys.\n\n### HTTP request\n\n`GET https://dfareporting.googleapis.com/dfareporting/v4/userprofiles/{profileId}/dynamicTargetingKeys`\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| `names[]` | `string` Select only dynamic targeting keys exactly matching these names. |\n| `object``Type` | `enum (`[ObjectType](/doubleclick-advertisers/rest/v4/dynamicTargetingKeys#ObjectType)`)` Select only dynamic targeting keys with this object type. |\n| `object``Id` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Select only dynamic targeting keys with this object ID. |\n| `advertiser``Id` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Select only dynamic targeting keys whose object has this advertiser ID. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nDynamic Targeting Key dynamicTargetingKeys.list Response\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"kind\": string, \"dynamicTargetingKeys\": [ { object (/doubleclick-advertisers/rest/v4/dynamicTargetingKeys#DynamicTargetingKey) } ] } ``` |\n\n| Fields ||\n|------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Identifies what kind of resource this is. Value: the fixed string `\"dfareporting#dynamicTargetingKeysListResponse\"` . |\n| `dynamic``Targeting``Keys[]` | `object (`[DynamicTargetingKey](/doubleclick-advertisers/rest/v4/dynamicTargetingKeys#DynamicTargetingKey)`)` Dynamic targeting key collection. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/dfatrafficking`"]]