<!--
{
  "availability" : [
    "Apple Ads Platform API: 1.0.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "Apple-Ads-Platform-API",
  "identifier" : "/documentation/Apple-Ads-Platform-API/GeoSearchResponse",
  "metadataVersion" : "0.1.0",
  "role" : "Object",
  "symbol" : {
    "kind" : "Object",
    "modules" : [
      "Apple Ads Platform API"
    ],
    "preciseIdentifier" : "data:apple-ads-platform-api:GeoSearchResponse"
  },
  "title" : "GeoSearchResponse"
}
-->

# GeoSearchResponse

Response envelope for the geo location search endpoints.

```
object GeoSearchResponse
```

## Discussion

The `GeoSearchResponse` object is the response envelope for both `GET /v1/search/geo` ([`Search Geo Locations`](/documentation/Apple-Ads-Platform-API/Searches-for-a-list-of-geo-locations)) and `POST /v1/search/geo` ([`Query Geo Locations`](/documentation/Apple-Ads-Platform-API/Gets-a-list-of-geo-locations)). The `result` array contains [`SearchEntity`](/documentation/Apple-Ads-Platform-API/SearchEntity) objects sorted alphabetically by `displayName`. To determine how many pages of results are available and iterate using `offset`, use the `pagination.totalCount` value.

Each `SearchEntity` in the array includes `id` (numeric string, use as targeting value in ad group `targetingDimensions`), `legacyId` (pipe-delimited hierarchy for human reference), `entity` type, localized `displayName`, `countryOrRegion`, `adminArea`, `locality`, `postalCode`, and an `eligibility` object scoped to the `supplySource` specified in the request. If `eligibility` is absent from the response, no restrictions apply for that supply source.

If the request is invalid, for example an unknown supply source or a query string shorter than two characters, the API returns an HTTP error status with a structured error body rather than this response.

### Example

```json
{
  "result": [
    {
      "id": "11390462",
      "legacyId": "US|CA|San Francisco",
      "entity": "Locality",
      "displayName": "San Francisco, California, United States",
      "countryOrRegion": "US",
      "adminArea": "CA",
      "locality": "San Francisco"
    }
  ],
  "pagination": {
    "totalCount": 1,
    "offset": 0,
    "pageSize": 20
  }
}
```

---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)