📘
URL: GET /api/v1/negative_keywords

Query Parameters

Parameter	Notes	Type	Required	Possible Values
campaignId	The ID of the campaign to which the negative keyword is added	integer	Y	A valid campaign ID
advertiserId	The ID of the advertiser	integer	Y	A valid advertiser ID

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
WM_CONSUMER.ID	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	Auth signature as an API key.	Y	Use the signature generator code from Getting Started Guide to generate this value
WM_SEC.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
Content-Type	Format of the message body	Y	application/json

Sample Request 1

curl -X GET \ "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/negative_keywords?campaignId=600001&advertiserId=500003" \
--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' \

Sample Request 2

curl -X GET \ "<https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/negative_keywords?campaignId=600001&advertiserId=500003" \
--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
adGroupId	The ID of the ad group belonging to campaign in question	string
keywordId	ID of the keyword	string
negativeMatchType	The matching strategy under which the retrieved negative keyword is falling: `negativeExact`: Your ads don't show against keywords/search queries that exactly matches the bidded keyword(s) `negativePhrase`: Your ads don't show against keywords/search queries that includes the specified phrase in the bidded keyword(s)	string
state	The current state of the negative keyword resource. There can be following values of state: `enabled` `paused` `archived`	string
keywordText	The text of the retrieved keyword	string
campaignId	ID of the campaign	integer

Sample Response 1

[ { "campaignId": 600001, "keywordId": 600005, "adGroupId": 500001, "keywordText": "keyword 1", "negativeMatchType": "negativeExact", "state": "enabled" }
]

Sample Response 2

[ { "campaignId": 600001, "keywordId": 600005, "adGroupId": 500001, "keywordText": "keyword 2", "negativeMatchType": "negativePhrase", "state": "enabled" } ]