createAdByListingId | eBay Marketing API

POST/ad_campaign/{campaign_id}/ad

This method adds a listing to an existing Promoted Listings campaign using a listingId value generated by the Trading API or Inventory API, or using a value generated by an ad group ID.

For Promoted Listings Standard (PLS) campaigns using the Cost Per Sale (CPS) funding model, an ad may be directly created for the listing.

For the listing ID specified in the request, this method:

Creates an ad for the listing.
Sets the bid percentage (also known as the ad rate) for the ad.
Associates the ad with the specified campaign.

To create an ad for a listing, specify its listingId, plus the bidPercentage for the ad in the payload of the request. Specify the campaign to associate the ad with using the campaign_id path parameter. Listing IDs are generated by eBay when a seller creates listings with the Trading API.

For Promoted Listings Advanced (PLA) campaigns using the Cost Per Click (CPC) funding model, an ad group must be created first. If no ad group has been created for the campaign, an ad cannot be created.

For the ad group specified in the request, this method associates the ad with the specified ad group.

To create an ad for an ad group, specify the name of the ad group in the payload of the request. Specify the campaign to associate the ads with using the campaign_id path parameter. Ad groups are generated using the createAdGroup method.

You can specify one or more ad groups per campaign.

Use createCampaign to create a new campaign and use getCampaigns to get a list of existing campaigns.

This call has no response payload. If the ad is successfully created, a 201 Created HTTP status code and the getAd URI of the ad are returned in the location header.

Input

Resource URI (production)

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

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

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

{ /* CreateAdRequest */

"adGroupId" : "string",

"bidPercentage" : "string",

"listingId" : "string"

}

Request fields

Input container/field Type Description

Input container/field	Type	Description
adGroupId	string	A unique eBay-assigned ID for an ad group in a campaign that uses the Cost Per Click (CPC) funding model. Required if the campaign's funding model is Cost Per Click (CPC). Create an ad group using the createAdGroup method. Specify the campaign to associate the ad group with using the campaign_id path parameter. Note: You can call the getAdGroups method to retrieve the ad group IDs for a seller. Occurrence: Conditional
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. Required if the campaign's funding model is Cost Per Sale (CPS). 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: Conditional
listingId	string	A unique eBay-assigned ID for a listing that is generated when the listing is created. Note: This field accepts listing IDs, as generated by the Inventory API, and item IDs, as used in the eBay Traditional API set (e.g., the Trading and Finding APIs). Occurrence: Required

adGroupId

string

A unique eBay-assigned ID for an ad group in a campaign that uses the Cost Per Click (CPC) funding model.

Required if the campaign's funding model is Cost Per Click (CPC).

Create an ad group using the createAdGroup method.

Specify the campaign to associate the ad group with using the campaign_id path parameter.

Note: You can call the getAdGroups method to retrieve the ad group IDs for a seller.

Occurrence: Conditional

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.

Required if the campaign's funding model is Cost Per Sale (CPS).

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: Conditional

listingId

string

A unique eBay-assigned ID for a listing that is generated when the listing is created.

Note: This field accepts listing IDs, as generated by the Inventory API, and item IDs, as used in the eBay Traditional API set (e.g., the Trading and Finding APIs).

Occurrence: Required

Output

HTTP response headers

See HTTP response headers for details.

Header	Meaning
Location	The location response header contains the getAd URI of the newly created ad. The URI includes the newly created `adID`, which you can use to reference the ad.

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	Created
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}.
35013	API_MARKETING	REQUEST	The listing ID {listingId} is not valid.
35014	API_MARKETING	REQUEST	The listing ID is required for this call.
35035	API_MARKETING	REQUEST	The campaign with campaign id {campaign_id} has ended.
35036	API_MARKETING	REQUEST	An ad for listing ID {listingId} already exists.
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.
35054	API_MARKETING	BUSINESS	The listing ID {listingId} was created on a different marketplace than the campaign. The listing and campaign must reside on the same marketplace.
35057	API_MARKETING	BUSINESS	The listing ID {listingId} does not belong to the seller making this call.
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.
35080	API_MARKETING	REQUEST	The 'bidPercentage' is not supported for CPC funding model.
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.
36106	API_MARKETING	REQUEST	The 'adGroupId' {adGroupId} is not supported for CPS funding model.
36210	API_MARKETING	REQUEST	No adgroup found for adgroup id {ad_group_id}.
36219	API_MARKETING	REQUEST	The ad group with ad_group id {ad_group_id} has been archived.
36221	API_MARKETING	BUSINESS	You have exceeded the maximum number of ads supported in a ad group with this request. Only {maxItemsLimit} ads are allowed per ad group.

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: Create an Ad for a Campaign by Listing ID

This sample creates an ad for the specified listing ID, sets its bid percentage to 10, and associates the ad with the specified campaign.

Input

The inputs for this sample are bidPercentage, and listingId.

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

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 ad. The returned URI also includes the ID to the newly created ad. This method has no response payload.