Name | Type | Description | Usage |
---|---|---|---|
cta | CTA Object | An object that represents the CTA. | Recommended flow: Use the mass endpoint to create an item with a cta .--- Alternative flow: - Use the item endpoint to create an item.- Once status != CRAWLING, update the cta . |
Example 1 - create an item using the mass
endpoint
mass
endpointPUT /backstage/api/1.0/<<example_advertiser_id>>/campaigns/1234/items/mass HTTP/1.1
Host: backstage.taboola.com
Content-Type: application/json
Authorization: Bearer {access_token}
{
"collection": [
{
"url": "https://www.demo-advertiser.com/wedding-rings",
"thumbnail_url": "https://cdn.demo-advertiser.com/thumbnails/thumbnail-1.jpg",
"title": "The perfect wedding ring",
"cta": {
"cta_type": "DOWNLOAD"
}
}
]
}
{
"results": [
{
"id": "123",
"campaign_id": "1234",
"type": "ITEM",
"url": "https://www.demo-advertiser.com/wedding-rings",
"thumbnail_url": "https://cdn.demo-advertiser.com/thumbnails/thumbnail-1.jpg",
"title": "The perfect wedding ring",
"description": null,
"approval_state": "PENDING",
"is_active": true,
"status": "PENDING_APPROVAL",
"policy_review": {
"reject_reason": null,
"reject_reason_description": null,
"status_reason": null,
"reviewer_notes": null
},
"cta": {
"cta_type": "DOWNLOAD"
},
"creative_focus": {
"type": "AUTOMATIC",
"coordinates": null
},
"verification_pixel": null,
"viewability_tag": null,
"app_install": null,
"rating": null,
"logo": null,
"disclaimer": null,
"creative_crop": null,
"external_metadata": null
}
],
"metadata": {
"total": 0,
"count": 0,
"static_fields": [],
"static_total_fields": [],
"dynamic_fields": null,
"start_date": null,
"end_date": null
}
}
Example 2 - update an item using the item
endpoint
item
endpointPUT /backstage/api/1.0/<<example_advertiser_id>>/campaigns/1234/items/123 HTTP/1.1
Host: backstage.taboola.com
Content-Type: application/json
Authorization: Bearer {access_token}
{
"cta": {
"cta_type": "DOWNLOAD"
}
}
{
"id": "123",
"campaign_id": "1234",
"type": "ITEM",
"url": "http://www.demo-advertiser.com/medalions",
...
"cta": {
"cta_type": "DOWNLOAD"
},
...
}