List AdGroup

post

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

This API allows you to fetch all the available ad group. Provide the advertiser unique ID in the request to fetch the details.

Body Params

advertiserId

integer

required

The ID of the advertiser for whom the ad groups should be returned.

campaignId

integer

required

The ID of the campaign for which the ad groups should be returned.

startIndex

integer

You can use this parameter in combination with count, to fetch specific number of ad groups from a list.
This indicates the starting position of the list.
The default value is 0.

count

integer

Defines the total number of ad groups to be returned.
This parameter is used in combination with startIndex to fetch specific number of ad groups from a list.
The default value is 100. The minimum value is 1. The maximum value is 100.

Filter[adGroupId]

array of integers

ID of the ad groups you wish to list details for.
Maximum list size is 25 entries.

Note: If no adGroupId is specified, all ad groups in the campaign will be returned.

Filter[adGroupId]

Filter[status]

string

enum

Filter based on the ad group status.

Allowed:

Filter[name]

array of strings

A valid ad group name with which the desired ad group can be searched in the absence of ad group ID.

Filter[name]

Filter[lastModifiedDate]

date-time

Provide a date to fetch only those ad groups which were modified on or after that date.

Headers

WM_SEC.AUTH_SIGNATURE

string

required

Auth signature as an API key.

WM_CONSUMER.ID

string

required

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

WM_SEC.KEY_VERSION

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.

WM_CONSUMER.intimestamp

integer

required

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

Authorization

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.

x-targeting-format

string

enum

Controls the format of the targeting object in the response. This header is case-insensitive.
If not passed, defaults to the expression-based format (Nested array element with targeting details).
EXPRESSION: returns targeting in the expression-based format (Nested array element with targeting details).
FLAT: Returns targeting in the flattened format (include/exclude arrays).

Allowed:

Responses

200successful operation

400Invalid request parameters supplied

401Unauthorized

403Forbidden

500Internal Server Error