Unified.to · Schema

AdsCampaign

IntegrationsUnified API

Properties

Name Type Description
advertising_channel_type string
budget_amount number
budget_period string
campaign_budget_identifier string
category string
created_at string
currency string
end_at string
frequency_cap object
goal string
has_eu_political_ads boolean
id string
name string
organization_id string
planned_spend_amount number
raw object
start_at string
status string
targeting object
total_spend_amount number
updated_at string
View JSON Schema on GitHub

JSON Schema

unified-to-adscampaign-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AdsCampaign",
  "title": "AdsCampaign",
  "properties": {
    "advertising_channel_type": {
      "enum": [
        "TEXT",
        "IMAGE",
        "VIDEO",
        "RESPONSIVE",
        "SHOPPING",
        "APP",
        "CALL",
        "CAROUSEL",
        "SOCIAL",
        "DISPLAY",
        "SEARCH",
        "AUDIO",
        "YOUTUBE"
      ],
      "type": "string",
      "x-speakeasy-unknown-values": "allow"
    },
    "budget_amount": {
      "type": "number"
    },
    "budget_period": {
      "enum": [
        "DAILY",
        "MONTHLY",
        "TOTAL",
        "LIFETIME"
      ],
      "type": "string",
      "x-speakeasy-unknown-values": "allow"
    },
    "campaign_budget_identifier": {
      "type": "string"
    },
    "category": {
      "type": "string"
    },
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "currency": {
      "type": "string"
    },
    "end_at": {
      "format": "date-time",
      "type": "string"
    },
    "frequency_cap": {
      "$ref": "#/components/schemas/property_AdsCampaign_frequency_cap"
    },
    "goal": {
      "enum": [
        "UNSPECIFIED",
        "BRAND_AWARENESS",
        "REACH",
        "WEBSITE_TRAFFIC",
        "LEADS",
        "SALES",
        "APP_PROMOTION"
      ],
      "type": "string",
      "x-speakeasy-unknown-values": "allow"
    },
    "has_eu_political_ads": {
      "type": "boolean"
    },
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "organization_id": {
      "type": "string"
    },
    "planned_spend_amount": {
      "type": "number"
    },
    "raw": {
      "additionalProperties": true,
      "type": "object"
    },
    "start_at": {
      "format": "date-time",
      "type": "string"
    },
    "status": {
      "enum": [
        "UNSPECIFIED",
        "ACTIVE",
        "PAUSED",
        "ARCHIVED",
        "DRAFT",
        "SCHEDULED_FOR_DELETION"
      ],
      "type": "string",
      "x-speakeasy-unknown-values": "allow"
    },
    "targeting": {
      "$ref": "#/components/schemas/property_AdsCampaign_targeting"
    },
    "total_spend_amount": {
      "type": "number"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    }
  },
  "type": "object"
}