suggestKeywords: eBay Marketing API | eBay Developers Program

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 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 allows sellers to retrieve a list of keyword ideas to be targeted for Promoted Listings campaigns.

Input

Resource URI

POST https://api.ebay.com/sell/marketing/v1/ad_campaign/{campaign_id}/ad_group/{ad_group_id}/suggest_keywords

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
campaign_id	string	This path parameter specifies the unique eBay-assigned identifier of the ad campaign for which keyword suggestions will be provided. Use the getCampaigns method to retrieve campaign IDs. Occurrence: Required
ad_group_id	string	This path parameter specifies the unique identifier of the ad group for which the keyword suggestions will be provided. Use the getAdGroups method to retrieve ad group IDs. Occurrence: Required

HTTP request headers

All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.

The table below shows additional HTTP request headers that are either required, conditionally required, or strongly recommended for this method. Other standard HTTP request headers- opens rest request components page (not in this table) can also be used, but they are optional.

Header	Type	Description
Content-Type	string	This header indicates the format of the request body provided by the client. Its value should be set to application/json. For more information, refer to HTTP request headers. Occurrence: Required

Header

Type

Description

Content-Type

string

This header indicates the format of the request body provided by the client. Its value should be set to application/json.

For more information, refer to HTTP request headers.

Occurrence: Required

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

See OAuth access tokens for more information.

Request payload

Copy complete valid JSON to clipboard

{ /* TargetedKeywordRequest */

"additionalInfo" : [

"AdditionalInfoEnum : [KEYWORD_INSIGHTS]"

"exclusions" : [

"ExclusionsEnum : [ADOPTED_KEYWORDS]"

"listingIds" : [

"string"

"matchType" : "MatchTypeEnum : [BROAD,EXACT,PHRASE]"

}

Request fields

Input container/field	Type	Description
additionalInfo	array of AdditionalInfoEnum	A field used to indicate whether additional information and insight data shall be provided for suggested keywords. Use this array to retrieve keyword insights, including active seller count and search volume. Valid Value: `KEYWORD_INSIGHTS` Occurrence: Optional
exclusions	array of ExclusionsEnum	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. Valid Value: `ADOPTED_KEYWORDS` Occurrence: Optional
listingIds	array of string	A set of comma-separated listing IDs for the specific listings you wish to retrieve suggested keywords. Maximum number of listings requested: 300 Occurrence: Optional
matchType	MatchTypeEnum	A field that defines the match type for the keyword. Valid Values: `BROAD` `EXACT` `PHRASE` Occurrence: Required

Output

HTTP response headers

This call has no response headers.

Response payload

Copy complete valid JSON to clipboard

{ /* TargetedKeywordsPagedCollection */

"suggestedKeywords" : [

{ /* SuggestedKeywords */

"additionalInfo" : [

{ /* AdditionalInfo */

"infoType" : "AdditionalInfoEnum : [KEYWORD_INSIGHTS]",

"metrics" : [

{ /* AdditionalInfoData */

"metricKey" : "MetricEnum : [ACTIVE_SELLER_COUNT,SEARCH_VOLUME]",

"value" : "string"

}

]

}

"keywordText" : "string",

"matchType" : "MatchTypeEnum : [BROAD,EXACT,PHRASE]"

}

]

}

Response fields

Output container/field	Type	Description
suggestedKeywords	array of SuggestedKeywords	A list of suggested keywords in the paged collection. Note: A relevancy check with items already present in the ad-group is performed even if item IDs associated with the ad-group are not explicitly passed in the request. Occurrence: Conditional
suggestedKeywords.additionalInfo	array of AdditionalInfo	A container for the additional information and compiled insight data for suggested keywords. Occurrence: Conditional
suggestedKeywords.additionalInfo.infoType	AdditionalInfoEnum	The type of additional information provided for the suggested keyword. Valid Value: `KEYWORD_INSIGHTS` Occurrence: Conditional
suggestedKeywords.additionalInfo.metrics	array of AdditionalInfoData	A list of additional data provided for the suggested keyword. Occurrence: Conditional
suggestedKeywords.additionalInfo.metrics.metricKey	MetricEnum	The metric used to provide additional information for the suggested keyword. Valid Values: `ACTIVE_SELLER_COUNT` `SEARCH_VOLUME` Occurrence: Conditional
suggestedKeywords.additionalInfo.metrics.value	string	The data provided for the specified metric. Note: All metric data is compiled for the marketplace associated with the specified campaign ID. Occurrence: Conditional
suggestedKeywords.keywordText	string	The text for the keyword. Occurrence: Always
suggestedKeywords.matchType	MatchTypeEnum	A field that defines the match type for the keyword. Valid Values: `BROAD` `EXACT` `PHRASE` Occurrence: Conditional

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
400	Bad Request
404	Not Found
409	Business error
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.
35013	API_MARKETING	REQUEST	The listing Id {listingId} is not valid.
35041	API_MARKETING	REQUEST	The 'marketplaceId' is required.
35045	API_MARKETING	REQUEST	No campaign found for campaign id {campaign_id}.
35051	API_MARKETING	BUSINESS	'marketplaceId' {marketplaceId} is not supported. Promoted Listings is supported only on these marketplaces: {supportedMarketplaces}.
35054	API_MARKETING	BUSINESS	The listing Id {listingId} was created on a different marketplace than the campaign. The listing and campaign must reside on the same marketplace.
35057	API_MARKETING	BUSINESS	The listing Id {listingId} does not belong to the seller making this call.
35068	API_MARKETING	BUSINESS	You have exceeded the maximum number of listing Ids. Only {maxSupportedNumber} listings are supported per call.
36210	API_MARKETING	REQUEST	No ad group found for ad group id {ad_group_id}.
36301	API_MARKETING	REQUEST	The provided keyword match type is not supported. Valid values are: {matchTypeValues}.
70006	API_MARKETING	REQUEST	The provided exclusion is not supported. Valid values are {supportedExclusions}.
70007	API_MARKETING	REQUEST	The provided additionalInfo is not supported. Valid values are {supportedAdditionalInfo}.

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: Retreive Keyword Suggestions

This example retrieves a list of keyword ideas for listings to be targeted for Promoted Listings campaigns.

Input

The inputs for this sample are the campaign_id and ad_group_id path parameters, as well as the listingIds, matchType, additionalInfo, and exclusions fields passed in the request body.

POSThttps://api.ebay.com/sell/marketing/v1/ad_campaign/1********4/ad_group/1********3/suggest_keywords

Output

If the call is successful, keyword suggestions matching the specified criteria are returned.