List ads
GET {{baseUrl}}/ad_accounts/:ad_account_id/ads?campaign_ids=978&ad_group_ids=9&ad_ids=9&entity_statuses=ACTIVE&entity_statuses=PAUSED&page_size=25&order=DESCENDING&bookmark=<string>
List ads that meet the filters provided: - Listed campaign ids or ad group ids or ad ids - Listed entity statuses
If no filter is provided, all ads in the ad account are returned.
Note:
Provide only campaignid or adgroupid or adid. Do not provide more than one type.
Review status is provided for each ad; if reviewstatus is REJECTED, the rejectedreasons field will contain additional information. For more, see Pinterest advertising standards.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
campaign_ids | number | List of Campaign Ids to use to filter the results. | |
ad_group_ids | number | List of Ad group Ids to use to filter the results. | |
ad_ids | number | List of Ad Ids to use to filter the results. | |
entity_statuses | string | Entity status | |
entity_statuses | string | Entity status | |
page_size | number | Maximum number of items to include in a single page of the response. See documentation on <a href='/docs/getting-started/pagination/'>Pagination</a> for more information. | |
order | string | The order in which to sort the items returned: “ASCENDING” or “DESCENDING” | |
| by ID. Note that higher-value IDs are associated with more-recently added | |||
| items. | |||
bookmark | string | Cursor used to fetch the next page of items |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"items":[{"ad_group_id":"AG8","android_deep_link":"\u003cstring\u003e","carousel_android_deep_links":["\u003cstring\u003e","\u003cstring\u003e"],"carousel_destination_urls":["\u003cstring\u003e","\u003cstring\u003e"],"carousel_ios_deep_links":["\u003cstring\u003e","\u003cstring\u003e"],"click_tracking_url":"\u003cstring\u003e","creative_type":"SHOWCASE","destination_url":"\u003cstring\u003e","ios_deep_link":"\u003cstring\u003e","is_pin_deleted":"\u003cboolean\u003e","is_removable":"\u003cboolean\u003e","name":"\u003cstring\u003e","status":"PAUSED","tracking_urls":{"impression":["\u003cstring\u003e","\u003cstring\u003e"],"click":["\u003cstring\u003e","\u003cstring\u003e"],"engagement":["\u003cstring\u003e","\u003cstring\u003e"],"buyable_button":["\u003cstring\u003e","\u003cstring\u003e"],"audience_verification":["\u003cstring\u003e","\u003cstring\u003e"]},"view_tracking_url":"\u003cstring\u003e","pin_id":"03087525385","ad_account_id":"8171","campaign_id":"93132292","collection_items_destination_url_template":"\u003cstring\u003e","created_time":"\u003cinteger\u003e","id":"05984015373","rejected_reasons":["ILLEGAL_RECREATIONAL_DRUG","LANDING_PAGE_HARDWALL"],"rejection_labels":["\u003cstring\u003e","\u003cstring\u003e"],"review_status":"APPROVED","type":"\u003cstring\u003e","updated_time":"\u003cinteger\u003e","summary_status":"PENDING"},{"ad_group_id":"AG812600003","android_deep_link":"\u003cstring\u003e","carousel_android_deep_links":["\u003cstring\u003e","\u003cstring\u003e"],"carousel_destination_urls":["\u003cstring\u003e","\u003cstring\u003e"],"carousel_ios_deep_links":["\u003cstring\u003e","\u003cstring\u003e"],"click_tracking_url":"\u003cstring\u003e","creative_type":"VIDEO","destination_url":"\u003cstring\u003e","ios_deep_link":"\u003cstring\u003e","is_pin_deleted":"\u003cboolean\u003e","is_removable":"\u003cboolean\u003e","name":"\u003cstring\u003e","status":"ARCHIVED","tracking_urls":{"impression":["\u003cstring\u003e","\u003cstring\u003e"],"click":["\u003cstring\u003e","\u003cstring\u003e"],"engagement":["\u003cstring\u003e","\u003cstring\u003e"],"buyable_button":["\u003cstring\u003e","\u003cstring\u003e"],"audience_verification":["\u003cstring\u003e","\u003cstring\u003e"]},"view_tracking_url":"\u003cstring\u003e","pin_id":"9622459","ad_account_id":"21226","campaign_id":"622","collection_items_destination_url_template":"\u003cstring\u003e","created_time":"\u003cinteger\u003e","id":"219","rejected_reasons":["OTHER","RESTRICTED_HEALTHCARE"],"rejection_labels":["\u003cstring\u003e","\u003cstring\u003e"],"review_status":"REJECTED","type":"\u003cstring\u003e","updated_time":"\u003cinteger\u003e","summary_status":"REJECTED"}],"bookmark":"\u003cstring\u003e"}