Pricing Templates

POST /ad_campaign/{campaign_id}/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 creates keywords using a specified campaign ID for an existing PLA campaign.

In the request, supply the campaign_id as a path parameter.

Call the suggestKeywords method to retrieve a list of keyword ideas to be targeted for PLA campaigns, and call the getCampaigns method to retrieve a list of current campaign IDs for a seller.

Servers

https://api.ebay.com{basePath}

Path parameters

Name	Type	Required	Description
`campaign_id`	String	Yes	A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created. Note: You can retrieve the campaign IDs for a specified seller using the getCampaigns method.

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
`keywordText`	String	No	Input the keyword into this field.
`bid`	Object	No	A complex type that describes the value of a monetary amount as represented by a global currency.
`bid.value`	String	No	The monetary amount in the specified currency. Required in the amount type.
`bid.currency`	String	No	The base currency applied to the value field to establish a monetary amount. The currency is represented as a 3-letter ISO 4217 currency code. For example, the code for the Canadian Dollar is `CAD`. Default: The default currency of the eBay marketplace that hosts the listing. For implementation help, refer to eBay API documentation
`adGroupId`	String	No	This adGroupId is created when an ad group is first created and associated with a campaign. This is the ad group that the corresponding keyword will be added to. This ad group must be a part of the campaign that is specified in the call URI. Note: You can call the getAdGroups method to retrieve the ad group IDs for a seller, and getKeywords to retrieve the keyword IDs for a seller's keywords.
`matchType`	String	No	A field that defines the match type for the keyword. Valid Values: `BROAD` `EXACT` `PHRASE` For implementation help, refer to eBay API documentation

How to start integrating

Add HTTP Task to your workflow definition.
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.
Click Test request to test run your request to the API and see the API's response.

All third party trademarks (including logos and icons) are the property of their respective owners, which do not sponsor, authorize, or endorse this website.

Pricing Templates Integrations Blog Contact Us Help

Terms of Service Privacy Policy