cloneCampaign | eBay Marketing API

POST/ad_campaign/{campaign_id}/clone

This method clones (makes a copy of) the specified campaign's campaign criterion. The campaign criterion is a container for the fields that define the criteria for a rule-based campaign.

To clone a campaign, supply the campaign_id as a path parameter in your call. There is no request payload.

The ID of the newly-cloned campaign is returned in the Location response header.

Call getCampaigns to retrieve a seller's current campaign IDs.

Requirement: In order to clone a campaign, the campaignStatus must be ENDED and the campaign must define a set of selection rules (it must be a rules-based campaign).

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}/clone

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. This ID is the campaign ID of the campaign being cloned. Note: You can retrieve the campaign IDs for a specified seller using the getCampaigns method. 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

{ /* CloneCampaignRequest */

"campaignName" : "string",

"endDate" : "string",

"fundingStrategy" :

{ /* FundingStrategy */

"adRateStrategy" : "AdRateStrategyEnum : [DYNAMIC,FIXED]",

"bidPercentage" : "string",

"dynamicAdRatePreferences" : [

{ /* DynamicAdRatePreference */

"adRateAdjustmentPercent" : "string",

"adRateCapPercent" : "string"

}

"fundingModel" : "FundingModelEnum : [COST_PER_SALE,COST_PER_CLICK]"

"startDate" : "string"

}

Request fields

Input container/field	Type	Description
campaignName	string	A seller-defined name for the newly-cloned campaign. This value must be unique for the seller. You can use any alphanumeric characters in the name, except the less than (<) or greater than (>) characters. Max length: 80 characters Occurrence: Required
endDate	string	The date and time the campaign ends, in UTC format (`yyyy-MM-ddThh:mm:ssZ`). If this field is omitted, the campaign will have no defined end date, and will not end until the seller makes a decision to end the campaign with an endCampaign call, or if they update the campaign at a later time with an end date. Occurrence: Optional
fundingStrategy	FundingStrategy	This container is used to set the funding model and default bid percentage for the campaign to be cloned. Occurrence: Required
fundingStrategy.adRateStrategy	AdRateStrategyEnum	The ad rate strategy that shall be applied to the campaign. Occurrence: Optional
fundingStrategy.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 the 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. Note:This field is only relevant for campaigns that use the CPS funding model and a fixed ad rate. It is not used for campaigns that use the Cost Per Click (CPC) funding model and should not be provided when the selected adRateStrategy for the campaign is dynamic. Minimum value: 2.0 Maximum value: 100.0 Occurrence: Conditional
fundingStrategy.dynamicAdRatePreferences	array of DynamicAdRatePreference	A field that indicates whether a single, user-defined bid percentage (also known as the ad rate) should be used, or whether eBay should automatically adjust listings to maintain the daily suggested bid percentage. Note: Dynamic adjustment is only applicable when the adRateStrategy is set to `DYNAMIC`. Default: `FIXED` Occurrence: Optional
fundingStrategy.dynamicAdRatePreferences.adRateAdjustmentPercent	string	The percentage above or below (-) the eBay suggested ad rate that a seller is willing to pay. This specifies the maximum and minimum values to which an ad rate can be dynamically adjusted. Occurrence: Optional
fundingStrategy.dynamicAdRatePreferences.adRateCapPercent	string	The maximum value (specified as a percentage) to which the eBay suggested ad rate can be adjusted. The adjusted ad rate will never exceed this percentage. Occurrence: Optional
fundingStrategy.fundingModel	FundingModelEnum	Indicates the model that eBay uses to calculate the Promoted Listings fee. For a description of the funding model types, refer to FundingModelTypeEnum. Occurrence: Required
startDate	string	The date and time the cloned campaign starts, in UTC format (`yyyy-MM-ddThh:mm:ssZ`). For display purposes, convert this time into the local time of the seller. On the date specified, the service derives the keywords for each listing in the campaign, creates an ad for each listing, and associates each new ad with the campaign. The campaign starts after this process is completed. The amount of time it takes the service to start the campaign depends on the number of listings in the campaign. Call getCampaign to check the status of the campaign. Occurrence: Required

Output

HTTP response headers

See HTTP response headers for details.

Header	Meaning
Location	The location response header contains the getCampaign URI to the retrieve the newly created campaign.

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
201	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.
35002	API_MARKETING	APPLICATION	Internal error. Please wait a few minutes and try the call again.
35006	API_MARKETING	REQUEST	'fundingStrategy' is required for this call.
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}.
35019	API_MARKETING	REQUEST	Campaign name is required for this call.
35020	API_MARKETING	REQUEST	The campaign name cannot be more than {maxCampaignNameLength} characters.
35021	API_MARKETING	REQUEST	A campaign with the name of {campaignName} already exists. Please provide a different name.
35023	API_MARKETING	REQUEST	The request contains invalid characters. {notAllowedCharacters} are not allowed.
35024	API_MARKETING	REQUEST	The campaign start date {startDate} cannot be after the end date {endDate}.
35025	API_MARKETING	REQUEST	A campaign start date is required.
35026	API_MARKETING	REQUEST	A campaign start or end date {date} cannot be in the past.
35045	API_MARKETING	REQUEST	No campaign found for campaign id {campaign_id}.
35062	API_MARKETING	BUSINESS	The campaign with 'campaign_id' {campaign_id} has not ended yet. cloneCampaign is supported only for criterion based campaigns that have ended.
35065	API_MARKETING	BUSINESS	This operation is only supported for criterion based campaigns.
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.
35106	API_MARKETING	BUSINESS	'BidPercentage' should be provided when selected 'adRateStrategy' is 'FIXED'.
35107	API_MARKETING	BUSINESS	'dynamicAdRatePreferences' can be provided only when selected 'adRateStrategy' is 'DYNAMIC'.
35108	API_MARKETING	BUSINESS	The 'adRateAdjustmentPercent' {adRateAdjustmentPercent} is not valid. Please set 'adRateAdjustmentPercent' {adRateAdjustmentPercent} between {minAllowedAdRateAdjustmentPercent}% - {maxAllowedAdRateAdjustmentPercent}%.
35109	API_MARKETING	BUSINESS	The 'adRateCapPercent' {adRateCapPercent} is not valid. Please set 'adRateCapPercent' between {minAllowedAdRateCapPercent}% - {maxAllowedAdRateCapPercent}%.
35110	API_MARKETING	BUSINESS	The 'adRateStrategy' is not supported for CPC funding model.
35111	API_MARKETING	BUSINESS	The 'dynamicAdRatePreferences' is not supported for CPC funding model.
35112	API_MARKETING	BUSINESS	The 'adRateStrategy' is currently only supported for criterion based campaign with 'autoselectFutureInventory' as True.
35113	API_MARKETING	BUSINESS	The 'dynamicAdRatePreferences' is currently only supported for criterion based campaign with 'autoselectFutureInventory' as True.
35114	API_MARKETING	BUSINESS	The 'dynamicAdRatePreferences' list currently can only support one element containing dynamicAdRatePreference. Please remove additional elements and try again.
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: Clones a Campaign

This sample clones the campaign with the ID of 1********4. The new campaign is named "Fall Sale". It starts on Sep. 24, ends on Oct. 25, and the bid percentage is 15%.

Input

Pass the campaign ID of the campaign to clone using the campaign_id URI parameter. In the payload, pass the campaignName, startDate, endDate, fundingStrategy.bidPercentage, and fundingStrategy.fundingModel fields for the cloned campaign.

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

Output

A successful call returns the HTTP status code 201 Created.

In addition, the response includes a location response header that contains the URI to the newly created campaign. This method has no response payload.