Create an Ad Group
Creates an ad group as part of a campaign.
URL
POST https://api.searchads.apple.com/api/v5/campaigns/{campaignId}/adgroupsPath Parameters
| Name | Type | Description |
|---|---|---|
campaignId Required | int64 | The unique identifier for the campaign. |
Response Codes
| Status | Reason | Type | Description |
|---|---|---|---|
| 200 | OK Content-Type: application/json | AdGroupResponse | If the call succeeds, the API returns the AdGroup object in the response payload with an HTTP status code of |
| 400 | Bad Request Content-Type: application/json | ApiErrorResponse | An invalid query or missing required parameters. |
| 401 | Unauthorized Content-Type: application/json | ApiErrorResponse | An unauthenticated call fails to get the requested response. |
| 403 | Forbidden Content-Type: application/json | ApiErrorResponse | Insufficient rights to the resource. |
| 404 | Not Found Content-Type: application/json | ApiErrorResponse | The API can’t locate the resource. |
| 429 | Content-Type: application/json | ApiErrorResponse | The API calls exceed rate-limit thresholds. See the Rate Limits subsection of Calling the Apple Ads API. |
| 500 | Internal Server Error Content-Type: application/json | ApiErrorResponse | The Apple Ads server is temporarily down or unreachable. The request may be valid, but you need to retry it later. |
Mentioned in
Discussion
To create ad groups, use the associated campaignId as a resource in the URI. In the request, specify TargetingDimensions and apply it to ad groups.
Payload example: Create an ad group with targeting
Payload example: Create an ad group without targeting
Payload example: Create an automated ad group in a campaign with a Maximize Conversions bid strategy
A Maximize Conversions campaign will return an error of AUTOMATED_KEYWORDS_REQUIRED_AD_GROUP_MISSING and not run until an automated ad group is created.
In automated ad groups:
Search Match can’t be turned off.
Audience settings and keywords can’t be edited but optional ad groups can be added to the campaign and include audience settings and keywords.
Negative keywords can be added.
A Maximize Conversions bid strategy requires the use of Search Match and an automatically created ad group. See AdGroup for more details on fields and see Ad Groups for details on Search Match. See payload example in Create a Campaign to create a Maximize Conversions campaign.
Payload example: Create an ad group with a campaign with a Maximize Conversions bid strategy
In maximize conversions campaigns:
Bid values automatically managed and returned as
0.Custom ads can be created in standard ad groups in both Maximize Conversions and manual campaigns.
HTTP Body
The request body that includes the details of the ad group and campaign.