POST /ad_campaign/{campaign_id}/ad_group/{ad_group_id}/suggest_keywords
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 allows sellers to retrieve a list of keyword ideas to be targeted for Promoted Listings campaigns.
Servers
- https://api.ebay.com{basePath}
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
ad_group_id |
String | Yes |
The ID of the ad group for which the keyword suggestions will be provided. |
campaign_id |
String | Yes |
A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created. |
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 |
|---|---|---|---|
exclusions[] |
Array | No |
A field used to indicate that the keywords already selected by sellers for the specified listing IDs should be filtered out of the response, and only new and unique keyword recommendations shall be returned. |
additionalInfo[] |
Array | No |
A field used to indicate whether additional information and insight data shall be provided for suggested keywords. |
listingIds[] |
Array | No |
A set of comma-separated listing IDs in the paginated collection. |
matchType |
String | No |
A field that defines the match type for the keyword.
|
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.