POST/ad_campaign/{campaign_id}/ad_group
Note: This method is only available for select partners who have been approved for the eBay Promoted Listings Advanced (PLA) program. For information about how to request access to this program, refer to Promoted Listings Advanced Access Requests in the Promoted Listings Playbook. To determine if a seller qualifies for PLA, use the getAdvertisingEligibility method in Account API.
This method adds an ad group to an existing PLA campaign that uses the Cost Per Click (CPC) funding model.
To create an ad group for a campaign, specify the defaultBid for the ad group in the payload of the request. Then specify the campaign to which the ad group should be associated using the campaign_id path parameter.
Each campaign can have one or more associated ad groups.
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 | A 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 |
HTTP request headers
All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.
The table below shows additional HTTP request headers that are either required, conditionally required, or strongly recommended for this method. Other standard HTTP request headers- opens rest request components page (not in this table) can also be used, but they are optional.
| Header | Type | Description |
|---|---|---|
| Content-Type | string | This header indicates the format of the request body provided by the client. Its value should be set to application/json. For more information, refer to HTTP request headers. Occurrence: Required |
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
See OAuth access tokens for more information.
Request payload
Copy complete valid JSON to clipboardRequest fields
| Input container/field | Type | Description |
|---|---|---|
| defaultBid | Amount | A bid amount that applies to all of the keywords in an ad group that do not have individual bids. Occurrence: Required |
| defaultBid.currency | CurrencyCodeEnum | The base currency applied to the value field to establish a monetary amount. Occurrence: Conditional |
| defaultBid.value | string | The monetary amount in the specified currency. Occurrence: Conditional |
| name | string | The seller-defined name of the ad group. Occurrence: Required |
Output
HTTP response headers
See HTTP response headers for details.
| Header | Meaning |
|---|---|
| Location | The location response header contains the getAdGroup URL to the newly created ad group. The URL includes the newly assigned adGroupID, which you can use to retrieve the ad group. |
Response payload
This call has no payload.
Response fields
This call has no field definitions.
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 |
|---|---|
| 201 | Created |
| 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. |
| 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}. |
| 35089 | API_MARKETING | BUSINESS | We are currently testing a premium ads product with a small invite-only group. We will share more information when we are ready to expand. |
| 36201 | API_MARKETING | REQUEST | An ad group with name {name} already exists for this campaign. |
| 36202 | API_MARKETING | REQUEST | The ad group name cannot be more than {maxAdGroupNameLength} characters. |
| 36203 | API_MARKETING | REQUEST | The 'defaultBid' value {defaultBidValue} is not valid. The default bid value should be a double precision value. |
| 36204 | API_MARKETING | REQUEST | The 'defaultBid' currency {defaultBidCurrency} is not valid or missing. |
| 36205 | API_MARKETING | REQUEST | The 'defaultBid' value {defaultBidValue} is below floor value {bidFloorValue}. |
| 36206 | API_MARKETING | REQUEST | The 'defaultBid' value {defaultBidValue} is above max value {bidMaxValue}. |
| 36207 | API_MARKETING | REQUEST | The 'defaultBid' value {defaultBidValue} is more than daily budget. |
| 36212 | API_MARKETING | REQUEST | The 'defaultBid' currency {defaultBidCurrency} should be the same as the daily budget. |
| 36213 | API_MARKETING | BUSINESS | The campaign funding model should be CPC. Please check funding model for provided campaign id. |
| 36214 | API_MARKETING | REQUEST | Ad Group name is required for this call. |
| 36215 | API_MARKETING | REQUEST | The 'defaultBid' is required for this call. |
| 36216 | API_MARKETING | REQUEST | The 'defaultBid' value is required for this call. |
| 36217 | API_MARKETING | REQUEST | The Ad Group name contains invalid characters. {notAllowedCharacters} are not allowed. |
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: Create an Ad Group
This example creates an ad group for an existing Promoted Listings Advanced (PLA) ad campaign.
Input
The input for this sample is the campaign_id of the PLA ad campaign for which the ad group shall be created, as well as the name of the ad group and the defaultBid details for the ad group.
POSThttps://api.ebay.com/sell/marketing/v1/ad_campaign/1********4/ad_group
Output
A successful call returns the HTTP status code 201 Created. In addition, the response includes a location response header that contains the URI for the newly-created ad group.
This method has no response payload.