marketing APIv1.10.0

bulkCreateAdsByListingId

POST
/ad_campaign/{campaign_id}/bulk_create_ads_by_listing_id
This method adds multiple listings to an existing Promoted Listings campaign using listingId values generated by either the Trading API or Inventory API.

For each 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 ads with using the campaign_id path parameter. Listing IDs are generated by eBay when a seller creates listings with the Trading API.

You can specify a maximum of 500 listings per call and each campaign can have ads for a maximum of 50,000 items. Be aware when using this call that each variation in a multiple-variation listing creates an individual ad.

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

Input

Resource URI (production)

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

URI parameters

ParameterTypeDescription
campaign_idstringA 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.

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.

Input container/fieldTypeDescription
requestsarray of CreateAdRequestAn array of listing IDs and their associated bid percentages, which the request uses to create ads in bulk. This request 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).

Maximum: 500 IDs per call

Occurrence: Optional

requests.bidPercentagestringThe 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.

bidPercentage is a single precision value that is guided by the following rules:
  • These values are valid:
       1,    1.0,    4.1,
       5.0,    5.5, ...
  • These values are not valid:
       0.01,    10.75,    99.99,
       and so on.

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

Minimum value: 1.0
Maximum value: 100.0

Occurrence: Required

requests.listingIdstringA 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

Output container/fieldTypeDescription
responsesarray of AdResponseA list of ads processed by the call.

Occurrence: Conditional

responses.adIdstringA unique eBay-assigned ID for an ad. This ID is generated when an ad is created.

Occurrence: Conditional

responses.errorsarray of ErrorDetailV3An array of errors associated with the request.

Occurrence: Conditional

responses.errors.categorystringThe category type for this error or warning. It takes an ErrorCategory object which can have one of three values:
  • Application: Indicates an exception or error occurred in the application code or at runtime. Examples include catching an exception in a service's business logic, system failures, or request errors from a dependency.
  • Business: Used when your service or a dependent service refused to continue processing on the resource because of a business rule violation such as "Seller does not ship item to Antarctica" or "Buyer ineligible to purchase an alcoholic item". Business errors are not syntactical input errors.
  • Request: Used when there is anything wrong with the request, such as authentication, syntactical errors, rate limiting or missing headers, bad HTTP header values, and so on.

Occurrence: Conditional

responses.errors.domainstringName of the domain containing the service or application.

Occurrence: Conditional

responses.errors.errorIdintegerA positive integer that uniquely identifies the specific error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms.

Occurrence: Conditional

responses.errors.inputRefIdsarray of stringIdentifies specific request elements associated with the error, if any. inputRefId's response is format specific. For JSON, use JSONPath notation.

Occurrence: Conditional

responses.errors.longMessagestringAn expanded version of message that should be around 100-200 characters long, but is not required to be such.

Occurrence: Conditional

responses.errors.messagestringAn end user and app developer friendly device agnostic message. It explains what the error or warning is, and how to fix it (in a general sense). Its value is at most 50 characters long. If applicable, the value is localized in the end user's requested locale.

Occurrence: Conditional

responses.errors.outputRefIdsarray of stringIdentifies specific response elements associated with the error, if any. Path format is the same as inputRefId.

Occurrence: Conditional

responses.errors.parametersarray of ErrorParameterV3This optional complex field type contains a list of one or more context-specific ErrorParameter objects, with each item in the list entry being a parameter (or input field name) that caused an error condition. Each ErrorParameter object consists of two fields, a name and a value.

Occurrence: Conditional

responses.errors.parameters.namestringName of the entity that threw the error.

Occurrence: Conditional

responses.errors.parameters.valuestringA description of the error.

Occurrence: Conditional

responses.errors.subdomainstringName of the domain's subsystem or subdivision. For example, checkout is a subdomain in the buying domain.

Occurrence: Conditional

responses.hrefstringThe URI that points to the ad.

Occurrence: Conditional

responses.listingIdstringA 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: Conditional

responses.statusCodeintegerAn HTTP status code that indicates the response-status of the request. Check this code to see if the ad was successful created.

Occurrence: Conditional

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.

StatusMeaning
200Success
207Multi Status
400Bad Request
404Not Found
409Business error
500Internal Server error

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

CodeDomainCategoryMeaning
35001API_MARKETINGAPPLICATIONThere was a problem with an eBay internal system or process. Contact eBay Developer Technical Support for assistance.
35002API_MARKETINGAPPLICATIONInternal error. Please wait a few minutes and try the call again.
35007API_MARKETINGREQUESTThe '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.
35013API_MARKETINGREQUESTThe listing ID {listingId} is not valid.
35014API_MARKETINGREQUESTThe listing Id is required for this call.
35018API_MARKETINGREQUESTThere are duplicate listing IDs or inventoryReference IDs in this request. You must remove the duplicate.
35033API_MARKETINGREQUESTAt least one request is required for bulk requests.
35035API_MARKETINGREQUESTThe campaign with 'campaign_id' {campaign_id} has ended.
35036API_MARKETINGREQUESTAn ad for listing ID {listingId} already exists.
35045API_MARKETINGREQUESTNo campaign found for 'campaign_id' {campaign_id}.
35048API_MARKETINGREQUESTThe listing ID {listingId} is invalid or has ended.
35052API_MARKETINGBUSINESSThe category {categoryId} is not supported by the Promoted Listing service for multi-quantity listings.
35054API_MARKETINGBUSINESSThe listing ID {listingId} was created on a different marketplace than the campaign. The listing and campaign must reside on the same marketplace.
35057API_MARKETINGBUSINESSThe listing ID {listingId} does not belong to the seller making this call.
35058API_MARKETINGBUSINESSThe listing ID {listingId} is not a fixed price item. This is a requirement for a promoted listing.
35059API_MARKETINGBUSINESSThe listing ID {listingId} is not a multi-quantity item. This is a requirement for a promoted listing.
35061API_MARKETINGBUSINESSThe 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.
35063API_MARKETINGBUSINESSThe campaign with 'campaign_id' {campaign_id} is ending soon. No update operations are allowed on this campaign until it ends.
35071API_MARKETINGBUSINESSYou have exceeded the maximum number of listing IDs or inventory reference IDs. Only {maxSupportedNumber} IDs are supported per call.
35075API_MARKETINGBUSINESSThe category {categoryId} is not supported by the Promoted Listing service for single-quantity listings.
35077API_MARKETINGBUSINESSTo use Promoted Listings, you need to improve your seller level to Top Rated or Above Standard and have enough recent sales activity.
35078API_MARKETINGBUSINESSTo gain access to Promoted Listings, you must be in good standing with recent sales activity.

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 Ad in Bulk by Listing ID

This sample creates two ads with the bid percentage of 10, and adds them to the specified campaign.

Input

The inputs for this sample are a list of listingId and bidPercentage pairs. Specify a campaign using the campaign_id URI parameter.
POST
https://api.ebay.com/sell/marketing/v1/ad_campaign/1********4/bulk_create_ads_by_listing_id

Output

The output is the statusCode, listingId, adId, and the href for each created ad.