List Targeting

post

https://developer.api.us.stg.walmart.com/api-proxy/service/display/api/v1/api/v1/targeting/list

Body Params

advertiserId

int64

required

ID of the advertiser.

searchText

string

Appropriate string of text to get details of specific targets or audiences.

startIndex

int32

You can use this parameter to fetch specific number of targets or audiences from the available list.
This indicates the starting position of the list.

Note: To return the first ten contextual or behavioral targeting entries set startIndex to 0 and count to 10.

count

int32

You can use this parameter in combination with startIndex to fetch specific number of targets or audiences from the available list.
The maximum value of count is 100 and the minimum value is 1. The default value is 100.

Note: To return the first ten contextual or behavioral targeting entries set startIndex to 0 and count to 10.

Filter[id]

array of int64s

Returns details of specific targets or audiences based on the given ID.

Filter[id]

Filter[tactic]

string

enum

required

List of available targets of the specific tactic.

Allowed:

Filter[audienceType]

string

enum

Returns response for specific audience type.

Conditional:

When Filter[tactic] is CONTEXTUAL audienceType is not required.
When Filter[tactic] is BEHAVIORAL audienceType is optional only if Filter[id] or searchText is provided; otherwise, Filter[audienceType] is required.

Note: Only applicable for audience targeting.

Allowed:

Filter[attribute]

string

enum

Returns response for a specific audience attribute.

Conditional:

When Filter[tactic] is CONTEXTUAL Filter[attribute] is not required.
When Filter[tactic] is BEHAVIORAL and if audienceType is CUSTOM Filter[attribute] is not required.
When Filter[tactic] is BEHAVIORAL and when Filter[attribute] is optional only if Filter[id] or searchText is provided; otherwise, Filter[attribute] is required.

Note: Only applicable for audience targeting.

Responses

400

Invalid request parameters supplied

500

Internal Error

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200successful operation