Bulk update items across multiple campaigns - e.g. pause all submitted items.
You can also use a network account to bulk update items across the network.
See also:
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Bulk update items - e.g. pause/resume items - across multiple campaigns.
You can also use a network account to bulk update items across the network.
Unified endpointThe bulk update endpoint can be used to pause/resume regular both items (aka static ads) and motion ads.
Example
POST /backstage/api/1.0/demo-advertiser/items/bulk{
"items_to_update": [
309,
801,
573
],
"baseline_item": {
"is_active": true
}
}{
"results": [{
"id": "309",
"campaign_id": "33",
"type": "ITEM",
"url": "https://www.example.com/news/demo_article_9.html",
"thumbnail_url": "http://cdn.example.com/demo_image_9.jpg",
"title": "Demo Article 9",
"description": null,
"approval_state": "APPROVED",
"is_active": false,
"status": "RUNNING",
"policy_review": {
"reject_reason": null,
"status_reason": null
},
"cta": null,
"creative_focus": {
"type": "AUTOMATIC",
"coordinates": null
}
},
{
"id": "801",
"campaign_id": "270",
"type": "ITEM",
"url": "https://www.example.com/news/demo_article_1.html",
"thumbnail_url": "http://cdn.example.com/demo_image_1.jpg",
"title": "Demo Article 1",
"description": null,
"approval_state": "APPROVED",
"is_active": false,
"status": "RUNNING",
"policy_review": {
"reject_reason": null,
"status_reason": null
},
"cta": null,
"creative_focus": {
"type": "AUTOMATIC",
"coordinates": null
}
},
{
"id": "573",
"campaign_id": "163",
"type": "ITEM",
"url": "https://www.example.com/news/demo_article_3.html",
"thumbnail_url": "http://cdn.example.com/demo_image_3.jpg",
"title": "Demo Article 3",
"description": null,
"approval_state": "APPROVED",
"is_active": false,
"status": "RUNNING",
"policy_review": {
"reject_reason": null,
"status_reason": null
},
"cta": null,
"creative_focus": {
"type": "AUTOMATIC",
"coordinates": null
}
},
],
"metadata": {
...
}
}
Request Object
items_to_update: a list of Item IDs to update (each ID passed as a Number). These items can belong to different campaigns under your account.baseline_item: an object containing the fields to set.Currently,
is_activeis the only supported field.
Supported FieldsUse the bulk endpoint to update the following fields:
is_activecreative_focusThis field has been deprecated.
Guidelines
- To bulk update items, use the POST verb.
- Limit each request to a maximum of 200 items.
- By default, if the update operation fails for 1 item, then no items will be updated. To override this behavior, pass
?is_atomic=false.- The bulk update operation ican be used to pause/resume regular both items (aka static ads) and motion ads.
The network accountYou can use a network account to update items across the network:
POST backstage/api/1.0/{network-account}/items/bulkFor more information about the network account see: Network Accounts.
See also
Rate limit
Rate limitTier 4. Shares one budget with the other cross-campaign bulk item endpoints - bulk create, bulk delete, and resubmitting rejected items. Separate from the per-campaign item endpoints.
See Rate limits for the request allowance each tier carries.