POST/ad_campaign/{campaign_id}/create_ads_by_inventory_reference
This method adds a listing that is managed with the Inventory API to an existing Promoted Listings campaign.
For general strategy campaigns using the Cost Per Sale (CPS) funding model, an ad may be directly created for the listing.
For each listing specified in the request, this method:
- Creates an ad for the listing.
- Sets the bid percentage (also known as the ad rate) for the ads created.
- Associates the created 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.
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.
Use createCampaign to create a new campaign and use getCampaigns to get a list of existing campaigns.
Input
Resource URI
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 | This path parameter specifies the unique eBay-assigned identifier of the ad campaign for which to associate the newly created ads. Use the getCampaigns method to retrieve campaign IDs Occurrence: Required |
HTTP request headers
All requests made to eBay REST operations require you to provide the Authorization
HTTP header for authentication authorization.
The table below shows additional HTTP request headers that are either required, conditionally required, or strongly recommended for this method. Other standard HTTP request headers- opens rest request components page (not in this table) can also be used, but they are optional.
Header | Type | Description |
---|---|---|
Content-Type | string | This header indicates the format of the request body provided by the client. Its value should be set to application/json. For more information, refer to HTTP request headers. Occurrence: Required |
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 |
---|---|---|
adGroupId | string | Note: This field is not currently in use. Ad groups are only applicable to priority strategy ad campaigns that use the Cost Per Click (CPC) funding model. See Funding Models in the Promoted Listings Playbook for more information. Occurrence: Optional |
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. Note: This field has a minimum value of 2.0 and a maximum value of 100.0 . Occurrence: Conditional |
inventoryReferenceId | string | The unique identifier of a single-item listing or a multi-variation listing. Occurrence: Required |
inventoryReferenceType | InventoryReferenceTypeEnum | This enumerated value indicates the type of item the inventoryReferenceId references. Occurrence: Required |
Output
HTTP response headers
This call has no response headers.
Response payload
Response fields
Output container/field | Type | Description |
---|---|---|
ads | array of AdReference | A list of ad IDs. An ad ID is generated for each successfully created ad. Only one ad can be created per operation. Occurrence: Conditional |
ads.adId | string | A unique eBay-assigned ID for an ad. This ID is generated when an ad is created. Occurrence: Always |
ads.href | string | The getAd URI of an ad. You can use this URI to retrieve the ad. Occurrence: Always |
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}. |
35010 | API_MARKETING | REQUEST | The bidPercentage should not be provided when selected adRateStrategy is DYNAMIC for the campaign. |
35010 | API_MARKETING | REQUEST | The bidPercentage should not be provided when selected adRateStrategy is DYNAMIC for the campaign. |
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: {inventoryReferenceTypeValues}. |
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. |
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' is not supported for CPS funding model. |
36210 | API_MARKETING | REQUEST | No ad group found for ad group id {ad_group_id}. |
36219 | API_MARKETING | REQUEST | The ad group with ad group id {ad_group_id} has been archived. |
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.
POSThttps://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.