Create targeting templates
Changed onTargeting templates allow advertisers to save a set of targeting details including audience lists, keywords & interest, demographics, and placements to use more than once during the campaign creation process.
Templates can be used to build out basic targeting criteria that you plan to use across campaigns and to reuse performance targeting from prior campaigns for new campaigns.
Request
- Base URLhttps://api.pinterest.com/v5
- AuthOAuth 2Authorization codehttps://www.pinterest.com/oauth/Token URLhttps://api.pinterest.com/v5/oauth/tokenScopesads:write
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
Unique identifier of an ad account.
Request body
Example request
{
"keywords": [
{
"match_type": "BROAD",
"value": "couples halloween costumes"
}
],
"placement_group": "ALL",
"targeting_attributes": {
"SHOPPING_RETARGETING": [
{
"lookback_window": 30,
"exclusion_window": 14,
"tag_types": [
0,
6
]
}
]
},
"tracking_urls": {
"impression": [
"URL1",
"URL2"
],
"click": [
"URL1",
"URL2"
],
"engagement": [
"URL1",
"URL2"
],
"buyable_button": [
"URL1",
"URL2"
],
"audience_verification": [
"URL1",
"URL2"
]
}
}Response
The request has succeeded.
Example response
{
"keywords": [
{
"match_type": "BROAD",
"value": "couples halloween costumes"
}
],
"placement_group": "ALL",
"sizing": {
"reach_estimate": {
"estimate": 63492000,
"lower_bound": 47619000,
"upper_bound": 79365000
}
},
"targeting_attributes": {
"SHOPPING_RETARGETING": [
{
"lookback_window": 30,
"exclusion_window": 14,
"tag_types": [
0,
6
]
}
]
},
"tracking_urls": {
"impression": [
"URL1",
"URL2"
],
"click": [
"URL1",
"URL2"
],
"engagement": [
"URL1",
"URL2"
],
"buyable_button": [
"URL1",
"URL2"
],
"audience_verification": [
"URL1",
"URL2"
]
}
}Changes
- breaking
added the new required request property
- breaking
added the new required request property
- warning
removed
subschema #2from the request bodyallOflist - info
added the new optional request property
- info
added the new optional request property
- info
added the new optional request property
- info
added the new optional request property
- info
removed
subschema #2: TargetingTemplateGetResponseDatafrom the response bodyallOflist for the response status - info
added the non-success response with the status
- info
added the non-success response with the status
- info
added the non-success response with the status
- info
added the non-success response with the status
- info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the required property
to the response with the status - info
added the required property
to the response with the status - info
added the success response with the status
- breaking
- breaking
the
//////////response property's minItems was decreased from100to0for the response status - breaking
the
//////////response property's minItems was decreased from100to0for the response status
- breaking