List All the Keywords in a Campaign
Description
List all the keywords that are part of a campaign.
URL: GET/api/v1/keywords
Query Parameters
| Parameter | Notes | Type | Required | Possible Values |
|---|---|---|---|---|
| campaignId | ID of the campaign | integer | Y | Unique numeric identifier |
Sample Request
curl -X GET \
'https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/keywords?campaignId=3897' \
--header 'Authorization: Bearer <auth_token>' \ --header 'accept: application/json' \
--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' \
Response
| Element | Description | Type |
|---|---|---|
| campaignId | ID of the Campaign | integer |
| adGroupId | ID of the ad group that is part of the above campaign | integer |
| keywordId | ID of the key word | integer |
| state | State of the keyword. Values can be: enabled, paused, archived | string |
| keywordText | Text that defines the keyword | string |
| matchType | Matching criteria for the keywords. Values can be: exact, phrase, broad | string |
| bid | Maximum cost per click for the keyword in dollars | double |
| status | Status of the keyword added in the campaign. Values can be: approved,pending, rejected Note: The “status” for each new or re-enabled keyword be set to “pending” by default | string |
Sample Response
[ { "campaignId": 1234, "adGroupId": 231, "keywordId": 567, "state": "enabled", "keywordText": "string", "matchType": "exact", "bid": 0.6, "status": " approved " }
]
Updated 10 months ago