API Reference

Get Creative Preview for AdUnit

post
https://developer.api.us.stg.walmart.com/api-proxy/service/display/api/v1/api/v1/creatives//preview/

This endpoint provides image-only previews for a specific ad unit, supporting both banner and video creatives. Video creatives previews are images.

Path Params
uuid
required

The ID of the creative.

string
required

The name of the ad unit for which the preview is requested.

Body Params
int64
required

The ID of the specific advertiser.

string
enum

State of preview for a creative.

Allowed:
string
enum

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.

Allowed:
string
enum

This option enables the selection of single or double resolution for the preview file.

Allowed:
Headers
string
required

Auth signature as an API key.

string
required

We will provide you the consumer ID to access the API. It is same for all advertisers you access through the API.

integer
required

We will provide you with the KEY VERSION to access the API.
It is same for all advertisers you access through the API. The allowed value is 1.

integer
required

Timestamp for which the auth signature is generated. Use Unix epoch format.

string
required

This is bearer token.
The token will provide you the access to the API. It is same for all advertisers you access through the API.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated about 14 hours ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
image/jpeg
application/json

Updated about 14 hours ago

Did this page help you?