API Reference

Delivery Estimate V2

post
https://developer.api.us.stg.walmart.com/api-proxy/service/display/api/v1/api/v2/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

Simulated start date for ad group scheduling.
Required when schedule is not configured at the ad group level.

date-time

Simulated end date for ad group scheduling.
Required when schedule is not configured at the ad group level.

targeting

Targeting criteria for the ad group. Exactly one of the two structures must be used per request;
mixing structures is not supported.
(1) Expression-based: Nested array element with targeting details (LogicalExpression).
(2) Flattened: include/exclude arrays for full replacement (AdGroupFlattenedTargeting).

Note: If targeting values are set at the ad group level, the forecast is based on the request values, not the original ad group settings.

metric
array of strings
required

The list of metrics you are requesting an estimate for.

metric*
Allowed:
timeframes
array of strings

Specifies the timeframes for which forecasts should be returned.
If not provided, forecasts for all available timeframes will be returned.

Note: If omitted, API returns the delivery estimate for all timeframes.

timeframes
Allowed:
int32

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

int32

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

int32

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

double

Maximum bid value for the ad group.
Required when schedule is not configured at the ad group level.

double

Daily budget of the ad group.
Required when schedule is not configured at the ad group level.

double

Total budget of ad group.
Required when schedule is not configured at the ad group level.

string
enum

Determines pacing of ad delivery.
Required when schedule is not configured at the ad group level.

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 15 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 15 days ago

Did this page help you?