Taboola · Schema

Taboola Campaign

Campaign resource exposed by the Taboola Backstage API.

AdvertisingNative AdvertisingDiscoveryPerformance MarketingAdTechRealizeBackstageRecommendationPublisherProgrammatic

Properties

Name Type Description
id string
advertiser_id string
name string
branding_text string
tracking_code string
cpc number
spending_limit number
spending_limit_model string
daily_cap number
daily_ad_delivery_model string
start_date string
end_date string
is_active boolean
status string
approval_state string
marketing_objective string
bid_strategy string
bid_type string
pricing_model string
cpa_goal number
spent number
country_targeting object
sub_country_targeting object
platform_targeting object
publisher_targeting object
contextual_segments_targeting object
View JSON Schema on GitHub

JSON Schema

taboola-campaign-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/taboola/main/json-schema/taboola-campaign-schema.json",
  "title": "Taboola Campaign",
  "description": "Campaign resource exposed by the Taboola Backstage API.",
  "type": "object",
  "required": ["advertiser_id", "name"],
  "properties": {
    "id": { "type": "string" },
    "advertiser_id": { "type": "string" },
    "name": { "type": "string" },
    "branding_text": { "type": "string" },
    "tracking_code": { "type": "string" },
    "cpc": { "type": "number" },
    "spending_limit": { "type": "number" },
    "spending_limit_model": {
      "type": "string",
      "enum": ["ENTIRE", "DAILY", "MONTHLY"]
    },
    "daily_cap": { "type": "number" },
    "daily_ad_delivery_model": {
      "type": "string",
      "enum": ["STABLE", "ACCELERATED"]
    },
    "start_date": { "type": "string", "format": "date" },
    "end_date": { "type": "string", "format": "date" },
    "is_active": { "type": "boolean" },
    "status": {
      "type": "string",
      "enum": ["RUNNING", "PAUSED", "PENDING_APPROVAL", "REJECTED", "TERMINATED", "EXPIRED", "FROZEN"]
    },
    "approval_state": { "type": "string" },
    "marketing_objective": {
      "type": "string",
      "enum": [
        "ONLINE_PURCHASES",
        "LEADS_GENERATION",
        "DRIVE_WEBSITE_TRAFFIC",
        "BRAND_AWARENESS",
        "MOBILE_APP_INSTALL"
      ]
    },
    "bid_strategy": {
      "type": "string",
      "enum": ["FIXED", "SMART", "MAX_CONVERSIONS", "TARGET_CPA"]
    },
    "bid_type": {
      "type": "string",
      "enum": ["CPC", "CPM", "VCPM"]
    },
    "pricing_model": { "type": "string" },
    "cpa_goal": { "type": "number" },
    "spent": { "type": "number" },
    "country_targeting": { "$ref": "#/$defs/targeting" },
    "sub_country_targeting": { "$ref": "#/$defs/targeting" },
    "platform_targeting": { "$ref": "#/$defs/targeting" },
    "publisher_targeting": { "$ref": "#/$defs/targeting" },
    "contextual_segments_targeting": { "$ref": "#/$defs/targeting" }
  },
  "$defs": {
    "targeting": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "enum": ["INCLUDE", "EXCLUDE", "ALL"]
        },
        "value": {
          "type": "array",
          "items": { "type": "string" }
        },
        "href": { "type": "string" }
      }
    }
  }
}