Skip to main content

POST/negative_keyword

Note: This is a Limited ReleaseLimited Release API service that is available only to select partners who have been approved for the eBay Promoted Listings Advanced (PLA) program. For details about how to request access to this program, see Promoted Listings Advanced Access Requests in the Promoted Listings Playbook.
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.

Input

Resource URI (production)

POST https://api.ebay.com/sell/marketing/v1/negative_keyword

URI parameters

This method has no URI parameters.

HTTP request headers

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.

OAuth scope

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.

Request payload

Copy complete valid JSON to clipboard

Request fields

Input container/fieldTypeDescription
adGroupIdstring

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.

Note: You can call the getAdGroups method to retrieve the ad group IDs for a seller.

Required if the negative keyword is being created at the ad group level.

Occurrence: Conditional

campaignIdstring

A unique eBay-assigned ID for a campaign. This ID is generated when a campaign is created.

Required if the negative keyword is being created at the ad group level.

Occurrence: Conditional

negativeKeywordMatchTypeNegativeKeywordMatchTypeEnum

A field that defines the match type for the negative keyword.

Note: Broad matching of negative keywords is not currently supported.
Valid Values:

  • EXACT
  • PHRASE

Occurrence: Required

negativeKeywordTextstring

The negative keyword text.

Occurrence: Required

Output

HTTP response headers

See HTTP response headers for details.

HeaderMeaning
LocationThe 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.

Response payload

This call has no payload.

Response fields

This call has no field definitions.

HTTP status codes

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.

StatusMeaning
201Created
403Forbidden
409Business error
500Internal Server error

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

CodeDomainCategoryMeaning
35001API_MARKETINGAPPLICATIONThere was a problem with an eBay internal system or process. Contact eBay Developer Technical Support for assistance.
35035API_MARKETINGREQUESTThe campaign with campaign id {campaign_id} has ended.
35045API_MARKETINGREQUESTNo campaign found for campaign id {campaign_id}.
35089API_MARKETINGBUSINESSWe are currently testing a premium ads product with a small invite-only group. We will share more information when we are ready to expand.
36210API_MARKETINGREQUESTNo ad group found for ad group id {ad_group_id}.
36219API_MARKETINGREQUESTThe ad group with ad group id {ad_group_id} has been archived.
36323API_MARKETINGREQUEST'negativeKeywordText' {negativeKeywordText} and 'negativeKeywordMatchType' {negativeKeywordMatchType} already exists for this Campaign.
36330API_MARKETINGREQUESTThe provided negative keyword match type is not supported. Valid values are: {negativeKeywordMatchTypeValues}.
36331API_MARKETINGREQUEST'negativeKeywordText' {negativeKeywordText} and 'negativeKeywordMatchType' {negativeKeywordMatchType} already exists for this Ad Group.
36332API_MARKETINGREQUEST'negativeKeywordText' {negativeKeywordText} cannot be more than {maxNegativeKeywordTextLength} characters.
36333API_MARKETINGREQUEST'negativeKeywordText' cannot be null or empty
36334API_MARKETINGREQUEST'negativeKeywordText' contains invalid characters {invalidCharacters}
36335API_MARKETINGREQUESTYou have exceeded the maximum number of negative keyword for an ad group. Only {maxSupportedNegativeKeywordNumber} Ids are supported per ad group.
36336API_MARKETINGREQUEST'negativeKeywordText' {negativeKeywordText} cannot have total number of words more than {maxWordsInNegativeKeyword} words.
36345API_MARKETINGREQUEST'campaignId' and 'adGroupId' are required.
36346API_MARKETINGREQUESTYou have exceeded the maximum number of negative keyword for a campaign. Only {maxSupportedNegativeKeywordNumberCampaign} Ids are supported per campaign.

Warnings

This call has no warnings.

Samples

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.

Sample 1: Create a Negative Keyword

This example creates a negative keyword for a Promoted Listings Advanced (PLA) ad campaign.

Input

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

Output

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.