Skip to main content

GET/ad_campaign/{campaign_id}/ad_group/{ad_group_id}

Note: This is a Limited ReleaseLimited Release API service that is available only to select partners who have been approved for the eBay Promoted Listings Advanced (PLA) program. For details about how to request access to this program, see Promoted Listings Advanced Access Requests in the Promoted Listings Playbook.
This method retrieves the details of a specified ad group, such as the ad group’s default bid and status.

In the request, specify the campaign_id and ad_group_id as path parameters.

Call getCampaigns to retrieve a list of the current campaign IDs for a seller and call getAdGroups for the ad group ID of the ad group you wish to retrieve.

Input

Resource URI (production)

GET https://api.ebay.com/sell/marketing/v1/ad_campaign/{campaign_id}/ad_group/{ad_group_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_group_idstringThe ID of the ad group that shall be retrieved.

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.

Occurrence: Always

adGroupStatusAdGroupStatusEnum

An enumeration value representing the current status of the ad group.

Valid Values:

  • ACTIVE
  • PAUSED
  • ARCHIVED

Occurrence: Always

defaultBidAmount

A bid amount that applies to all of the keywords in an ad group that do not have individual bids. For all keywords without individual bids, the default bid is the amount that the seller will pay per click for the listings in the ad group in the promoted listings campaign.

Valid Values: 0.5, 0.75

Occurrence: Always

defaultBid.currencyCurrencyCodeEnum

The base currency applied to the value field to establish a monetary amount.

The currency is represented as a 3-letter ISO 4217 currency code. For example, the code for the Canadian Dollar is CAD.

Default: The default currency of the eBay marketplace that hosts the listing.

Occurrence: Conditional

defaultBid.valuestring

The monetary amount in the specified currency.

Required in the amount type.

Occurrence: Conditional

namestring

The seller-defined name of the ad group.

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
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.
35045API_MARKETINGREQUESTNo campaign found for campaign id {campaign_id}.
36210API_MARKETINGREQUESTNo ad group found for ad group id {ad_group_id}.
36213API_MARKETINGBUSINESSThe campaign funding model should be CPC. Please check funding model for provided 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: Retreive Ad Group Details

This example retrieves the details for an existing ad group.

Input

The inputs for this sample are the campaign_id and the ad_group_id of the PLA ad campaign and the ad group for which the details shall be retrieved.

GEThttps://api.ebay.com/sell/marketing/v1/ad_campaign/1********4/ad_group/1********3

Output

If the call is successful, the details for the specified ad group are retrieved.