Skip to main content

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 is generated when a campaign is created.

Note: You can retrieve the campaign IDs for a specified seller using the getCampaigns method.

Occurrence: Required

ad_idstringA unique identifier for an ad. This ID is generated when the ad is created.

Occurrence: Required

HTTP request headers

All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.

This method has no additional required headers. 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.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/fieldTypeDescription
adGroupIdstring

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

adIdstring

A unique eBay-assigned ID that is generated when the ad is created.

Occurrence: Always

adStatusAdStatusEnum

The current status of the CPC ad.

Valid Values:

  • ACTIVE
  • PAUSED
  • ARCHIVED
Note: This type only applies to the Cost Per Click (CPC) funding model; it does not apply to the Cost Per Sale (CPS) funding model.

Occurrence: Conditional

alertsarray of Alert

An array containing alert messages for the ad.

Occurrence: Conditional

alerts.alertTypeAlertTypeEnum

The type of alert message. For example, an invalid bid percentage.

Occurrence: Conditional

alerts.detailsarray of AlertDetails

A description of the alert including dimensions and aspects.

Occurrence: Conditional

alerts.details.dimensionDimension

The dimension information of the alert including keys and values.

Occurrence: Conditional

alerts.details.dimension.keyDimensionKeyEnum

The key field of the applied dimension. For example, the marketplace Id.

Occurrence: Conditional

alerts.details.dimension.valuestring

The value field of the applied dimension. For example, if the key is a MARKETPLACE_ID, the value would be from MarketplaceIdEnum.

Occurrence: Conditional

alerts.details.aspectAspect

The aspect information of the alert including keys and values.

Occurrence: Conditional

alerts.details.aspect.keyAspectKeyEnum

The type of the aspect. For example, MINIMUM_REQUIRED.

Occurrence: Conditional

alerts.details.aspect.valuestring

The value of the aspect. For example, if the aspect is a percentage, a value of '2.0' would equal 2%.

Occurrence: Conditional

bidPercentagestring

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.

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.

The bidPercentage is a single precision value that is guided by the following rules:

  • These values are valid:
       4.1,    5.0,    5.5, ...
  • These values are not valid:
       0.01,    10.75,    99.99,
       and so on.
This is default bid percentage for the campaigns using the Cost Per Sale (CPS) funding model, and this value will be overridden by any ads in the campaign that have their own set bid percentages.

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

inventoryReferenceIdstring

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

inventoryReferenceTypeInventoryReferenceTypeEnum

The enumeration value returned here indicates the type of listing the inventoryReferenceId references. The value returned here will be INVENTORY_ITEM for a single-variation listing, or INVENTORY_ITEM_GROUP for a multiple-variation listing.

This field is only returned if the ad is associated with a SKU or an inventory item group value.

Occurrence: Always

listingIdstring

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.

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

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

GEThttps://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.