updateBiddingStrategy: eBay Marketing API

POST/ad_campaign/{campaign_id}/update_bidding_strategy

This method allows sellers to change the bidding strategy for a specified Cost Per Click (CPC) campaign that uses manual targeting. Available bidding strategies are:

FIXED

When using a fixed bidding strategy, sellers manually assign and adjust keyword bids for the CPC campaign.
DYNAMIC

When using a dynamic bidding strategy, eBay will manage a campaign's keyword bids and automatically update them daily to the suggested bid.

Note: For a CPC campaign using dynamic bidding, sellers can continue to manually add keywords for the campaign, but they are no longer able to manually adjust their associated bid values. In order to manually adjust bid values, sellers must use the FIXED bidding strategy.

In addition, this method allows sellers to modify the maxCPC value of a smart targeting campaign.
Note: This method only applies to the Cost Per Click (CPC) funding model; it does not apply to the Cost Per Sale (CPS) funding model. Refer to 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}/update_bidding_strategy

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 the keyword bidding strategy is being updated. Use the getCampaigns method to retrieve campaign 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

{ /* UpdateBiddingStrategyRequest */

"biddingStrategy" : "BiddingStrategyEnum : [FIXED,DYNAMIC]",

"bidPreferences" : [

{ /* BidPreference */

"maxCpc" :

{ /* MaxCpc */

"amount" :

{ /* Amount */

"currency" : "CurrencyCodeEnum : [AED,AFN,ALL...]",

"value" : "string"

}

]

}

Request fields

Input container/field	Type	Description
biddingStrategy	BiddingStrategyEnum	The new bidding strategy for the specified Cost Per Click (CPC) campaign. Occurrence: Required
bidPreferences	array of BidPreference	This container indicates the bidding preferences of the campaign, such as the maximum CPC amount. Note: This container is only applicable for smart targeting campaigns. This container is required if the user wants to create a Smart Targeting campaign. Occurrence: Conditional
bidPreferences.maxCpc	MaxCpc	The maximum amount for which the eBay suggested bid can be adjusted. This value represents the most a seller is willing to pay for each click on their ad. The adjusted bid will never exceed this amount. This field is required for smart targeting campaigns. Note: The maximum cost-per-click has a minimum value of 0.02 and a maximum value of 100. Occurrence: Conditional
bidPreferences.maxCpc.amount	Amount	The allocated maximum CPC amount for a smart targeting campaign. Both the currency and amount must be specified when allocating the Max CPC. Occurrence: Optional
bidPreferences.maxCpc.amount.currency	CurrencyCodeEnum	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` Occurrence: Conditional
bidPreferences.maxCpc.amount.value	string	The monetary amount in the specified currency. Required in the amount type. Occurrence: Conditional

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.
35035	API_MARKETING	REQUEST	The campaign with campaign id {campaign_id} has ended.
35045	API_MARKETING	REQUEST	No campaign found for campaign id {campaign_id}.
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.
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.
35124	API_MARKETING	REQUEST	The 'maxCpc' {maxCpc} is not valid. Minimum value: {minMaxCpc} , Maximum value:{maxMaxCpc}.
35125	API_MARKETING	REQUEST	The 'bidPreferences' list currently supports only one element. Please remove additional elements and try again.
35126	API_MARKETING	BUSINESS	The 'biddingStrategy' isn't applicable for campaigns with smart targeting type.
35127	API_MARKETING	BUSINESS	'maxCPC' is only supported for CPC funding model campaigns with on-site channels and smart targeting type.
35130	API_MARKETING	REQUEST	The 'biddingStrategy' is required
35134	API_MARKETING	BUSINESS	A 'biddingStrategy' cannot be supplied for smart targeting campaigns. Please either remove 'biddingStrategy' from the request to create a smart targeting campaign or supply another value for 'campaignTargetingType'.
36101	API_MARKETING	REQUEST	This functionality is not supported for CPS funding model.
36161	API_MARKETING	REQUEST	Smart targeting campaigns require a `bidPreferences.maxCpc` value.
36162	API_MARKETING	REQUEST	The 'maxCpc' currency should be the same as the daily budget.
36163	API_MARKETING	REQUEST	The 'maxCpc' value {maxCpcValue} is below minimum value {maxCpcMinimumValue}.
36164	API_MARKETING	REQUEST	The 'maxCpc' value {maxCpcValue} is above maximum value {maxCpcMaximumValue}.
36165	API_MARKETING	REQUEST	The 'maxCpc' value {maxCpcValue} is more than maximum daily budget {maxDailyBudget}.
36166	API_MARKETING	REQUEST	The 'maxCpc' value {maxCpcValue} is invalid. Refer to the API call documentation for more information.

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 bidding strategy to Dynamic.

Sample 2: Update bidding strategy to Fixed.

Sample 3: Update Max CPC of a smart targeting campaign

Sample 1: Update bidding strategy to Dynamic.

This example updates the bidding strategy for a Cost per Click (CPC) campaign from FIXED to DYNAMIC.

Input

The inputs for this sample are the campaign_id for the campaign that is to be updated, as well as the desired new biddingStrategy, which is passed in via the request body.

POSThttps://api.ebay.com/sell/marketing/v1/ad_campaign/1*********8/update_bidding_strategy

Output

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

Sample 2: Update bidding strategy to Fixed.

This example updates the bidding strategy for a Cost per Click (CPC) campaign from DYNAMIC to FIXED.

Input

The inputs for this sample are the campaign_id for the campaign that is to be updated, as well as the desired new biddingStrategy, which is passed in via the request body.

POSThttps://api.ebay.com/sell/marketing/v1/ad_campaign/1*********8/update_bidding_strategy

Output

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

Sample 3: Update Max CPC of a smart targeting campaign

This example updates max cost-per-click of a smart targeting priority strategy campaign.

Input

The inputs for this sample are the campaign_id for the campaign that is to be updated, as well as the desired new MaxCpc, which is passed in via the request body.

POSThttps://api.ebay.com/sell/marketing/v1/ad_campaign/1*********8/update_bidding_strategy

Output

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