Skip to main content

POST/ad_campaign/{campaign_id}/ad_group/{ad_group_id}/suggest_bids

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 the suggested bids for input keywords and match type.

Input

Resource URI (production)

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

URI parameters

ParameterTypeDescription
campaign_idstringA 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.

Occurrence: Required

ad_group_idstringThe ID of the ad group containing the keywords for which the bid suggestions will be provided.

Occurrence: Required

HTTP request headers

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

In addition, this method requires you to include the Content-Type header and its value should be set to "application/json". See HTTP request headers- opens rest request components page for details.

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

Request fields

Input container/fieldTypeDescription
keywordsarray of KeywordRequest

A list of keywords in the paginated collection.

Maximum number of keywords: 500

Occurrence: Optional

keywords.keywordTextstring

The text of the keyword. Keywords are not case sensitive and compound words can be used without additional encoding (for example, tennis ball).

Maximum number of characters: 100

Maximum number of words: 10

Occurrence: Required

keywords.matchTypeMatchTypeEnum

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

Response fields

Output container/fieldTypeDescription
suggestedBidsarray of SuggestedBids

A list of bids in the paginated collection.

Occurrence: Conditional

suggestedBids.keywordTextstring

The text for the keyword.

Occurrence: Required

suggestedBids.matchTypeMatchTypeEnum

A field that defines the match type for the keyword.

Valid Values:

  • BROAD
  • EXACT
  • PHRASE

Occurrence: Required

suggestedBids.proposedBidProposedBid

The suggested bid associated with the keyword.

Occurrence: Conditional

suggestedBids.proposedBid.currencyCurrencyCodeEnum

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.

Occurrence: Required

suggestedBids.proposedBid.rangeEndstring

The end of the range specified for the bid.

Occurrence: Required

suggestedBids.proposedBid.rangeStartstring

The start of the range specified for the bid.

Occurrence: Required

suggestedBids.proposedBid.valuestring

The value of the proposed bid.

Occurrence: Required

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.

StatusMeaning
200Success
400Bad Request
404Not Found
409Business error
500Internal Server error

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

CodeDomainCategoryMeaning
35001API_MARKETINGAPPLICATIONThere was a problem with an eBay internal system or process. Contact eBay Developer Technical Support for assistance.
35041API_MARKETINGREQUESTThe 'marketplaceId' is required.
35045API_MARKETINGREQUESTNo campaign found for campaign id {campaign_id}.
35051API_MARKETINGBUSINESS'marketplaceId' {marketplaceId} is not supported. Promoted Listings is supported only on these marketplaces: {supportedMarketplaces}.
35091API_MARKETINGREQUESTYou have exceeded the maximum number of requests. Only {maxSupportedNumber} are supported per call.
36210API_MARKETINGREQUESTNo ad group found for ad group id {ad_group_id}.
36301API_MARKETINGREQUESTThe provided keyword match type is not supported. Valid values are: {matchTypeValues}.
36304API_MARKETINGREQUESTThe keywordText {keywordText} cannot be more than {maxKeywordTextLength} characters.
36311API_MARKETINGREQUESTThe keywordText cannot be null or empty.
36312API_MARKETINGREQUESTThe keywordText contains invalid characters {invalidCharacters}
36320API_MARKETINGBUSINESSThe keywordText {keywordText} cannot have total number of words more than {maxWordsInKeyword} words

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 Bid Suggestions

This example retrieves the suggested bids for a specified set of keywords and match types.

Input

The inputs for this sample are the campaign_id and ad_group_id path parameters, as well as the keywordText and matchType of the keywords for which the suggested bids shall be retrieved.

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

Output

If the call is successful, suggested bids for the specified keywords are returned.