PIpinterest
ads

Fetch ad preview records for one or more ad groups

Changed on

Fetch ad preview records for one or more ad groups. Returns all active previews associated with the provided ad group IDs.

get/ad_accounts/{ad_account_id}/campaign_ad_preview

Request

Path parameters

ad_account_idstring required

Unique identifier of an ad account.

Query parameters

ad_group_idsAdGroupIdType[] required

List of Ad group Ids to use to filter the results.

Response

The request has succeeded.

ad_account_idstring required

Advertiser ID for this preview.

ad_group_idstring required

Ad group ID to create a preview record for.

client_idinteger

Client ID that created preview.

expires_atinteger required

Unix timestamp in milliseconds for preview expiration.

is_activeboolean required

Whether preview link is active.

pin_idinteger

Pin ID for pin promotion preview.

pin_promotion_idinteger

Pin promotion ID for this preview.

promoted_product_group_idinteger

Promoted product group ID for catalog previews.

urlstring required

Campaign ad preview URL.

user_idinteger required

User ID that created preview.

uuidstring required

Pin promotion preview key.

Example response

[
  {
    "ad_account_id": "549755885175",
    "ad_group_id": "1234567890",
    "url": "https://ads.pinterest.com/web-ad-preview/748db198-bd61-4a6f-b756-996c034e8cbb/"
  }
]

Changes