marketing APIv1.10.0

getAd

GET
/ad_campaign/{campaign_id}/ad/{ad_id}
This method retrieves the specified ad from the specified campaign.

In the request, supply the campaign_id and ad_id as path parameters.

Call getCampaigns to retrieve a list of the seller's current campaign IDs and call getAds to retrieve their current ad IDs.

Input

Resource URI (production)

GET https://api.ebay.com/sell/marketing/v1/ad_campaign/{campaign_id}/ad/{ad_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

ad_idstringIdentifier of an ad. This ID was generated when the ad was created.

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

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

See OAuth access tokens for more information.

Output

HTTP response headers

Output container/fieldTypeDescription
adIdstringA unique eBay-assigned ID for the ad that is generated when the ad is created.

Occurrence: Always

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

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

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

Occurrence: Conditional

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

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.
35035API_MARKETINGREQUESTThe campaign with 'campaign_id' {campaign_id} has ended.
35044API_MARKETINGREQUESTNo Ad found for 'ad_id' {ad_id}. Please correct the 'ad_id' and try again.
35045API_MARKETINGREQUESTNo campaign found for 'campaign_id' {campaign_id}.

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 Specific Ad

This sample retrieves the information of the ad based on its campaign and ad IDs.

Input

The inputs for this sample are the campaign_id and the adId, which are URI parameters.
GET
https://api.ebay.com/sell/marketing/v1/ad_campaign/1********4/ad/1********4

Output

The output for this sample are the adId, bidPercentage, and listingId of the specified ad.