Home
POST/negative_keyword
Note: This method is only available for select partners who have been approved for the eBay Promoted Listings Advanced (PLA) program. For information about how to request access to this program, refer to Promoted Listings Advanced Access Requests in the Promoted Listings Playbook. To determine if a seller qualifies for PLA, use the getAdvertisingEligibility method in Account API.
This method adds a negative keyword to an existing ad group in a PLA campaign that uses the Cost Per Click (CPC) funding model.
Specify the campaignId and adGroupId in the request body, along with the negativeKeywordText and negativeKeywordMatchType.
Call the getCampaigns method to retrieve a list of current campaign IDs for a specified seller.
This method is supported in Sandbox environment. To access the endpoint, just replace the api.ebay.com
root URI with api.sandbox.ebay.com
This method has no URI parameters.
All requests made to eBay REST operations require you to provide the Authorization
HTTP header for authentication authorization.
In addition, this method requires you to include the Content-Type header and its value should be set to "application/json". See HTTP request headers- opens rest request components page for details.
This request requires an access token created with the authorization code grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):
https://api.ebay.com/oauth/api_scope/sell.marketing
See OAuth access tokens for more information.
Input container/field | Type | Description |
---|---|---|
adGroupId | string | This adGroupId is created when an ad group is first created and associated with a campaign. This is the ad group to which the corresponding negative keyword will be added. Occurrence: Conditional |
campaignId | string | A unique eBay-assigned ID for a campaign. This ID is generated when a campaign is created. Occurrence: Conditional |
negativeKeywordMatchType | NegativeKeywordMatchTypeEnum | A field that defines the match type for the negative keyword.
Occurrence: Required |
negativeKeywordText | string | The negative keyword text. Occurrence: Required |
See HTTP response headers for details.
Header | Meaning |
---|---|
Location | The location response header contains the URI of the newly created negative keyword. The URI includes the newly created negativeKeywordId , which you can use to reference the negative keyword. |
This call has no payload.
This call has no field definitions.
This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.
Status | Meaning |
---|---|
201 | Created |
403 | Forbidden |
409 | Business error |
500 | Internal Server error |
For more on errors, plus the codes of other common errors, see Handling errors.
Code | Domain | Category | Meaning |
---|---|---|---|
35001 | API_MARKETING | APPLICATION | There was a problem with an eBay internal system or process. Contact eBay Developer Technical Support for assistance. |
35035 | API_MARKETING | REQUEST | The campaign with campaign id {campaign_id} has ended. |
35045 | API_MARKETING | REQUEST | No campaign found for campaign id {campaign_id}. |
35089 | API_MARKETING | BUSINESS | We are currently testing a premium ads product with a small invite-only group. We will share more information when we are ready to expand. |
36210 | API_MARKETING | REQUEST | No ad group found for ad group id {ad_group_id}. |
36219 | API_MARKETING | REQUEST | The ad group with ad group id {ad_group_id} has been archived. |
36323 | API_MARKETING | REQUEST | 'negativeKeywordText' {negativeKeywordText} and 'negativeKeywordMatchType' {negativeKeywordMatchType} already exists for this Campaign. |
36330 | API_MARKETING | REQUEST | The provided negative keyword match type is not supported. Valid values are: {negativeKeywordMatchTypeValues}. |
36331 | API_MARKETING | REQUEST | 'negativeKeywordText' {negativeKeywordText} and 'negativeKeywordMatchType' {negativeKeywordMatchType} already exists for this Ad Group. |
36332 | API_MARKETING | REQUEST | 'negativeKeywordText' {negativeKeywordText} cannot be more than {maxNegativeKeywordTextLength} characters. |
36333 | API_MARKETING | REQUEST | 'negativeKeywordText' cannot be null or empty |
36334 | API_MARKETING | REQUEST | 'negativeKeywordText' contains invalid characters {invalidCharacters} |
36335 | API_MARKETING | REQUEST | You have exceeded the maximum number of negative keyword for an ad group. Only {maxSupportedNegativeKeywordNumber} Ids are supported per ad group. |
36336 | API_MARKETING | REQUEST | 'negativeKeywordText' {negativeKeywordText} cannot have total number of words more than {maxWordsInNegativeKeyword} words. |
36345 | API_MARKETING | REQUEST | 'campaignId' and 'adGroupId' are required. |
36346 | API_MARKETING | REQUEST | You have exceeded the maximum number of negative keyword for a campaign. Only {maxSupportedNegativeKeywordNumberCampaign} Ids are supported per campaign. |
This call has no warnings.
New to making API calls? Please see Making a Call.
Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.
This example creates a negative keyword for a Promoted Listings Advanced (PLA) ad campaign.
The inputs for this sample are the campaignId, adGroupId, negativeKeywordText, and negativeKeywordMatchType, all passed in the request body.
POSThttps://api.ebay.com/sell/marketing/v1/negative_keyword
A successful call returns the HTTP status code 201 Created. In addition, the response includes a location response header that contains the URI for the newly-created negative keyword.
This method has no response payload.