marketing APIv1.10.0

createAdsByInventoryReference

POST

/ad_campaign/{campaign_id}/create_ads_by_inventory_reference

This method works with listings that are managed with the Inventory API.

The method:

Creates an ad for the specified 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 inventoryReferenceId and inventoryReferenceType, 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.

In the Inventory API, an inventory reference ID is either a seller-defined SKU value or an inventoryItemGroupKey (a seller-defined ID for a multiple-variation listing).

Each campaign can have ads for a maximum of 50,000 items, and each item in a multiple-variation listing is considered as an individual item.

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

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 Clipboard

{ /* CreateAdsByInventoryReferenceRequest */

"bidPercentage" : "string",

"inventoryReferenceId" : "string",

"inventoryReferenceType" : "InventoryReferenceTypeEnum : [INVENTORY_ITEM,INVENTORY_ITEM_GROUP]"

}

Request 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 of a listing across the eBay buyer flows. 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
inventoryReferenceId	string	An ID that identifies an a single-item listing or multiple-variation listing that is managed with the Inventory API. The inventory reference ID is a seller-defined value that can be either an SKU for a single-item listing or an inventoryItemGroupKey for a multiple-value listing. An inventoryItemGroupKey is a value that the seller defines to indicate a listing that's the parent of a inventory item group (a multiple-variation listing, such as a listing for shirt that's available in multiple sizes and colors). You must always specify both an inventoryRreferenceId and an inventoryReferenceType to indicate an item that's managed with the Inventory API. Occurrence: Required
inventoryReferenceType	InventoryReferenceTypeEnum	Indicates the type of item the inventoryReferenceId references. The item can be either an `INVENTORY_ITEM` or `INVENTORY_ITEM_GROUP`. You must always pair an inventoryReferenceId with and inventoryReferenceType. Occurrence: Required

Output

HTTP response headers

This call has no response headers.

Response payload

Copy complete valid JSON to Clipboard

{ /* AdReferences */

"ads" : [

{ /* AdReference */

"adId" : "string",

"href" : "string"

}

]

}

Response fields

Output container/field	Type	Description
ads	array of AdReference	A list of ad IDs and the URIs that point to them. Occurrence: Conditional
ads.adId	string	A unique eBay-assigned ID for an ad. This ID is generated when an ad is created. Occurrence: Conditional
ads.href	string	The URI of an ad. You can use this URI to retrieve the ad. 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.

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.
35012	API_MARKETING	REQUEST	The inventory reference ID {inventoryReferenceId} is not valid.
35035	API_MARKETING	REQUEST	The campaign with 'campaign_id' {campaign_id} has ended.
35040	API_MARKETING	REQUEST	The inventory reference type is not valid. Valid values are: {inventoryRefereneTypeValues}.
35045	API_MARKETING	REQUEST	No campaign found for 'campaign_id' {campaign_id}.
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.
35072	API_MARKETING	BUSINESS	InventoryReferenceId {inventoryReferenceId} is not eligible for Promoted Listings because it is a variation and variations can only be promoted using the parent ID to which it belongs. Replace this ID with the InventoryReferenceId of the parent and set 'inventoryReferenceType' to 'INVENTORY_ITEM_GROUP'
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 Ad Using an Inventory Reference Id

This sample creates an ad for the listing with the inventory reference ID of 8********2, and associates the ad with the campaign with the ID of 1********4.

Input

The inputs for this sample are campaign_id (as a URI parameter) and the inventory_reference_id and inventory_reference_type of the listing and the bidPercentage for the ad.

POST

https://api.ebay.com/sell/marketing/v1/ad_campaign/1********/create_ads_by_inventory_reference

Output

The output is the ID and URL of the ad.