Update Existing Ad Group

📘

URL: PUT/api/v1/adGroups

Note:

• This API supports batch operations with a max batch size of 10. For bulk operation, the advertiserId must be the same across all requests in the payload.
• Updating multiple ad groups with different targeting types is supported in Bulk. For example: A single bulk payload can include one ad group update request with keyword targeting and another ad group update request with contextual targeting.
• PUT API requests will overwrite all current values and are not intended to be used as incremental updates like PATCH operations
• You must set all of budgetType, dailyBudget, totalBudget, startDate, endDate, and deliverySpeed parameters at same level i.e. either at campaign level or ad group level

Request Parameters

Note:

• You must set all of: budgetType, dailyBudget, totalBudget, startDate, endDate, and deliverySpeed parameters at same level i.e. either at campaign level or ad group level
• Budget, schedule and delivery speed must be set either at campaign or ad group level

Sample Request

curl -X PUT \
'https://developer.api.us.stg.walmart.com/api-proxy/service/display/api/v1/api/v1/adGroups' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <auth_token>' \
--header 'WM_SEC.AUTH_SIGNATURE: ***********' \
--header 'WM_CONSUMER.ID: abcde-v123-fa2r-a1fs-asd45f6qef' \
--header 'WM_SEC.KEY_VERSION: 1' \
--header 'WM_CONSUMER.intimestamp: 1565309779' \ --data '[ { "campaignId": 1, "advertiserId": 1, "adGroupId": 1, "name": "string", "startDate": "string", "endDate": "string", "rateType" : "cpm", "budgetType": "string", "dailyBudget": 0.0, /*Only one of these fields is required based upon the budgetType you choose*/ "totalBudget": 0.0, /*Only one of these fields is required based upon the budgetType you choose*/ "deliverySpeed": "frontloaded", /*frontloaded pacing is not supported if budgetType is daily*/ "frequencyCapDay": 0, "frequencyCapWeek": 0, "frequencyCapMonth": 0, "baseBid": 0.0, "maxBid": 0.0, "targeting": { "and": [ { "contextual": [ { "id": 3454, "reach": "tier_1" }, { "id": 245245, "reach": "tier_2" } ] }, { "geoTargets": [
{ "id": 134 }, { "id": 356 }, { "id": 23233 } ] } ] } }
]' 

Sample Request (Batch Operation)

curl -X PUT \
'https://developer.api.us.stg.walmart.com/api-proxy/service/display/api/v1/api/v1/adGroups' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <auth_token>' \
--header 'WM_SEC.AUTH_SIGNATURE: ***********' \
--header 'WM_CONSUMER.ID: abcde-v123-fa2r-a1fs-asd45f6qef' \
--header 'WM_SEC.KEY_VERSION: 1' \
--header 'WM_CONSUMER.intimestamp: 1565309779' \ --data '[ { "campaignId": 1, "advertiserId": 1, "adGroupId": 1, "name": "string", "startDate": "string", "endDate": "string", "rateType" : "string", "budgetType": "string", "dailyBudget": 0.0, /*Only one of these fields is required based upon the budgetType you choose*/ "totalBudget": 0.0, /*Only one of these fields is required based upon the budgetType you choose*/ "deliverySpeed": "frontloaded", /*frontloaded pacing is not supported if budgetType is daily*/ "frequencyCapDay": 0, "frequencyCapWeek": 0, "frequencyCapMonth": 0, "baseBid": 0.0, "maxBid": 0.0, "targeting": { "and": [ { "contextual": [ { "id": 3454, "reach": "tier_1" }, { "id": 245245, "reach": "tier_2" } ] }, { "geoTargets": [
{ "id": 134 }, { "id": 356 }, { "id": 23233 } ] } ] } }, { "campaignId": 1, "advertiserId": 1, "adGroupId": 2, "name": "string", "startDate": "string", "endDate": "string", "rateType": "string", "budgetType": "string", "dailyBudget": 0.0, "totalBudget": 0.0, "deliverySpeed": "string", "frequencyCapDay": 0, "frequencyCapWeek": 0, "frequencyCapMonth": 0, "baseBid": 0.0, "maxBid": 0.0, "targeting": { "and": [ { "keywords": [ { "keywordText": "test-keyword-1", "matchType": "BROAD" }, { "keywordText": "test-keyword-2", "matchType": "EXACT" } ], "not": [ { "keywords": [ { "keywordText": "test-keyword-negative", "matchType": "BROAD" } ] } ] }, { "geoTargets": [ { "zipCode":"35004" } ] } ] } }
]' 

Response

Sample Response

[ { "code": "success", "details":"string", "adGroupId": 11 } ] 

Sample Response (Batch Operation)

[ { "code": "success", "details": "string", "adGroupId": 11 }, { "code": "failure", "details": ["string"], "adGroupId": 12 } ]