Get ad
Changed onGet a specific ad given the ad ID. If your pin is rejected, rejected_reasons will contain additional information from the Ad Review process. For more information about our policies and rejection reasons see the Pinterest advertising standards.
Request
- Base URLhttps://api.pinterest.com/v5
- Auth
- OAuth 2Authorization codehttps://www.pinterest.com/oauth/Token URLhttps://api.pinterest.com/v5/oauth/tokenScopesads:read
- or OAuth 2Client credentialsToken URLhttps://api.pinterest.com/v3/oauth/access_token/Scopesads:read
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
The ID of this ad.
Unique identifier of an ad account.
Response
The request has succeeded.
Example response
{
"collections_header_type": "SHOP_THIS_COLLECTION",
"customizable_cta_type": "LEARN_MORE",
"disclosure_type": "MED_GUIDE",
"grid_click_type": "CLOSEUP",
"quiz_pin_data": {
"questions": [
{
"question_id": 1,
"question_text": "Where do you thrive?",
"options": [
{
"text": "Hangout vibes"
},
{
"text": "Time to party!"
},
{
"text": "Keeping it lowkey"
}
]
},
{
"question_id": 2,
"question_text": "Where would you nap?",
"options": [
{
"text": "Hammock in the mountains"
},
{
"text": "Beach towel in the sand"
},
{
"text": "Tent under the stars"
}
]
},
{
"question_id": 2,
"question_text": "Who are you taking?",
"options": [
{
"text": "No one—solo trip!"
},
{
"text": "My best friend"
},
{
"text": "The family"
}
]
}
],
"results": [
{
"organicPinId": "1234",
"android_deep_link": "https://www.pinterest.com/",
"iOS_deep_link": "https://www.pinterest.com/",
"destination_url": "https://www.pinterest.com/",
"result_id": 1
},
{
"organicPinId": "1234",
"android_deep_link": "https://www.pinterest.com/",
"iOS_deep_link": "https://www.pinterest.com/",
"destination_url": "https://www.pinterest.com/",
"result_id": 2
},
{
"organicPinId": "1234",
"android_deep_link": "https://www.pinterest.com/",
"iOS_deep_link": "https://www.pinterest.com/",
"destination_url": "https://www.pinterest.com/",
"result_id": 3
}
]
},
"status": "ACTIVE",
"summary_status": "APPROVED",
"tracking_urls": {
"impression": [
"URL1",
"URL2"
],
"click": [
"URL1",
"URL2"
],
"engagement": [
"URL1",
"URL2"
],
"buyable_button": [
"URL1",
"URL2"
],
"audience_verification": [
"URL1",
"URL2"
]
}
}Changes
- info
removed
subschema #3from 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 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 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 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 required 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 required 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 required 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
- info
added the optional property
////to the response with the status - info
added the optional property
////to the response with the status
- info