Get a List of Geo Locations
Gets geolocation details using a geoidentifier.
URL
POST https://api.searchads.apple.com/api/v5/search/geoQuery Parameters
| Name | Type | Description |
|---|---|---|
limit Optional | int32 | The limit on the number of geolocations in the response. |
offset Optional | int32 | The offset pagination that limits the number of returned records. The start of each page is offset by the specified number. You can apply |
Response Codes
| Status | Reason | Type | Description |
|---|---|---|---|
| 200 | OK Content-Type: application/json | SearchEntityListResponse | If the call succeeds, the API returns a list of SearchEntity objects 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. |
Discussion
Use a geo id in the request payload to return a corresponding displayName and geolocation.
Payload Example: Get a list of geolocations
HTTP Body
The georequest body.