Create a banner campaign
Creates a new banner campaign using the details provided in the request body. This endpoint allows you to define campaign parameters, targeting, strategy, and other configurations to launch a new camp
description: "Creates a new banner campaign using the details provided in the request body. This endpoint allows you to define campaign parameters, targeting, strategy, and other configurations to launch a new campaign."
Create a banner campaign
Creates a new banner campaign using the details provided in the request body. This endpoint allows you to define campaign parameters, targeting, strategy, and other configurations to launch a new campaign.
Authorizations
AuthorizationstringRequired
For accessing the API a valid JWT jwt must be passed in all queries in the 'Authorization' header. The following syntax must be used in the 'Authorization' header. (Bearer xxx.yyy.zzz)
Body
Responses
200
Details of the created banner campaign.
application/json
400
There was a problem with input.
application/json
401
Login failed or token not valid.
application/json
403
Login failed or token not valid.
application/json
default
An unexpected error response.
application/json
post/v3/banner-campaigns
POST /v3/banner-campaigns HTTP/1.1
Host: campaign.<env>.citrusad.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1969
{
"bannerCampaign": {
"advertisedProducts": {
"productsByKey": [
{
"catalogId": "catalog_001",
"productCode": "PROD123456",
"sellerId": "seller_78910"
}
]
},
"bannerConfig": {
"contentStandardId": "content_standard_001",
"slotsConfiguration": [
{
"altText": null,
"artworkImageId": "ysdcsdcsdcsdc=",
"link": "http://abc.com/",
"slotId": "Category",
"text": null,
"trackingTagProvider": [
{
"content": "<IMG SRC=\"https://example.com\">",
"provider": "TRACKING_TAG_PROVIDER_DCM_IMPRESSION"
}
]
}
]
},
"campaignState": "CAMPAIGN_STATE_ACTIVE",
"catalogIds": [
"catalog_001",
"catalog_002"
],
"customFields": [
{
"content": "This is a custom field content.",
"customFieldId": "cfid_12345"
}
],
"customQuestions": [
{
"answers": [
"Answer 1",
"Answer 2",
"Answer 3"
],
"customQuestionId": "cqid_67890"
}
],
"endTime": "2024-09-30T23:59:59Z",
"fixedCosts": {
"creativeCost": "$200.00",
"dataCost": "$100.00",
"otherCost": "$50.00"
},
"managerTeamId": "manager_team_67890",
"name": "Summer Sale Campaign",
"namespaceId": "namespace_001",
"placementId": "placement_987654321",
"sellerId": "seller_12345",
"startTime": "2024-09-01T12:00:00Z",
"strategy": {
"auction": {
"maxBid": "$100.00",
"spendLimit": {
"daily": "$50.00",
"total": "$1000.00"
}
},
"fixedTenancy": {
"catalogCosts": [
{
"catalogCostPercentage": 0.25,
"catalogId": "catalog_123456"
}
],
"cost": "$99.99"
}
},
"targeting": {
"crossSell": {
"targetProductsByKey": [
{
"catalogId": "catalog_001",
"productCode": "PROD123456",
"sellerId": "seller_78910"
}
]
},
"excludeFilters": [
{
"catalogId": "catalog_12345",
"filter": "filter_value_abc"
}
],
"includeFilters": [
{
"catalogId": "catalog_12345",
"filter": "filter_value_abc"
}
],
"negativeSearchTerms": [
{
"matchType": "MATCH_TYPE_EXACT_MATCH",
"phrase": "text"
}
],
"searchTerms": [
{
"collectionName": "default_collection",
"matchType": "MATCH_TYPE_PHRASE_MATCH",
"maxBid": "100.00",
"phrase": "example search term",
"treatAsCustom": true
}
],
"upsell": {
"targetProductsByKey": [
{
"catalogId": "catalog_001",
"productCode": "PROD123456",
"sellerId": "seller_78910"
}
]
}
},
"teamId": "team_12345",
"templateId": "template_123",
"walletId": "wallet_123456789"
}
}{
"bannerCampaign": {
"advertisedProducts": {
"productsByKey": [
{
"catalogId": "catalog_001",
"productCode": "PROD123456",
"sellerId": "seller_78910"
}
]
},
"approval": {
"rejectionReason": "text",
"state": "APPROVAL_STATE_PENDING"
},
"bannerConfig": {
"contentStandardId": "content_standard_001",
"slotsConfiguration": [
{
"altText": null,
"artworkImageId": "ysdcsdcsdcsdc=",
"link": "http://abc.com/",
"slotId": "Category",
"text": null,
"trackingTagProvider": [
{
"content": "<IMG SRC=\"https://example.com\">",
"provider": "TRACKING_TAG_PROVIDER_DCM_IMPRESSION"
}
]
}
]
},
"campaignState": "CAMPAIGN_STATE_ACTIVE",
"catalogIds": [
"catalog_001",
"catalog_002"
],
"customFields": [
{
"content": "This is a custom field content.",
"customFieldId": "cfid_12345"
}
],
"customQuestions": [
{
"answers": [
"Answer 1",
"Answer 2",
"Answer 3"
],
"customQuestionId": "cqid_67890"
}
],
"endTime": "2024-09-30T23:59:59Z",
"fixedCosts": {
"creativeCost": "$200.00",
"dataCost": "$100.00",
"otherCost": "$50.00"
},
"id": "abc123xyz",
"managerTeamId": "manager_team_67890",
"name": "Summer Sale Campaign",
"namespaceId": "namespace_001",
"placementId": "placement_987654321",
"sellerId": "seller_12345",
"settings": {
"campaignType": "CAMPAIGN_TYPE_BANNER",
"fromTime": "2024-09-01T12:34:56Z",
"isWildcard": true,
"toTime": "2024-09-01T12:34:56Z"
},
"startTime": "2024-09-01T12:00:00Z",
"strategy": {
"auction": {
"maxBid": "$100.00",
"spendLimit": {
"daily": "$50.00",
"total": "$1000.00"
}
},
"fixedTenancy": {
"catalogCosts": [
{
"catalogCostPercentage": 0.25,
"catalogId": "catalog_123456"
}
],
"cost": "$99.99"
}
},
"targeting": {
"crossSell": {
"targetProductsByKey": [
{
"catalogId": "catalog_001",
"productCode": "PROD123456",
"sellerId": "seller_78910"
}
]
},
"excludeFilters": [
{
"catalogId": "catalog_12345",
"filter": "filter_value_abc"
}
],
"includeFilters": [
{
"catalogId": "catalog_12345",
"filter": "filter_value_abc"
}
],
"negativeSearchTerms": [
{
"matchType": "MATCH_TYPE_EXACT_MATCH",
"phrase": "text"
}
],
"searchTerms": [
{
"collectionName": "default_collection",
"excludedProducts": [
{
"catalogId": "catalog_001",
"productCode": "PROD123456",
"sellerId": "seller_78910"
}
],
"matchType": "MATCH_TYPE_PHRASE_MATCH",
"maxBid": "100.00",
"phrase": "example search term",
"suggested": true,
"treatAsCustom": true
}
],
"upsell": {
"targetProductsByKey": [
{
"catalogId": "catalog_001",
"productCode": "PROD123456",
"sellerId": "seller_78910"
}
]
}
},
"teamId": "team_12345",
"templateId": "template_123",
"updateTime": "2024-09-01T12:34:56Z",
"walletId": "wallet_123456789"
}
}