List Ad Groups
URL: POST/api/v1/adGroups/list
Request Parameters
| Parameter | Parameter Description | Type | Required | Possible Values |
|---|---|---|---|---|
| advertiserId | ID of advertiser | integer | Y | Advertiser ID for which the ad group needs to be updated for delivery status |
| campaignId | ID of the campaign | integer | Y | Unique numeric identifier. |
| Filter[name] | A valid ad group name with which the desired ad group can be searched in the absence of ad group ID | string | N | Provide an ad group name to search the relevant ad group by name instead of ad group ID |
| Filter[status] | Filter based on the ad group status | string | N | Enum values: • draft • live • scheduled • paused • completed • archived |
| Filter[lastModifiedDate] | Provide a date to fetch only those ad groups which were modified on or after that date | string | N | Date format must follow ISO 8601 time zone format: • yyyy-MM-dd'T'HH:mm:ss.SSSXXX |
| Filter[adGroupId] | ID of the ad groups you wish to list details for. Note: if no adGroupId is specified, all ad groups in the campaign will be returned | integer | N | Unique numeric identifier. Maximum list size is 25 entries. |
| startIndex | 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 | integer | N | Integer value Example: To return the first ten ad groups, set startIndex=0 and count=10 |
| count | Defines the total number of ad groups to be returned. You can use this parameter in combination with startIndex, to fetch specific number of ad groups from a list. | integer | N | Integer value Note: defaultCount=100, maxCount = 100, minCount = 1 Example: To return the first ten adGroups, set startIndex=0 and count=10 |
Sample Request
curl -X POST \ 'https://developer.api.us.stg.walmart.com/api-proxy/service/display/api/v1/api/v1/adGroups/list' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer <auth_token>'
--header 'WM_SEC.AUTH_SIGNATURE: **************' \ --header 'WM_SEC.KEY_VERSION: 1' \ --header 'WM_CONSUMER.ID: adfwe-v23-faasd2r-afs-asdfqeff' \ --header 'WM_CONSUMER.intimestamp: 1565309779' \ --data ' { "advertiserId": 1, "campaignId": 1, "Filter[name]": ["string"], "Filter[status]": "string", "Filter[lastModifiedDate]": "string", "Filter[adGroupId]": [1, 2], "startIndex": 0, "count": 10 } ' Response
| Element | Description | Type |
|---|---|---|
| totalResults | Total number of rows returned in the response | integer |
Attributes of the campaigns returned by the API. The following attributes are listed:
|
Sample Response
{ "totalResults": 2, "response": [ { "campaignId": 1, "adGroupId": 1, "adGroupExtId": 1, "name": "string", "status": "string", "startDate": "string", "endDate": "string", "budgetType": "string", "deliverySpeed": "string", "dailyBudget": 0, "totalBudget": 0, "rateType": "string", "frequencyCapDay": 0, "frequencyCapWeek": 0, "frequencyCapMonth": 0, "baseBid": 0, "maxBid": 0, "targeting": { "and": [ { "behavioral": [ { "audienceType": "CATEGORY", "attribute": "HISTORICAL", "id": 1, "name": "tropicana", "mappingType": "PRODUCT_CATEGORY" }, { "audienceType": "CATEGORY", "attribute": "HISTORICAL", "id": 5, "name": "sprite", "mappingType": "PRODUCT_FAMILY" } ] }, { "geoTargets": [ { "id": 2, "name": "Alabama", "locationType": "STATE" }, { "id": 3, "name": "Alaska", "locationType": "STATE" }, { "id": 10, "name": "Abbeville", "locationType": "CITY" } ] } ] }, "creationDate": "string", "lastUpdatedDate": "string" }, { "campaignId": 1, "adGroupId": 2, "adGroupExtId": 2, "name": "string", "status": "string", "startDate": "string", "endDate": "string", "budgetType": "string", "deliverySpeed": "string", "dailyBudget": 0, "totalBudget": 0, "rateType": "string", "frequencyCapDay": 0, "frequencyCapWeek": 0, "frequencyCapMonth": 0, "baseBid": 0, "maxBid": 0, "targeting": { "and": [ { "behavioral": [ { "audienceType": "CATEGORY", "attribute": "HISTORICAL", "id": 1, "name": "tropicana", "mappingType": "PRODUCT_CATEGORY" }, { "audienceType": "CATEGORY", "attribute": "HISTORICAL", "id": 5, "name": "sprite", "mappingType": "PRODUCT_FAMILY" } ] }, { "geoTargets": [ { "zipCode": "35004" } ] } ] }, "creationDate": "string", "lastUpdatedDate": "string" } ]
} Updated 10 days ago