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
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 associated with the ads being retrieved. Use the getCampaigns method to retrieve campaign IDs. Occurrence: Required |
| listing_ids | string | A comma-separated list of listing IDs. Note: The response includes only active ads. The results do not include listing IDs that are excluded by other conditions. Occurrence: Optional |
| limit | string | Specifies the maximum number of ads to return on a page in the paginated response. Default: 10 Maximum: 500 Occurrence: Optional |
| offset | string | Specifies 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 Default: 0 Occurrence: Optional |
| ad_group_ids | string | A comma-separated list of ad group IDs. The results will be filtered to only include active ads for these ad groups. Use the getAdGroups method to retrieve the ad group ID for the ad group. Note: This field only applies to the Cost Per Click (CPC) funding model; it does not apply to the Cost Per Sale (CPS) funding model. Occurrence: Optional |
| ad_status | string | A comma-separated list of ad statuses. The results will be filtered to only include the given statuses of the ad. If none are provided, all ads are returned. See AdStatusEnum for supported values. Occurrence: Optional |
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 | The list of ads that matched the request criteria. 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. Note: This field has a minimum value of 2.0 and a maximum value of 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 |
| href | string | The URI of the current page of results from the result set. Occurrence: Always |
| limit | integer | The 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. Default: Occurrence: Always |
| next | string | The call URI that can be used to retrieve the next page in the result set. Basically, all of the request parameters will remain the same except the offset value, which will be increased to retrieve the next page of results. Occurrence: Conditional |
| offset | integer | The number of results skipped in the result set before listing the first result on the current page. This value can be set in the request with the offset query parameter. If the offset value is not set, it defaults to zero. Default: Note: The items in a paginated result set use a zero-based list where the first item in the list has an offset of Occurrence: Conditional |
| prev | string | The call URI that can be used to retrieve the previous page in the result set. Basically, all of the request parameters will remain the same except the offset value, which will be decreased to retrieve the previous page of results. Occurrence: Conditional |
| total | integer | The total number of items retrieved in the result set. 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. |
| 35013 | API_MARKETING | REQUEST | The listing ID {listingId} is not valid. |
| 35029 | API_MARKETING | REQUEST | The 'limit' has to be greater than zero and less than {maxLimitValue}. |
| 35030 | API_MARKETING | REQUEST | The 'offset' cannot be less than zero. |
| 35035 | API_MARKETING | REQUEST | The campaign with campaign id {campaign_id} has ended. |
| 35045 | API_MARKETING | REQUEST | No campaign found for campaign id {campaign_id}. |
| 35068 | API_MARKETING | BUSINESS | You have exceeded the maximum number of listing IDs. Only {maxSupportedNumber} listings are supported per call. |
| 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. |
| 35083 | API_MARKETING | REQUEST | The requested 'adStatus' is not valid. |
| 36106 | API_MARKETING | REQUEST | The 'ad_group_ids' is not supported for CPS funding model. |
| 36412 | API_MARKETING | REQUEST | Campaigns where the 'campaignTargetingType' is 'SMART' do not support ad groups. Please remove the {adGroupFieldName} and try again. |
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 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.
GEThttps://api.ebay.com/sell/marketing/v1/ad_campaign/1********4/ad
Output
The output is an array of the ads in the campaign.