API Reference

Delivery Estimate

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

Use this API to request delivery estimates or winning impressions forecast for a given ad group.

Body Params
integer
required

ID of advertiser.

integer
required

ID the ad group.

integer
required

ID of the campaign.

date-time

Date when the ad group is set to go live.

Note: For more information on regarding limitations of parameters set at campaign level or ad group level, please refer to this documentation.

date-time

The date when ad group ends.

Note: For more information on regarding limitations of parameters set at campaign level or ad group level, please refer to this documentation.

targeting
object

The targeting criteria for the ad group.

Note: For more information on regarding limitations of parameters set at campaign level or ad group level, please refer to this documentation.

metric
array of strings
required

The specified metric you are requesting an estimate for.

Note: impressions is currently the only supported metric.

metric*
Allowed:
integer

The number of times the ad from specific ad group should be shown to the same user in a day.

integer

The number of times the ad from specific ad group should be shown to the same user in a week.

integer

The number of times the ad from specific ad group should be shown to the same user in a month.

double

Starting bid for the ad group.

double

Maximum bid value for the ad group.

Note: For more information on regarding limitations of parameters set at campaign level or ad group level, please refer to this documentation.

double

Daily budget of the ad group.

Note: For more information on regarding limitations of parameters set at campaign level or ad group level, please refer to this documentation.

double

Total budget of ad group.

Note: For more information on regarding limitations of parameters set at campaign level or ad group level, please refer to this documentation.

string
enum

Determines pacing of ad delivery.

Note: For more information on regarding limitations of parameters set at campaign level or ad group level, please refer to this documentation.

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.

Responses

Updated 14 days 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:
application/json

Updated 14 days ago

Did this page help you?