marketing APIv1.10.0

getAds

GET
/ad_campaign/{campaign_id}/ad
This method retrieves Promoted Listings ads that are associated with listings created with either the Trading API or the Inventory API.

The method retrieves ads related to the specified campaign. Specify the Promoted Listings campaign to target with the campaign_id path parameter.

Because of the large number of possible results, you can use query parameters to paginate the result set by specifying a limit, which dictates how many ads to return on each page of the response. You can also specify how many ads to skip in the result set before returning the first result using the offset path parameter.

Call getCampaigns to retrieve the current campaign IDs for the seller.

Input

Resource URI (production)

GET https://api.ebay.com/sell/marketing/v1/ad_campaign/{campaign_id}/ad?

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

listing_idsstringA comma separated list of listing IDs. The response includes only active ads (ads associated with a RUNNING campaign). The results do not include listing IDs that are excluded by other conditions.

Occurrence: Optional

limitstringSpecifies the maximum number of ads to return on a page in the paginated response.

Default: 10
Maximum: 500

Occurrence: Optional

offsetstringSpecifies the number of ads to skip in the result set before returning the first ad in the paginated response.

Combine offset with the limit query parameter to control the items returned in the response. For example, if you supply an offset of 0 and a limit of 10, the first page of the response contains the first 10 items from the complete list of items retrieved by the call. If offset is 10 and limit is 20, the first page of the response contains items 11-30 from the complete result set.

Default: 0

Occurrence: Optional

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.readonly

https://api.ebay.com/oauth/api_scope/sell.marketing

See OAuth access tokens for more information.

Output

HTTP response headers

Output container/fieldTypeDescription
adsarray of AdA list of ads contained on this page from the paginated response.

Occurrence: Conditional

ads.adIdstringA unique eBay-assigned ID for the ad that is generated when the ad is created.

Occurrence: Always

ads.bidPercentagestringThe user-defined bid percentage (also known as the ad rate) sets level to which eBay should raise the visibility of the associated listing across the eBay buyer flows. The value is also used to calculate the Promoted Listings fee.

Minimum value: 1.0
Maximum value: 100.0

Occurrence: Always

ads.inventoryReferenceIdstringAn 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: Conditional

ads.inventoryReferenceTypeInventoryReferenceTypeEnumIndicates the type of item the inventoryReferenceId references. The item can be either an INVENTORY_ITEM or INVENTORY_ITEM_GROUP.

Occurrence: Conditional

ads.listingIdstringA unique eBay-assigned ID that is generated when a listing is created via the Trading API.

Occurrence: Conditional

hrefstringThe URI of the current page of results from the result set.

Occurrence: Conditional

limitintegerThe number of items returned on a single page from the result set. This value can be set in the request with the limit query parameter.

Occurrence: Conditional

nextstringThe URI for the following page of results. This value is returned only if there is an additional page of results to display from the result set.

Max length: 2048

Occurrence: Conditional

offsetintegerThe number of results skipped in the result set before listing the first returned result. This value can be set in the request with the offset query parameter.

Note: The items in a paginated result set use a zero-based list where the first item in the list has an offset of 0.

Occurrence: Conditional

prevstringThe URI for the preceding page of results. This value is returned only if there is a previous page of results to display from the result set.

Max length: 2048

Occurrence: Conditional

totalintegerThe total number of items retrieved in the result set.

If no items are found, this field is returned with a value of 0.

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
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.
35013API_MARKETINGREQUESTThe listing ID {listingId} is not valid.
35029API_MARKETINGREQUESTThe 'limit' has to be greater than zero and less than {maxLimitValue}.
35030API_MARKETINGREQUESTThe 'offset' cannot be less than zero.
35035API_MARKETINGREQUESTThe campaign with 'campaign_id' {campaign_id} has ended.
35045API_MARKETINGREQUESTNo campaign found for 'campaign_id' {campaign_id}.
35068API_MARKETINGBUSINESSYou have exceeded the maximum number of listing IDs. Only {maxSupportedNumber} listings are supported per call.

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 Ads

This sample retrieves the three ads associated with the campaign.

Input

The inputs for this sample is the campaign_id as a URI parameter. Optionally, you can use the listing_ids, limit, and offset fields to filter and control the size of the result set.
GET
https://api.ebay.com/sell/marketing/v1/ad_campaign/1********4/ad

Output

The output is an array of the ads in the campaign.