Get Location Group
Retrieve a single location group by its unique identifier.
URL
GET https://api.ads.apple.com/v1/location-groups/{id}Path Parameters
| Name | Type | Description |
|---|---|---|
id Required | string |
Header Parameters
| Name | Type | Description |
|---|---|---|
X-Ap-Context Required | string |
Response Codes
| Status | Reason | Type | Description |
|---|---|---|---|
| 200 | OK Content-Type: application/json | LocationGroupResponse | |
| 400 | Bad Request Content-Type: application/json | Error | |
| 401 | Unauthorized Content-Type: application/json | Error | |
| 403 | Forbidden Content-Type: application/json | Error | |
| 404 | Not Found Content-Type: application/json | ErrorResponse | |
| 429 | Too Many Requests Content-Type: application/json | Error | |
| 500 | Internal Server Error Content-Type: application/json | Error |
Discussion
This endpoint returns the full state of a location group, including its membership definition, current systemStatus, groupTotal, and eligibility. To confirm a group was created correctly, or to inspect its current membership before attaching it to an ad group’s targeting configuration, use this endpoint.
The response’s systemStatus field can take any of the following values:
Status | Meaning |
|---|---|
| The group is fully evaluated and eligible for use in targeting. |
| The system is evaluating the group’s dynamic rules. |
| One or more issues prevent the group from serving. Inspect |
| The group has been soft-deleted and is no longer available for targeting. |
The PENDING status appears immediately after a DYNAMIC group is created or after its rules are updated. The STATIC groups transition directly to VALID because membership is explicit and requires no evaluation.
Fetching a group by ID differs from a bulk query in a couple of ways:
Constraint | Detail |
|---|---|
Single group only | Retrieves one group by ID. Use Query Location Groups to retrieve multiple groups with filters. |
Deleted groups | Soft-deleted groups are still retrievable by ID. They appear in the response with |