POST/ad_campaign/{campaign_id}/ad
This method works with listings created with either the Trading API or the Inventory API.
The method:
- Creates an ad for the specified listing ID.
- 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 or Inventory API.
Each campaign can have ads for a maximum of 50,000 items, and each item in a multiple-variation listing is considered as an single item.
Use createCampaign to create a new campaign and use getCampaigns to get a list of existing campaigns.
Input
Resource URI (production)
URI parameters
| Parameter | Type | Description |
|---|---|---|
| campaign_id | string | A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get a seller's campaign IDs by calling getCampaigns. 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 clipboardRequest fields
| 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.
If a bid percentage is not provided for an ad, eBay uses the default bid percentage of the associated campaign. Minimum value: 1.0Maximum value: 100.0 Occurrence: Required |
| listingId | string | A unique eBay-assigned ID for a listing that is generated when the listing is created. Note: This field accepts both listing IDs, as generated by the Inventory API, and an 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 URL to the newly created ad. The URL includes the eBay-assigned 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}. Example of valid values: 4.1, 4.10, 5.5, 5.0, etc. Invalid values: 4.44, 8.11, etc. |
| 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. |
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.