GET /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 can be used to retrieve all of the negative keywords for ad groups in PLA campaigns that use the Cost Per Click (CPC) funding model.

The results can be filtered using the campaign_ids, ad_group_ids, and negative_keyword_status query parameters.

Call the getCampaigns method to retrieve a list of current campaign IDs for a seller.

Servers

Query parameters

Name Type Required Description
campaign_ids String No

A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created.

This query parameter is used if the seller wants to retrieve the negative keywords from a specific campaign. The results might not include these campaign IDs if other search conditions exclude them.

Note: Currently, only one campaign ID value is supported for each request.

limit String No

The number of results, from the current result set, to be returned in a single page.

ad_group_ids String No

A comma-separated list of ad group IDs.

This query parameter is used if the seller wants to retrieve the negative keywords from one or more specific ad groups. The results might not include these ad group IDs if other search conditions exclude them.

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

Required if the search results must be filtered to include negative keywords created at the ad group level.

negative_keyword_status String No

A comma-separated list of negative keyword statuses.

This query parameter is used if the seller wants to filter the search results based on one or more negative keyword statuses.

offset String No

The number of results that will be skipped in the result set. This is used with the limit field to control the pagination of the output.

For example, if the offset is set to 0 and the limit is set to 10, the method will retrieve items 1 through 10 from the list of items returned. If the offset is set to 10 and the limit is set to 10, the method will retrieve items 11 through 20 from the list of items returned.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.