Retrieve Creative Preview Image for each AdUnit
Retrieve preview for a specific adUnit of a creative. The preview may not be available for creatives produced by Walmart or cloned from a creative that was produced by Walmart.
Note: You can download the preview image for each adUnit once the "response" in preview status is COMPLETED
URL: POST/api/v1/creatives/:creativeId/preview/:adUnitName
Path Parameters
| Parameter | Description | Type | Required | Possible Values |
|---|---|---|---|---|
| creativeId | The ID of the creative | string | Y | A valid creative ID |
| adUnitName | name of ad unit | string | Y | marqueeDesktop, marqueeApp, skylineDesktop, skylineApp, brandboxDesktop, brandboxApp, galleryDesktop, galleryApp, galleryDWebMini, marqueeTablet |
Request Parameters
| Parameter | Description | Type | Required | Possible Values |
|---|---|---|---|---|
| advertiserId | The ID of the specific advertiser | integer | Y | A valid advertiser ID |
| type | state of preview for a creative | string | Y |
|
| badgeType | If badgeType is specified, the preview will render the corresponding badge, provided that the account has rollback badge enabled and the ad unit supports badge rendering. If badgeType is not included, the preview will omit the badge entirely. | enum | N | Values:
|
Headers
| Header Name | Description | Required | Values |
|---|---|---|---|
| Authorization | The token will provide you the access to the API. It is 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 more information |
| 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 from Getting Started Guide to generate this value |
Sample Request
curl -X POST \
--location 'https://developer.api.us.stg.walmart.com/api-proxy/service/display/api/v1/api/v1/creatives/aaaa3333-aa33-aa33-aa33-aaaaaa333333/preview/marqueeDesktop' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer aaaa0000-aa00-aa00-aa00-aaaaaa000000' \
--header 'WM_CONSUMER.ID: aaaa1111-aa11-aa11-aa11-aaaaaa111111' \
--header 'WM_SEC.KEY_VERSION: 1' \
--header 'WM_CONSUMER.INTIMESTAMP: 0000000000000' \
--header 'WM_SEC.AUTH_SIGNATURE: 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000==' \
--data '{ "advertiserId": 00000000, "type": "refreshed", "badgeType":ROLLBACK }' \
--output filename.jpg Response:
jpeg image file of screenshot for ad unit will be returned
Creative Submission and Status Generation
- Submit Creative
URL: POST/api/v1/creatives/ submit - Retrieve Creative Submission Status
URL: POST/api/v1/creatives/submit/status
Updated 12 days ago