Create New Ad Group Media
Add video profile for an ad group using this endpoint. You can add it for a specific campaign and advertiser.
URL: POST/api/v1/adGroup/media
Query Parameters
| Parameter | Description | Type | Required | Possible Values |
|---|---|---|---|---|
| adGroupId | The Id of the ad group | integer | Y | Unique numeric identifier representing the ad group |
| mediaId | The unique Id of the media file generated from the notify media upload complete call | integer | Y | Unique numeric identifier |
| campaignId | Id of the campaign this ad group belongs to | integer | Y | Unique numeric identifier |
| advertiserId | Id of the advertiser | integer | Y | Unique numeric identifier |
Headers
| Header Name | Description | Required | Values |
|---|---|---|---|
| Authorization | The token will provide you the access to the API. It is the same for all advertisers you access through the API. | Y | Please utilize the generated auth_token shared with you at the time of partner onboarding from the Getting Started Guide |
| WM_CONSUMER.ID | We will provide you the consumer ID to access the API. It is same for all advertisers you access through the API. | Y | Please 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_SIGNATURE | Auth signature as an API key | Y | Use the signature generator code from Getting Started Guide to generate this value |
| WM_SEC.KEY_VERSION | We will provide you with the KEY VERSION to access the API. It is same for all advertisers you access through the API | Y | 1 |
| WM_CONSUMER.intimestamp | Timestamp for which the auth signature is generated. Use Unix epoch format for the timestamp | Y | Use the signature generator code (Getting Started Guide) to generate this value |
Sample Request 1
curl -X POST \
'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, "mediaId": 611111, "campaignId": 511111, "advertiserId": 611111 }'
Sample Request 2
curl -X POST \
'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": 511112, "mediaId": 611111, "campaignId": 511113, "advertiserId": 611114 }'
Sample Request 3
curl -X POST \
'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": 611113, "mediaId": 611112, "campaignId": 511113, "advertiserId": 611114 }'
Response
| Element | Description | Type |
|---|---|---|
| code | Possible values of response code: success, failure | string |
| details | Details of the error if value of response code is failure | string |
| adGroupMediaId | ID of the video creative attached to ad group for specific advertiser | integer |
Sample Response 1
[ { "code": "failure", "details": "Ad group already has media defined, please update existing instead of defining new one.", "adGroupMediaId": 0 }
]
Sample Response 2
[ { "code": "failure", "details": "MediaDetails not found.", "adGroupMediaId": 0 }
]
Sample Response 3
[ { "code": "success", "details": "", "adGroupMediaId": 611114 }
]
Updated about 1 month ago