Create a Campaign

post

https://backstage.taboola.com/backstage/api/1.0/{account_id}/campaigns/

Submit a JSON object representing the new campaign in the request body. (See examples below.)

Returns the newly created Campaign in the response body.

Recent Requests

Log in to see full request history

Time	Status	User Agent
Retrieving recent requests…

Loading…

Examples

🚧
Guidelines

Pass a JSON object that represents the new campaign.

The minimal set of fields depends on the chosen bidding strategy (and whether or not a spending limit is being set).

You can (optionally) pass additional fields.

Example 1 - Bidding strategy is `"MAXIMIZE_CONVERSIONS"`

POST /backstage/api/1.0/USER.EXAMPLE_ADVERTISER_ID/campaigns/ HTTP/1.1
Host: backstage.taboola.com 
Content-Type: application/json
Authorization: Bearer {access_token}

{
    "name": "Max Conversions Campaign",
    "branding_text": "branding",
    "spending_limit": 100,
    "spending_limit_model": "MONTHLY",
    "bid_strategy": "MAX_CONVERSIONS",
    "marketing_objective": "LEADS_GENERATION"
}

{
    "id": 1234,
    "advertiser_id": "USER.EXAMPLE_ADVERTISER_ID",
    "name": "Max Conversions Campaign",
    "branding_text": "branding",
    "cpc": null,
    "spending_limit": 100.0,
    "spending_limit_model": "MONTHLY",  
    "bid_strategy": "MAX_CONVERSIONS",
    "marketing_objective": "LEADS_GENERATION",
    ...
}

Example 2 - Bidding strategy is `"FIXED"`

POST /backstage/api/1.0/USER.EXAMPLE_ADVERTISER_ID/campaigns/ HTTP/1.1
Host: backstage.taboola.com 
Content-Type: application/json
Authorization: Bearer {access_token}

{
   "name": "Fixed CPC Campaign",
   "branding_text": "branding",
   "cpc": 0.25,
   "spending_limit": 1000,
   "spending_limit_model": "MONTHLY",
   "bid_strategy": "FIXED",  
   "marketing_objective": "DRIVE_WEBSITE_TRAFFIC"
}

{
    "id": 1234,
    "advertiser_id": "USER.EXAMPLE_ADVERTISER_ID",
    "name": "Fixed CPC Campaign",
    "branding_text": "branding",
    "cpc": 0.25,
    "spending_limit": 1000.0,
    "spending_limit_model": "MONTHLY",  
    "bid_strategy": "FIXED",  
    "marketing_objective": "DRIVE_WEBSITE_TRAFFIC"
    ...
}

Example 3 - Bidding strategy is `"FIXED"` (no spending limit)

POST /backstage/api/1.0/USER.EXAMPLE_ADVERTISER_ID/campaigns/ HTTP/1.1
Host: backstage.taboola.com 
Content-Type: application/json
Authorization: Bearer {access_token}

{
   "name": "Fixed CPC Campaign",
   "branding_text": "branding",
   "cpc": 0.25,
   "daily_cap": 100,
   "spending_limit_model": "NONE",
   "bid_strategy": "FIXED",  
   "marketing_objective": "DRIVE_WEBSITE_TRAFFIC"
}

{
    "id": 1234,
    "advertiser_id": "USER.EXAMPLE_ADVERTISER_ID",
    "name": "Fixed CPC Campaign",
    "branding_text": "branding",
    "cpc": 0.25,
    "spending_limit": null,
    "spending_limit_model": "NONE",  
    "bid_strategy": "FIXED",  
    "marketing_objective": "DRIVE_WEBSITE_TRAFFIC"
    ...
}

🚧
No spending limit
Campaigns with no spending limit are available for eligible accounts only.
See: spending_limit_model

📘
start_date
You can optionally pass a start_date for the new campaign.
If omitted, the default start date is 'now' (in the majority of cases).

Responses

Language

Credentials

OAuth2

Loading…

Response

Choose an example:

application/json