Sign in

v1

latestOpenAPI 3.1.02026-07-26374172.5 KB
Broadcast ads

Create a new broadcast ad

Generates a tag to be fired when the broadcast exposure occurs. Ads are part of a Campaign. If an ad with the provided orderIds already exists within the same campaign, the existing ad is returned rather than creating a new one.

post/measurement/campaigns/{campaign_id}/broadcast_ads

Path parameters

campaign_idstring required
Example:0123456789abcdef

Request body

Example request

{
  "measurementBroadcastAd": {
    "name": "The Pod Show - Mid-Roll",
    "uid": "ad-123-456"
  },
  "measurementDynamicAd": {
    "name": "The Pod Show - Mid-Roll",
    "uid": "ad-123-456"
  }
}

Response

OK — An ad with the provided orderIds already exists within this campaign; the existing ad is returned.

noticestring

Runtime deprecation notice for measurementDynamicAd. Present on all broadcast-ad responses while the deprecated alias is still returned.

Example response

{
  "measurementBroadcastAd": {
    "id": "0123456789abcdef",
    "name": "The Pod Show - Mid-Roll",
    "uid": "ad-123-456",
    "campaign": {
      "id": "0123456789abcdef",
      "name": "Brand Campaign Q2",
      "startDate": "2024-03-01",
      "endDate": "2024-03-01",
      "customEvents": [
        {
          "id": 1,
          "label": "Signup",
          "pattern": "example.com/sign_up"
        }
      ],
      "pixel": {
        "id": "0123456789abcdef",
        "name": "Attribution Pixel",
        "brand": {
          "crmBrandId": "brand_0123456789abcdef",
          "name": "ACME Corp., Inc."
        }
      }
    },
    "flights": [
      {
        "startDate": "2024-03-01",
        "endDate": "2024-03-31"
      }
    ]
  },
  "measurementDynamicAd": {
    "id": "0123456789abcdef",
    "name": "The Pod Show - Mid-Roll",
    "uid": "ad-123-456",
    "campaign": {
      "id": "0123456789abcdef",
      "name": "Brand Campaign Q2",
      "startDate": "2024-03-01",
      "endDate": "2024-03-01",
      "customEvents": [
        {
          "id": 1,
          "label": "Signup",
          "pattern": "example.com/sign_up"
        }
      ],
      "pixel": {
        "id": "0123456789abcdef",
        "name": "Attribution Pixel",
        "brand": {
          "crmBrandId": "brand_0123456789abcdef",
          "name": "ACME Corp., Inc."
        }
      }
    },
    "flights": [
      {
        "startDate": "2024-03-01",
        "endDate": "2024-03-31"
      }
    ]
  }
}