Unified.to · Schema

AdsGroup

IntegrationsUnified API

Properties

Name Type Description
bid_amount number
bid_strategy object
billing_event string
budget_allocation_type string
budget_amount number
budget_max_amount number
budget_period string
budget_unit string
campaign_id string
created_at string
creative_ids object
currency string
end_at string
frequency_cap object
has_eu_political_ads boolean
id string
insertionorder_id string
name string
optimization_goal string
organization_id string
pacing object
parent_id string
promoted object
raw object
start_at string
status string
targeting object
type string
updated_at string
View JSON Schema on GitHub

JSON Schema

unified-to-adsgroup-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AdsGroup",
  "title": "AdsGroup",
  "properties": {
    "bid_amount": {
      "type": "number"
    },
    "bid_strategy": {
      "$ref": "#/components/schemas/property_AdsGroup_bid_strategy"
    },
    "billing_event": {
      "enum": [
        "IMPRESSIONS",
        "LINK_CLICKS",
        "VIDEO_VIEWS",
        "APP_INSTALLS",
        "ENGAGEMENT",
        "PAGE_LIKES",
        "MESSAGES",
        "POST_ENGAGEMENT",
        "PURCHASE",
        "NONE"
      ],
      "type": "string",
      "x-speakeasy-unknown-values": "allow"
    },
    "budget_allocation_type": {
      "enum": [
        "UNSPECIFIED",
        "AUTOMATIC",
        "FIXED",
        "UNLIMITED"
      ],
      "type": "string",
      "x-speakeasy-unknown-values": "allow"
    },
    "budget_amount": {
      "type": "number"
    },
    "budget_max_amount": {
      "type": "number"
    },
    "budget_period": {
      "enum": [
        "DAILY",
        "MONTHLY",
        "TOTAL",
        "LIFETIME"
      ],
      "type": "string",
      "x-speakeasy-unknown-values": "allow"
    },
    "budget_unit": {
      "enum": [
        "UNSPECIFIED",
        "CURRENCY",
        "IMPRESSIONS"
      ],
      "type": "string",
      "x-speakeasy-unknown-values": "allow"
    },
    "campaign_id": {
      "type": "string"
    },
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "creative_ids": {
      "$ref": "#/components/schemas/property_AdsGroup_creative_ids"
    },
    "currency": {
      "type": "string"
    },
    "end_at": {
      "format": "date-time",
      "type": "string"
    },
    "frequency_cap": {
      "$ref": "#/components/schemas/property_AdsGroup_frequency_cap"
    },
    "has_eu_political_ads": {
      "type": "boolean"
    },
    "id": {
      "type": "string"
    },
    "insertionorder_id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "optimization_goal": {
      "enum": [
        "REACH",
        "IMPRESSIONS",
        "LINK_CLICKS",
        "LANDING_PAGE_VIEWS",
        "CONVERSIONS",
        "LEAD_GENERATION",
        "APP_INSTALLS",
        "APP_ENGAGEMENT",
        "VIDEO_VIEWS",
        "ENGAGEMENT",
        "PAGE_LIKES",
        "MESSAGES"
      ],
      "type": "string",
      "x-speakeasy-unknown-values": "allow"
    },
    "organization_id": {
      "type": "string"
    },
    "pacing": {
      "$ref": "#/components/schemas/property_AdsGroup_pacing"
    },
    "parent_id": {
      "type": "string"
    },
    "promoted": {
      "$ref": "#/components/schemas/property_AdsGroup_promoted"
    },
    "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_AdsGroup_targeting"
    },
    "type": {
      "enum": [
        "TEXT",
        "IMAGE",
        "VIDEO",
        "RESPONSIVE",
        "SHOPPING",
        "APP",
        "CALL",
        "CAROUSEL",
        "SOCIAL",
        "DISPLAY",
        "SEARCH",
        "AUDIO",
        "YOUTUBE"
      ],
      "type": "string",
      "x-speakeasy-unknown-values": "allow"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    }
  },
  "type": "object"
}