HomeGuidesAPI Reference
Guides

Update Existing Ad Group Media

Update the video creative uploaded to ad group for a specific campaign

📘

URL: PUT/api/v1/adGroup/media

Query Parameters

ParameterDescriptionTypeRequiredPossible Values
adGroupIdThe Id of the ad groupintegerYUnique numeric identifier representing the ad group
mediaIdThe unique Id of the media file generated from the notify media upload complete callintegerYUnique numeric identifier
campaignIdId of the campaign this ad group belongs tointegerYUnique numeric identifier
adGroupMediaIdThe Id of the video creative uploaded to the ad groupintegerYUnique numeric identifier

Headers

Header NameDescriptionRequiredValues
AuthorizationThe token will provide you the access to the API. It is the same for all advertisers you access through the API.YPlease utilize the generated auth_token shared with you at the time of partner onboarding from the Getting Started Guide
WM_CONSUMER.IDWe will provide you the consumer ID to access the API. It is same for all advertisers you access through the API.   YPlease use the generated ConsumerId shared with you at the time of partner onboarding. Refer to the Getting Started Guide for further explanation on this
WM_SEC.AUTH_SIGNATUREAuth signature as an API keyYUse the signature generator code from the Getting Started Guide to generate this value
WM_SEC.KEY_VERSIONWe will provide you with the KEY VERSION to access the API. It is same for all advertisers you access through the APIY1
WM_CONSUMER.intimestampTimestamp for which the auth signature is generated. Use Unix epoch format for the timestampYUse the signature generator code (Getting Started Guide) to generate this value

Sample Request 1

curl -X PUT \
'https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/adGroup/media' \
--header 'accept: application/json' \
--header 'Authorization: Bearer <auth_token>' \
--header 'WM_SEC.AUTH_SIGNATURE: ***********' \
--header 'WM_SEC.KEY_VERSION: 1' \ 
--header 'WM_CONSUMER.ID: adfwe-v23-faasd2r-afs-asdfqeff' \
--header 'WM_CONSUMER.intimestamp: 1565309779' \
--header 'Content-Type: application/json' \
--data '{ "adGroupId": 511111, "campaignId": 511111, "adGroupMediaId": 611116, "mediaId": 611116 }'

Sample Request 2

curl -X PUT \
'https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/adGroup/media' \
--header 'accept: application/json' \
--header 'Authorization: Bearer <auth_token>' \
--header 'WM_SEC.AUTH_SIGNATURE: ***********' \
--header 'WM_SEC.KEY_VERSION: 1' \ 
--header 'WM_CONSUMER.ID: adfwe-v23-faasd2r-afs-asdfqeff' \
--header 'WM_CONSUMER.intimestamp: 1565309779' \
--header 'Content-Type: application/json' \
--data '{ "adGroupId": 511111, "campaignId": 511111, "adGroupMediaId": 611111, "mediaId": 611113 }'

Sample Request 3

curl -X PUT \
'https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/adGroup/media' \
--header 'accept: application/json' \
--header 'Authorization: Bearer <auth_token>' \
--header 'WM_SEC.AUTH_SIGNATURE: ***********' \
--header 'WM_SEC.KEY_VERSION: 1' \ 
--header 'WM_CONSUMER.ID: adfwe-v23-faasd2r-afs-asdfqeff' \
--header 'WM_CONSUMER.intimestamp: 1565309779' \
--header 'Content-Type: application/json' \
--data '{ "adGroupId": 511114, "campaignId": 511114, "adGroupMediaId": 124405, "mediaId": 611116 }'

Response

ElementDescriptionType
codePossible values of response code:   success ,failurestring
detailsDetails of the error if value of response code is failurestring
adGroupMediaIdID of the video creative attached to ad group for specific advertiserinteger

Sample Response 1

[ { "code": "success", "details": "", "adGroupMediaId": 611116 }
]

Sample Response 2

[ { "code": "failure", "details": " MediaDetails not found.", "adGroupMediaId": 0 }
]

Sample Response3

[ { "code": "failure", "details": " AdGroup Media not found for AdGroup 511114", "adGroupMediaId": 0 }
]

Updated about 1 month ago