POST /bulk_create_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 negative keywords, in bulk, 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.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
requests[] Array No

This array is used to pass in multiple negative keywords for one or more ad groups that belong to a campaign that uses the Cost Per Click (CPC) funding model.

requests[].negativeKeywordText String No

The negative keyword text.

requests[].adGroupId String No

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.

requests[].campaignId String No

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.

requests[].negativeKeywordMatchType String No

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
For implementation help, refer to eBay API documentation

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.