Skip to main content

GET/negative_keyword/{negative_keyword_id}

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 retrieves details on a specific negative keyword.

In the request, specify the negative_keyword_id as a path parameter.

Input

Resource URI (production)

GET https://api.ebay.com/sell/marketing/v1/negative_keyword/{negative_keyword_id}

URI parameters

ParameterTypeDescription
negative_keyword_idstringThe unique identifier for the negative keyword.

This value is returned in the Location response header from the createNegativeKeyword method.

Occurrence: Required

HTTP request headers

All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.

All other standard RESTful request headers are optional. For more information on standard RESTful request headers, see the HTTP request headers- opens rest request components page table.

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.readonly

https://api.ebay.com/oauth/api_scope/sell.marketing

See OAuth access tokens for more information.

Request payload

This call has no payload.

Request fields

This call has no field definitions.

Output

HTTP response headers

This call has no response headers.

Response payload

Response fields

Output container/fieldTypeDescription
adGroupIdstring

An ad group ID that is generated when an ad group is first created and associated with a campaign.

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

Occurrence: Conditional

campaignIdstring

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

Occurrence: Conditional

negativeKeywordIdstring

A unique eBay-assigned ID for a negative keyword. This keyword ID will be generated for each successfully created negative keyword.

Occurrence: Required

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

negativeKeywordStatusNegativeKeywordStatusEnum

A field that defines the status of the negative keyword.

Occurrence: Required

negativeKeywordTextstring

The text for the negative keyword.

Occurrence: Required

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
200Success
403Forbidden
404Not Found
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.
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.
36340API_MARKETINGREQUESTNo negative keyword found for negative keyword id {negativeKeywordId}.

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: Retrieve Negative Keyword Details

This example retrieves the details for a negative keyword, based on the negative keyword ID.

Input

The input for this sample is the negative_keyword_id path parameter.

GEThttps://api.ebay.com/sell/marketing/v1/negative_keyword/1********5

Output

If the call is successful, the details for the specified negative keyword are returned.