Create campaign in bulk
This endpoint creates multiple campaigns simultaneously (up to 1,000) based on the specified campaign type. Use it to submit a single request containing different campaign types and configurations. Th
description: "This endpoint creates multiple campaigns simultaneously (up to 1,000) based on the specified campaign type. Use it to submit a single request containing different campaign types and configurations. The endpoint supports CAMPAIGN_TYPE_DISPLAY, CAMPAIGN_TYPE_BANNERX, and CAMPAIGN_TYPE_BANNER, each with its own type-specific validation. Note: For CAMPAIGN_TYPE_BANNER, the bannerConfig field must be provided. For CAMPAIGN_TYPE_BANNERX, the bannerXConfig field must be provided."
Create campaign in bulk
This endpoint creates multiple campaigns simultaneously (up to 1,000) based on campaign type. Use this endpoint to specify different campaign types and configurations in a single request. Note: If creating CAMPAIGN_TYPE_BANNER then bannerConfig should be provided, if CAMPAIGN_TYPE_BANNERX then bannerXConfig should be provided.
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 campaigns.
application/json
bulkIdstringOptional
messagestringOptional
statusstring · enumOptionalDefault:
BULK_OPERATION_SUBMITTEDPossible values: 400
There was a problem with input.
application/json
401
Login failed or token not valid.
application/json
403
Access denied due to insufficient permissions.
application/json
default
An unexpected error response.
application/json
post/v3/campaigns/bulk/create
POST /v3/campaigns/bulk/create HTTP/1.1
Host: campaign.<env>.citrusad.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 4141
{
"campaigns": [
{
"campaign": {
"advertisedProducts": {
"productGroupList": [
"text"
],
"productsByAttributes": {
"priceRange": {
"max": "100",
"min": "10"
},
"tags": [
"tag1",
"tag2",
"tag3"
]
},
"productsByKey": [
{
"catalogId": "catalog_001",
"productCode": "PROD123456",
"sellerId": "seller_78910"
}
]
},
"approval": {
"rejectionReason": "text",
"state": "APPROVAL_STATE_UNSPECIFIED"
},
"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"
}
]
}
]
},
"bannerXConfig": {
"additionalFields": [
{
"id": "12345abcde",
"value": "abcd-8798uhu"
}
],
"backgroundColourHex": "#FFFFFF",
"backgroundImageId": "bg_image_001",
"backgroundImagePosition": "BANNER_X_BACKGROUND_IMAGE_POSITION_UNSPECIFIED",
"bannerText": "Summer Sale: Up to 50% off!",
"bannerTextColourHex": "#FF5733",
"companionProducts": [
{
"catalogId": "catalog_001",
"productCode": "PROD123456",
"sellerId": "seller_78910"
}
],
"contentStandardId": "content_standard_001",
"ctaFlag": true,
"ctaLink": "https://www.example.com",
"ctaText": "Click Here",
"ctaTextAccessibility": "Click to learn more",
"headingText": "Welcome to our store!",
"heroImageAltText": "This is the hero image.",
"heroImageId": "hero-image-id-456",
"heroMode": "BANNER_X_HERO_IMAGE_MODE_UNSPECIFIED",
"secondaryBackgroundImageId": "secondary-image-id-123",
"secondaryBackgroundImagePosition": "BANNER_X_BACKGROUND_IMAGE_POSITION_UNSPECIFIED",
"secondaryHeroImageAltText": "Secondary hero image description",
"secondaryHeroImageId": "456defghi",
"secondaryHeroMode": "BANNER_X_HERO_IMAGE_MODE_UNSPECIFIED",
"slotId": "slot_001",
"slotType": "BANNER_X_SLOT_TYPE_UNSPECIFIED",
"trackingTagProvider": [
{
"content": "<script src='tracking.js'></script>",
"provider": "TRACKING_TAG_PROVIDER_UNSPECIFIED"
}
],
"videoConfigs": [
{
"fileId": "video-id-1234",
"id": "id-1234-1234"
}
]
},
"brandPageConfig": {
"contentStandardId": "content_standard_001",
"enableAdType": [
"ENABLED_AD_TYPES_UNSPECIFIED"
],
"name": "text",
"pageContentText": "text",
"pageHeadingText": "text"
},
"campaignState": "CAMPAIGN_STATE_UNSPECIFIED",
"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",
"settings": {
"campaignType": "CAMPAIGN_TYPE_UNSPECIFIED",
"fromTime": "2024-09-01T12:34:56Z",
"toTime": "2024-09-01T12:34:56Z"
},
"startTime": "2024-09-01T12:00:00Z",
"strategy": {
"auction": {
"automatedBid": {
"enableAutomatedBid": true
},
"maxBid": "$100.00",
"spendLimit": {
"daily": "$50.00",
"total": "$1000.00"
}
},
"fixedTenancy": {
"catalogCosts": [
{
"catalogCostPercentage": 0.25,
"catalogId": "catalog_123456"
}
],
"cost": "$99.99",
"positions": [
1,
2,
3
]
}
},
"targeting": {
"audience": {
"includeSegmentsSets": [
{
"segmentIds": [
"text"
]
}
]
},
"crossSell": {
"targetProductsByAttributes": {
"subclassTags": [
"Electronics",
"Home Appliances"
],
"vendorTags": [
"BrandX",
"BrandY"
]
},
"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_UNSPECIFIED",
"phrase": "text"
}
],
"searchTerms": [
{
"collectionName": "default_collection",
"matchType": "MATCH_TYPE_UNSPECIFIED",
"maxBid": "100.00",
"phrase": "example search term",
"treatAsCustom": true
}
],
"upsell": {
"targetProductsByAttributes": {
"priceRange": {
"max": "100",
"min": "10"
},
"subclassTags": [
"text"
],
"vendorTags": [
"text"
]
},
"targetProductsByKey": [
{
"catalogId": "catalog_001",
"productCode": "PROD123456",
"sellerId": "seller_78910"
}
]
}
},
"teamId": "team_12345",
"templateId": "template_123",
"walletId": "wallet_123456789"
},
"campaignType": "CAMPAIGN_TYPE_BANNER"
}
]
}{
"bulkId": "text",
"message": "text",
"status": "BULK_OPERATION_SUBMITTED"
}