updateBid | eBay Marketing API

POST/ad_campaign/{campaign_id}/ad/{ad_id}/update_bid

This method updates the bid percentage (also known as the "ad rate") for the specified ad in the specified campaign.

In the request, supply the campaign_id and ad_id as path parameters, and supply the new bidPercentage value in the payload of the call.

Call getCampaigns to retrieve a seller's current campaign IDs and call getAds to get their ad IDs.

Note: This method only applies to the Cost Per Sale (CPS) funding model; it does not apply to the Cost Per Click (CPC) funding model. See Funding Models in the Promoted Listings Playbook for more information.

Input

Resource URI

POST https://api.ebay.com/sell/marketing/v1/ad_campaign/{campaign_id}/ad/{ad_id}/update_bid

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	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. Occurrence: Required
ad_id	string	A unique eBay-assigned ID for an ad that's generated when an ad is created. 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

{ /* UpdateBidPercentageRequest */

"bidPercentage" : "string"

}

Request fields

Input container/field Type Description

Input container/field	Type	Description
bidPercentage	string	The user-defined bid percentage (also known as the ad rate) sets the level that eBay increases the visibility in search results for the associated listing. The higher the bidPercentage value, the more eBay promotes the listing. The value specified here is also used to calculate the Promoted Listings fee. This percentage value is multiplied by the final sales price to determine the fee. The Promoted Listings fee is determined at the time the transaction completes and the seller is assessed the fee only when an item sells through a Promoted Listings ad campaign. The bidPercentage is a single precision value that is guided by the following rules: These values are valid: `4.1`, `5.0`, `5.5`, ... These values are not valid: `0.01`, `10.75`, `99.99`, and so on. This is default bid percentage for the campaigns using the Cost Per Sale (CPS) funding model, and this value will be overridden by any ads in the campaign that have their own set bid percentages. If a bid percentage is not provided for an ad, eBay uses the default bid percentage of the associated campaign. Minimum value: 2.0 Maximum value: 100.0 Occurrence: Required

bidPercentage

string

The user-defined bid percentage (also known as the ad rate) sets the level that eBay increases the visibility in search results for the associated listing. The higher the bidPercentage value, the more eBay promotes the listing.

The value specified here is also used to calculate the Promoted Listings fee. This percentage value is multiplied by the final sales price to determine the fee.

The Promoted Listings fee is determined at the time the transaction completes and the seller is assessed the fee only when an item sells through a Promoted Listings ad campaign.

The bidPercentage is a single precision value that is guided by the following rules:

These values are valid:
4.1, 5.0, 5.5, ...
These values are not valid:
0.01, 10.75, 99.99,
and so on.

This is default bid percentage for the campaigns using the Cost Per Sale (CPS) funding model, and this value will be overridden by any ads in the campaign that have their own set bid percentages.

If a bid percentage is not provided for an ad, eBay uses the default bid percentage of the associated campaign.

Minimum value: 2.0
Maximum value: 100.0

Occurrence: Required

Output

HTTP response headers

This call has no response headers.

Response payload

This call has no payload.

Response fields

This call has no field definitions.

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
204	No content
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.
35002	API_MARKETING	APPLICATION	Internal error. Please wait a few minutes and try the call again.
35007	API_MARKETING	REQUEST	The 'bidPercentage' {bidPercentage} is not valid. The bid percentage should be a single precision value. Minimum value: {minBidPercent} , Maximum value:{maxBidPercent}.
35035	API_MARKETING	REQUEST	The campaign with campaign id {campaign_id} has ended.
35044	API_MARKETING	REQUEST	No Ad found for 'ad_id' {ad_id}. Please correct the 'ad_id' and try again.
35045	API_MARKETING	REQUEST	No campaign found for campaign id {campaign_id}.
35048	API_MARKETING	REQUEST	The listing ID {listingId} is invalid or has ended.
35052	API_MARKETING	BUSINESS	The category {categoryId} is not supported by the Promoted Listing service for multi-quantity listings.
35058	API_MARKETING	BUSINESS	The listing ID {listingId} is not a fixed price item. This is a requirement for a promoted listing.
35059	API_MARKETING	BUSINESS	The listing ID {listingId} is not a multi-quantity item. This is a requirement for a promoted listing.
35061	API_MARKETING	BUSINESS	The campaign with 'campaign_id' {campaign_id} is being synced to match the specifications of the campaign. Please wait a few minutes and try the call again.
35063	API_MARKETING	BUSINESS	The campaign with 'campaign_id' {campaign_id} is ending soon. No update operations are allowed on this campaign until it ends.
35064	API_MARKETING	BUSINESS	This operation is only supported for key based campaigns.
35075	API_MARKETING	BUSINESS	The category {categoryId} is not supported by the Promoted Listing service for single-quantity listings.
35077	API_MARKETING	BUSINESS	To use Promoted Listings, you need to improve your seller level to Top Rated or Above Standard and have enough recent sales activity.
35078	API_MARKETING	BUSINESS	To gain access to Promoted Listings, you must be in good standing with recent sales activity.
35089	API_MARKETING	BUSINESS	We are currently testing a premium ads product with a small invite-only group. We will share more information when we are ready to expand.
35113	API_MARKETING	BUSINESS	This operation is not supported when selected adRateStratergy is DYNAMIC for the campaign.
36101	API_MARKETING	REQUEST	This functionality is not supported for the CPC funding model.

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: Update the Bid Percentage

This sample updates the bid percentage for the specified ad to 11 percent.

Input

The inputs for this sample are bidPercentage and the campaign_id and ad_idas URI parameters.

POSThttps://api.ebay.com/sell/marketing/v1/ad_campaign/1********4/ad/1********4/update_bid

Output

A successful call returns the HTTP status code 204 No content. This method has no response payload.