getAdGroups: eBay Marketing API | eBay Developers Program

GET/ad_campaign/{campaign_id}/ad_group

Note: This method is only available for select partners who have been approved for the eBay priority strategy program. For information about how to request access to this program, refer to Priority Strategy Access Requests in the Promoted Listings Playbook. To determine if a seller qualifies for priority strategy, use the getAdvertisingEligibility method in Account API.
This method retrieves ad groups for the specified campaigns.

Each campaign can only have one ad group.

In the request, supply the campaign_ids as path parameters.

Call getCampaigns to retrieve a list of the current campaign IDs for a seller.

Input

Resource URI

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

limit=string&

offset=string&

ad_group_status=string

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 ad groups being retrieved. Use the getCampaigns method to retrieve campaign IDs. Occurrence: Required
limit	string	The number of results, from the current result set, to be returned in a single page. Occurrence: Optional
offset	string	The number of results that will be skipped in the result set. This is used with the limit field to control the pagination of the output. For example, if the offset is set to `0` and the limit is set to `10`, the method will retrieve items 1 through 10 from the list of items returned. If the offset is set to `10` and the limit is set to `10`, the method will retrieve items 11 through 20 from the list of items returned. Default: `0` Occurrence: Optional
ad_group_status	string	A comma-separated list of ad group statuses. The results will be filtered to only include the given statuses of the ad group. See AdGroupStatusEnum 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

Copy complete valid JSON to clipboard

{ /* AdGroupPagedCollectionResponse */

"adGroups" : [

{ /* AdGroup */

"adGroupId" : "string",

"adGroupStatus" : "AdGroupStatusEnum : [ACTIVE,PAUSED,ARCHIVED]",

"defaultBid" :

{ /* Amount */

"currency" : "CurrencyCodeEnum : [AED,AFN,ALL...]",

"value" : "string"

"name" : "string"

}

"href" : "string",

"limit" : "integer",

"next" : "string",

"offset" : "integer",

"prev" : "string",

"total" : "integer"

}

Response fields

Output container/field	Type	Description
adGroups	array of AdGroup	The details of existing ad groups, such as the name, ID, and status of the ad groups. Occurrence: Always
adGroups.adGroupId	string	A unique eBay-assigned ID for an ad group in a campaign that uses the Cost Per Click (CPC) funding model. Occurrence: Always
adGroups.adGroupStatus	AdGroupStatusEnum	An enumeration value representing the current status of the ad group. Valid Values: `ACTIVE` `PAUSED` `ARCHIVED` Occurrence: Always
adGroups.defaultBid	Amount	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
adGroups.defaultBid.currency	CurrencyCodeEnum	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` Occurrence: Conditional
adGroups.defaultBid.value	string	The monetary amount in the specified currency. Required in the amount type. Occurrence: Conditional
adGroups.name	string	The seller-defined name of the ad group. 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. Occurrence: Always
next	string	The call URI that can be used to retrieve the next page in the result set. This value is returned only if there is an additional page of results to display from the result set. Occurrence: Conditional
offset	integer	The 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. Default: 0 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: Always
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. Note: If no items are found, this field is returned with a value of `0`. 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.
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.
35045	API_MARKETING	REQUEST	No campaign found for campaign id {campaign_id}.
35129	API_MARKETING	BUSINESS	This method is not supported for campaigns with smart targeting type.

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 Multiple Ad Groups

This example retrieves all ad groups for the specified priority strategy ad campaign.

Input

The input for this sample is the campaign_id of the priority ad campaign for which the ad groups shall be retrieved.

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

Output

If the call is successful, the ad groups for the specified ad campaign are retrieved.