Update campaigns in bulk
This endpoint enables simultaneous updates to multiple campaigns in a single operation. It supports selective field updates using field masks to specify which campaign properties should be modified, w
description: "This endpoint enables simultaneous updates to multiple campaigns in a single operation. It supports selective field updates using field masks to specify which campaign properties should be modified, while preserving unchanged fields. The operation is optimized for bulk modifications across campaigns of the same type, providing efficient batch processing for campaign management workflows. Field masks allow precise control over which attributes are updated (e.g., 'name,startTime,endTime') ensuring only intended changes are applied."
Update campaigns in bulk
This endpoint enables simultaneous updates to multiple campaigns in a single operation. It supports selective field updates using field masks to specify which campaign properties should be modified, while preserving unchanged fields. The operation is optimized for bulk modifications across campaigns of the same type, providing efficient batch processing for campaign management workflows. Field masks allow precise control over which attributes are updated (e.g., 'name,startTime,endTime') ensuring only intended changes are applied.
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 updated campaigns.
application/json
bulkIdstringOptional
messagestringOptional
statusstring · enumOptionalDefault:
BULK_OPERATION_UNSPECIFIEDPossible 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
patch/v3/campaigns/bulk/update
PATCH /v3/campaigns/bulk/update HTTP/1.1
Host: campaign.citrusad.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 3425
{
"campaigns": [
{
"campaign": {
"advertisedProducts": {
"productGroupList": [
"text"
],
"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"
}
]
}
]
},
"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",
"primaryVideoConfig": {
"fileId": "video-id-1234"
},
"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"
}
]
},
"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"
},
"id": "abc123xyz",
"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",
"positions": [
1,
2,
3
]
}
},
"targeting": {
"audience": {
"includeSegmentsSets": [
{
"segmentIds": [
"text"
]
}
]
},
"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_UNSPECIFIED",
"phrase": "text"
}
],
"searchTerms": [
{
"collectionName": "default_collection",
"matchType": "MATCH_TYPE_UNSPECIFIED",
"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"
},
"campaignType": "CAMPAIGN_TYPE_UNSPECIFIED",
"mask": "text"
}
]
}{
"bulkId": "text",
"message": "text",
"status": "BULK_OPERATION_UNSPECIFIED"
}