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 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 the suggested bids for input keywords and match type.
Input
Resource URI
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 associated with the keywords for which bid 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 containing the keywords for which the bid 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 |
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 clipboardRequest fields
| Input container/field | Type | Description |
|---|---|---|
| keywords | array of KeywordRequest | An array of keywords for which bids will be required. Occurrence: Required |
| keywords.keywordText | string | The text of the keyword. Keywords are not case sensitive and compound words can be used without additional encoding (for example, tennis ball). Occurrence: Required |
| keywords.matchType | MatchTypeEnum | A field that defines the match type for the keyword.
Occurrence: Required |
Output
HTTP response headers
This call has no response headers.
Response payload
Response fields
| Output container/field | Type | Description |
|---|---|---|
| suggestedBids | array of SuggestedBids | A list of bids in the paginated collection. Occurrence: Conditional |
| suggestedBids.keywordText | string | The text for the keyword. Occurrence: Always |
| suggestedBids.matchType | MatchTypeEnum | A field that defines the match type for the keyword.
Occurrence: Always |
| suggestedBids.proposedBid | ProposedBid | The suggested bid associated with the keyword. Occurrence: Conditional |
| suggestedBids.proposedBid.currency | CurrencyCodeEnum | The base currency applied to the value field to establish a monetary amount. Occurrence: Always |
| suggestedBids.proposedBid.rangeEnd | string | The end of the range specified for the bid. Occurrence: Always |
| suggestedBids.proposedBid.rangeStart | string | The start of the range specified for the bid. Occurrence: Always |
| suggestedBids.proposedBid.value | string | The value of the proposed bid. Occurrence: Always |
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. |
| 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}. |
| 35091 | API_MARKETING | REQUEST | You have exceeded the maximum number of requests. Only {maxSupportedNumber} 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}. |
| 36304 | API_MARKETING | REQUEST | The keywordText {keywordText} cannot be more than {maxKeywordTextLength} characters. |
| 36311 | API_MARKETING | REQUEST | The keywordText cannot be null or empty. |
| 36312 | API_MARKETING | REQUEST | The keywordText contains invalid characters {invalidCharacters} |
| 36320 | API_MARKETING | BUSINESS | The 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: Retrieve 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.