GET/negative_keyword/{negative_keyword_id}
Note: This method is only available for select partners who have been approved for the priority strategy program. For information about how to request access to this program, refer to Priority Strategy Access Requests in the Promoted Listings Playbook. To determine if a seller qualifies for priority strategy, 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
This method is supported in Sandbox environment. To access the endpoint, just replace the api.ebay.com root URI with api.sandbox.ebay.com
URI parameters
| Parameter | Type | Description |
|---|---|---|
| negative_keyword_id | string | This path parameter specifies the unique identifier for the negative keyword being retrieved. Use the getNegativeKeywords method to retrieve negative keyword IDs. 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/field | Type | Description |
|---|---|---|
| adGroupId | string | An ad group ID that is generated when an ad group is first created and associated with a campaign. Occurrence: Conditional |
| campaignId | string | A unique eBay-assigned ID for a campaign. This ID is generated when a campaign is created. Occurrence: Conditional |
| negativeKeywordId | string | A unique eBay-assigned ID for a negative keyword. This keyword ID will be generated for each successfully created negative keyword. Occurrence: Always |
| negativeKeywordMatchType | NegativeKeywordMatchTypeEnum | A field that defines the match type for the negative keyword.
Occurrence: Always |
| negativeKeywordStatus | NegativeKeywordStatusEnum | A field that defines the status of the negative keyword. Occurrence: Always |
| negativeKeywordText | string | The text for the negative keyword. Occurrence: Always |
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.
| Status | Meaning |
|---|---|
| 200 | Success |
| 403 | Forbidden |
| 404 | Not Found |
| 500 | Internal Server error |
Error codes
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. |
| 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. |
| 36340 | API_MARKETING | REQUEST | No 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.