List all the Ad Group Media
Retrieve the video creative uploaded to ad group for a specific campaign
URL: GET/api/v1/adGroup/media
Query Parameters
| Parameter | Description | Type | Required | Possible Values |
|---|---|---|---|---|
| adGroupId | The ID of the ad group for which the media should be returned | integer | Y | Unique numeric identifier |
| campaignId | The ID of the campaign tied to this ad group | 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
curl -X GET \
'https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/adGroup/media?campaignId=12000&adGroupId=12001' \ --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' \
Response
| Element | Description | Type |
|---|---|---|
| campaignId | ID of the campaign associated with the respective ad group | integer |
| adGroupId | ID of the ad group | integer |
| adGroupMediaId | Id of the video creative uploaded to the ad group | integer |
| mediaId | The unique Id of the media file generated from the notify media upload complete call | integer |
| reviewStatus | Specified status of campaign in a review cycle. Possible values of status are: pending, approved, rejected | string |
| reviewReason | If value of reviewStatus is rejected, you will receive the reason for why it was rejected. Note: Value of reviewReason is “null” when reviewStatus is pending. | string |
| status | Status of media uploaded to ad group. The values of status are: enabled, disabled default value of status is enabled because only one video profile is allowed per ad group | string |
Sample Response
[ { "campaignId": 511112, "adGroupId": 511111, "adGroupMediaId": 611111, "mediaId": 611111, "reviewStatus": "rejected", "reviewReason": "This is a 2000 character long comment This is a 2000 character long comment", "status": "enabled" }
]
Updated about 1 month ago