GET/ad_campaign/{campaign_id}/get_ads_by_inventory_reference
This method retrieves Promoted Listings ads associated with listings that are managed with the Inventory API from the specified campaign.
Supply the campaign_id as a path parameter and use query parameters to specify the inventory_reference_id and inventory_reference_type pairs.
In the Inventory API, an inventory reference ID is either a seller-defined SKU value or an inventoryItemGroupKey (a seller-defined ID for an inventory item group, which is an entity that's used in the Inventory API to create a multiple-variation listing). To indicate a listing managed by the Inventory API, you must always specify both an inventory_reference_id and the associated inventory_reference_type.
Call getCampaigns to retrieve all of the seller's the current campaign IDs.
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.
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 | 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 |
inventory_reference_type | string | The type of the inventory reference ID. Set this value to either INVENTORY_ITEM (a single listing) or INVENTORY_ITEM_GROUP (a multi-variation listing). You must always pass in both an inventory_reference_id and an inventory_reference_type. Occurrence: Required |
inventory_reference_id | string | The inventory reference ID associated with the ad you want returned. A seller's inventory reference ID is the ID of either a listing or the ID of an inventory item group (the parent of a multi-variation listing, such as a shirt that is available in multiple sizes and colors). You must always supply in both an inventory_reference_id and an inventory_reference_type. Occurrence: Required |
HTTP request headers
All requests made to eBay REST operations require you to provide the Authorization
HTTP header for authentication authorization.
All other standard RESTful request headers are optional. For more information on standard RESTful request headers, see the HTTP request headers- opens rest request components page table.
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.readonly
https://api.ebay.com/oauth/api_scope/sell.marketing
See OAuth access tokens for more information.
Request payload
This call has no payload.
Request fields
This call has no field definitions.
Output
HTTP response headers
This call has no response headers.
Response payload
Response fields
Output container/field | Type | Description |
---|---|---|
ads | array of Ad | A list of ad IDs. An ad ID is generated for each successfully created ad. Occurrence: Always |
ads.adGroupId | string | A unique eBay-assigned ID for an ad group in a campaign that uses the Cost Per Click (CPC) funding model. This ID is created after a successful createAdGroup call, and all ad groups must be associated with a CPC campaign. Occurrence: Conditional |
ads.adId | string | A unique eBay-assigned ID that is generated when the ad is created. Occurrence: Always |
ads.adStatus | AdStatusEnum | The current status of the CPC ad.
Occurrence: Conditional |
ads.alerts | array of Alert | An array containing alert messages for the ad. Occurrence: Conditional |
ads.alerts.alertType | AlertTypeEnum | The type of alert message. For example, an invalid bid percentage. Occurrence: Conditional |
ads.alerts.details | array of AlertDetails | A description of the alert including dimensions and aspects. Occurrence: Conditional |
ads.alerts.details.dimension | AlertDimension | The dimension information of the alert including keys and values. Occurrence: Conditional |
ads.alerts.details.dimension.key | DimensionKeyEnum | The key field of the applied dimension. For example, the marketplace Id. Occurrence: Conditional |
ads.alerts.details.dimension.value | string | The value field of the applied dimension. For example, if the key is a Occurrence: Conditional |
ads.alerts.details.aspect | Aspect | The aspect information of the alert including keys and values. Occurrence: Conditional |
ads.alerts.details.aspect.key | AspectKeyEnum | The type of the aspect. For example, Occurrence: Conditional |
ads.alerts.details.aspect.value | string | The value of the aspect. For example, if the aspect is a percentage, a value of '2.0' would equal 2%. Occurrence: Conditional |
ads.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 will always be returned for campaigns that use the Cost Per Sale (CPS) funding model. It will not be returned for campaigns that use the Cost Per Click (CPC) funding model. Minimum value: 2.0 Maximum value: 100.0 Occurrence: Conditional |
ads.inventoryReferenceId | string | An ID that identifies 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 an inventory item group (a multiple-variation listing, such as a listing for a shirt that's available in multiple sizes and colors). This field is only returned if the ad is associated with a SKU or an inventory item group value. Occurrence: Always |
ads.inventoryReferenceType | InventoryReferenceTypeEnum | The enumeration value returned here indicates the type of listing the inventoryReferenceId references. The value returned here will be This field is only returned if the ad is associated with a SKU or an inventory item group value. Occurrence: Always |
ads.listingId | string | A unique eBay-assigned ID that is generated when a listing is created. 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 |
---|---|
200 | Success |
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. |
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}. |
35064 | API_MARKETING | BUSINESS | This operation is only supported for key based campaigns. |
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. |
36106 | API_MARKETING | REQUEST | The 'adGroupId' is not supported for CPS funding model. |
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: Retrieve an Ad by Inventory Reference Id
This sample retrieves the ad for the listing specified from 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.
GEThttps://api.ebay.com/sell/marketing/v1/ad_campaign/1********4/get_ads_by_inventory_reference?inventory_reference_id=1********2&inventory_reference_type=INVENTORY_ITEM
Output
The output is the adId and the details of the ad.