Create a new broadcast ad
Changed onGenerates 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.
Request
- Base URLhttps://api.magellan.ai/v2
- URLhttps://api.magellan.ai/v2/measurement/campaigns/{campaign_id}/broadcast_ads
- AuthAPI key in header Authorization
Path parameters
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.
Example response
{
"measurementBroadcastAd": {
"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"
}
]
},
"measurementDynamicAd": {
"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
- warning
removed the optional property
from the response with the status - info
added the media type
application/jsonfor the response with the status - info
added the media type
application/jsonfor the response with the status - info
added the non-success response with the status
- info
added the non-success response with the status
- info
added the optional property
//////////////to the response with the status - info
added the optional property
//////////////to the response with the status - info
added the optional property
//////////////to the response with the status - info
added the optional property
//////////////to the response with the status - info
added the optional property
//////////////to the response with the status - info
added the optional property
//////////////to the response with the status - info
added the optional property
//////////////to the response with the status - info
added the optional property
//////////////to the response with the status - info
added the required property
to the response with the status
- warning