Find Ad Groups
Fetches ad groups within a campaign.
URL
POST https://api.searchads.apple.com/api/v5/campaigns/{campaignId}/adgroups/findPath 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 | AdGroupListResponse | 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
Use this endpoint to find ad groups within campaigns using the associated campaignId in the resource path. Use a Selector Condition to narrow results. If you don’t specify selector conditions, all ad groups in campaigns return. See the AdGroup object for field descriptions and selector condition operators.
Payload example: Find ad groups
HTTP Body
The request body that includes the selector Condition. Selector objects define what data the API returns when fetching resources.