List All the Keywords in an Ad Group
URL: POST/api/v1/keywords/list
Request Parameters
| Parameter | Notes | Type | Required | Possible Values |
|---|---|---|---|---|
| advertiserId | ID of the advertiser | integer | Y | Unique numeric identifier |
| Filter[adgroupId] | It will filter and return response for specific adgroupIds listed. If not specified, it will return list of all keywords in the advertiser account | integer | Y | Appropriate ad group IDs |
| startIndex | You can use this parameter to fetch specific number of keywords from a list. This indicates the starting position of the list Note: To return the first ten keywords set startIndex=0 and count=10 | integer | N | Integer value |
| count | You can use this parameter in combination with startIndex to fetch specific number of keywords from a list. Note: To return the first ten keywords set startIndex=0 and count=10 | integer | N | Integer value |
| Filter[lastModifiedDate] | Provide a date to fetch the details of only those keywords which were created/modified on or after the date specified | date | N | Date should be in format: yyyy-MM-dd'T'HH:mm:ss.SSSXXX |
Headers
| Header Name | Description | Required | Values |
|---|---|---|---|
| Authorization | The token will provide you the access to the API. It is same for all advertisers you access through the API. | Y | Please utilize the generated auth_token shared with you at the time of partner onboarding from the Getting Started Guide |
| Content-Type | Format of the message body | Y | application/json |
| WM_CONSUMER.ID | Unique ID for consumer. We will provide you the consumer ID to access the API. It is same for all advertisers you access through the API. | Y | Please use the generated ConsumerId shared with you at the time of partner onboarding. Refer to the Getting Started Guide for more information |
| WM_SEC.AUTH_SIGNATURE | Signature for authentication | Y | Use the signature generator code from Getting Started Guide to generate this value |
| WM_SEC.KEY_VERSION | Key version. We will provide you with the KEY VERSION to access the API. It is same for all advertisers you access through the API. | Y | 1 |
| WM_CONSUMER.intimestamp | Timestamp for which the auth signature is generated. Use Unix epoch format for the timestamp. | Y | Use the signature generator code from Getting Started Guide to generate this value |
Sample Request
curl -X POST \ 'https://developer.api.us.stg.walmart.com/api-proxy/service/display/api/v1/api/v1/keywords/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, "Filter[adgroupId]": 1, "Filter[lastModifiedDate]": "2023-12-01T12:00:00Z ", "startIndex": 0, "count": 0 }'Response
| Element | Description | Type |
|---|---|---|
| adGroupId | ID of the ad group that is part of the above campaign | integer |
| totalResults | Total number of rows returned in the response | integer |
| keywords | Elements of array:
| string |
Sample Response
{ "totalResults": 5, "adGroupId": 1, "keywords": [ { "keywordText": "test keyword 1", "matchType": "BROAD", "isExcluded": false, "reviewStatus": "PENDING REVIEW" }, { "keywordText": "test keyword 2", "matchType": "EXACT", "isExcluded": false, "reviewStatus": "PENDING REVIEW" }, { "keywordText": "test keyword 3", "matchType": "BROAD", "isExcluded": false, "reviewStatus": "PENDING REVIEW" }, { "keywordText": "test keyword 4", "matchType": "BROAD", "isExcluded": false, "reviewStatus": "PENDING REVIEW" }, { "keywordText": "test keyword negative 1", "matchType": "EXACT", "isExcluded": true } ] } Note: The 'reviewStatus' field is not applicable for negative keywords and they can be regarded as automatically approved
Updated 24 days ago