List
|
|||||
|
|
||||
Retrieves a list of dynamic targeting keys
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 5 input parameters
| Name | Format | Description |
|---|---|---|
profileId Required |
INTEGER |
User profile ID associated with this request |
advertiserId |
INTEGER |
Select only dynamic targeting keys whose object has this advertiser ID |
names |
STRING |
Select only dynamic targeting keys exactly matching these names |
objectId |
INTEGER |
Select only dynamic targeting keys with this object ID |
objectType |
ENUMERATION |
Select only dynamic targeting keys with this object type |
= Parameter name
= Format
|
profileId INTEGER Required User profile ID associated with this request |
|
advertiserId INTEGER Select only dynamic targeting keys whose object has this advertiser ID |
|
names STRING Select only dynamic targeting keys exactly matching these names |
|
objectId INTEGER Select only dynamic targeting keys with this object ID |
|
objectType ENUMERATION Select only dynamic targeting keys with this object type |
Output
This building block provides 6 output parameters
| Name | Format | Description |
|---|---|---|
dynamicTargetingKeys[] |
OBJECT |
Contains properties of a dynamic targeting key. Dynamic targeting keys are unique, user-friendly labels, created at the advertiser level in DCM, that can be assigned to ads, creatives, and placements and used for targeting with Studio dynamic creatives. Use these labels instead of numeric Campaign Manager IDs (such as placement IDs) to save time and avoid errors in your dynamic feeds |
dynamicTargetingKeys[].kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicTargetingKey" |
dynamicTargetingKeys[].name |
STRING |
Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase |
dynamicTargetingKeys[].objectId |
INTEGER |
ID of the object of this dynamic targeting key. This is a required field |
dynamicTargetingKeys[].objectType |
ENUMERATION |
Type of the object of this dynamic targeting key. This is a required field |
kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicTargetingKeysListResponse" |
= Parameter name
= Format
|
dynamicTargetingKeys[] OBJECT Contains properties of a dynamic targeting key. Dynamic targeting keys are unique, user-friendly labels, created at the advertiser level in DCM, that can be assigned to ads, creatives, and placements and used for targeting with Studio dynamic creatives. Use these labels instead of numeric Campaign Manager IDs (such as placement IDs) to save time and avoid errors in your dynamic feeds |
|
dynamicTargetingKeys[].kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicTargetingKey" |
|
dynamicTargetingKeys[].name STRING Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase |
|
dynamicTargetingKeys[].objectId INTEGER ID of the object of this dynamic targeting key. This is a required field |
|
dynamicTargetingKeys[].objectType ENUMERATION Type of the object of this dynamic targeting key. This is a required field |
|
kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicTargetingKeysListResponse" |