MAmagellan
Amazon ads

Create a new Amazon ad

Changed on

Creates an Amazon OTT/video ad on a campaign. mediaTypes is locked to ['ott_video'] server-side and cannot be set through this endpoint.

post/measurement/campaigns/{campaign_id}/amazon_ads

Request

  • Base URL
    https://api.magellan.ai/v2
  • URL
    https://api.magellan.ai/v2/measurement/campaigns/{campaign_id}/amazon_ads
  • Auth
    API key in header Authorization

Path parameters

campaign_idstring required
Example:0123456789abcdef

Request body

echostring

Example request

{
  "measurementAmazonAd": {
    "name": "The Pod Show - Mid-Roll",
    "uid": "ad-123-456",
    "cohortsAttributes": [
      {
        "cohortName": "Creative",
        "subCohortName": "Holiday 30s"
      }
    ],
    "amazonCampaignId": 9000001,
    "amazonLineItemId": 8000001,
    "flightsAttributes": [
      {
        "id": 123,
        "startDate": "2024-03-01",
        "endDate": "2024-03-31",
        "expectedImpressions": 100,
        "cpm": 10,
        "uid": "qtr-1-flight-1"
      }
    ]
  }
}

Response

Created

echostring

Example response

{
  "measurementAmazonAd": {
    "id": "0123456789abcdef",
    "name": "The Pod Show - Mid-Roll",
    "uid": "ad-123-456",
    "cohorts": [
      {
        "cohortName": "Creative",
        "subCohortName": "Holiday 30s"
      }
    ],
    "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.",
          "domain": "acme.com"
        }
      }
    },
    "flights": [
      {
        "startDate": "2024-03-01",
        "endDate": "2024-03-31"
      }
    ]
  }
}

Changes