Get product group promotions
GET {{baseUrl}}/ad_accounts/:ad_account_id/product_group_promotions?product_group_promotion_ids=5368422429&entity_statuses=ACTIVE&entity_statuses=PAUSED&ad_group_id=4&page_size=25&order=ASCENDING&bookmark=<string>
List existing product group promotions associated with an ad account.
Include either adgroupid or productgrouppromotion_ids in your request.
Note: adgroupids and productgrouppromotionids are mutually exclusive parameters. Only provide one. If multiple options are provided, productgrouppromotionids takes precedence over adgroupids. If none are provided, the endpoint returns an error.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
product_group_promotion_ids | number | List of Product group promotion Ids. | |
entity_statuses | string | Entity status | |
entity_statuses | string | Entity status | |
ad_group_id | number | Ad group Id. | |
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":[{"data":{"id":"04961","ad_group_id":"2049","bid_in_micro_currency":"\u003cinteger\u003e","included":"\u003cboolean\u003e","definition":"\u003cstring\u003e","relative_definition":"\u003cstring\u003e","parent_id":"9474643404","slideshow_collections_title":"\u003cstring\u003e","slideshow_collections_description":"\u003cstring\u003e","is_mdl":"\u003cboolean\u003e","status":"ARCHIVED","tracking_url":"\u003cstring\u003e","catalog_product_group_id":"65","catalog_product_group_name":"\u003cstring\u003e","creative_type":"SHOP_THE_PIN","collections_hero_pin_id":"1993476","collections_hero_destination_url":"\u003cstring\u003e"},"exceptions":[{"nullable":true},{"nullable":true}]},{"data":{"id":"33964982","ad_group_id":"AG28","bid_in_micro_currency":"\u003cinteger\u003e","included":"\u003cboolean\u003e","definition":"\u003cstring\u003e","relative_definition":"\u003cstring\u003e","parent_id":"0","slideshow_collections_title":"\u003cstring\u003e","slideshow_collections_description":"\u003cstring\u003e","is_mdl":"\u003cboolean\u003e","status":"ACTIVE","tracking_url":"\u003cstring\u003e","catalog_product_group_id":"11552298523","catalog_product_group_name":"\u003cstring\u003e","creative_type":"SHOWCASE","collections_hero_pin_id":"2346301563","collections_hero_destination_url":"\u003cstring\u003e"},"exceptions":[{"nullable":true},{"nullable":true}]}],"bookmark":"\u003cstring\u003e"}