v1

latestOpenAPI 3.1.02026-07-26950137.9 KB

Create a Campaign

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

Returns the newly created Campaign in the response body.

post/backstage/api/1.0/{account_id}/campaigns/

Path parameters

account_idstring required

An alphabetic ID. See Get Account Details.

Request body

RAW_BODYstring json required

A JSON object representing the campaign. (See below for additional examples.)

Response

200

idstring

advertiser_idstring

namestring

branding_textstring

tracking_codestring

cpcnumber

daily_capinteger

spending_limitinteger

spending_limit_modelstring

{"stackTrail":"paths:/backstage/api/1.0/{account_id}/campaigns/:post:responses:200:content:application/json:schema:properties:sub_country_targeting","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/backstage/api/1.0/{account_id}/campaigns/:post:responses:200:content:application/json:schema:properties:publisher_targeting","oasType":"schema","type":"unknown"}

daily_ad_delivery_modelstring

{"stackTrail":"paths:/backstage/api/1.0/{account_id}/campaigns/:post:responses:200:content:application/json:schema:properties:comments","oasType":"schema","type":"unknown"}

bid_typestring

marketing_objectivestring

start_datestring

end_datestring

approval_statestring

is_activeboolean

Example response

{
  "id": "123",
  "advertiser_id": "taboola-demo-advertiser",
  "name": "DemoCampaign",
  "branding_text": "Pizza",
  "tracking_code": "taboola-track",
  "cpc": 0.25,
  "daily_cap": 100,
  "spending_limit": 1000,
  "spending_limit_model": "MONTHLY",
  "country_targeting": {
    "type": "INCLUDE",
    "value": [
      "AU"
    ]
  },
  "platform_targeting": {
    "type": "INCLUDE",
    "value": [
      "TBLT"
    ]
  },
  "os_targeting": {
    "type": "INCLUDE",
    "value": [
      {
        "os_family": "Android"
      }
    ]
  },
  "daily_ad_delivery_model": "STRICT",
  "publisher_bid_modifier": {
    "values": [
      {
        "target": "publisher1",
        "cpc_modification": 1.5
      }
    ]
  },
  "activity_schedule": {
    "mode": "CUSTOM",
    "rules": [
      {
        "type": "INCLUDE",
        "day": "MONDAY",
        "from_hour": "10",
        "until_hour": "18"
      }
    ],
    "time_zone": "US/Eastern"
  },
  "bid_type": "OPTIMIZED_CONVERSIONS",
  "marketing_objective": "DRIVE_WEBSITE_TRAFFIC",
  "start_date": "2015-04-30",
  "end_date": "2015-05-30",
  "approval_state": "PENDING",
  "is_active": true
}