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

# GeoSearchPostRequest

Request body for querying geo locations.

```
object GeoSearchPostRequest
```

## Discussion

The `GeoSearchPostRequest` object is the request body for the `POST /v1/search/geo` ([`Query Geo Locations`](/documentation/Apple-Ads-Platform-API/Gets-a-list-of-geo-locations)) endpoint. It accepts an array of [`GeoRequest`](/documentation/Apple-Ads-Platform-API/GeoRequest) objects, each specifying a geo entity, and returns eligibility data for all of them in a single call scoped to the specified `supplySource`. Use this for batch-validating a list of location IDs before setting them as ad group targeting values.

Each `GeoRequest` must supply exactly one of `id` (numeric `geo_location_id`) or `legacyId` (pipe-delimited string such as `US|CA|San Francisco`) plus the required `entity` field. The response is a [`GeoSearchResponse`](/documentation/Apple-Ads-Platform-API/GeoSearchResponse) containing a `result` array of matching entities.

Available results and entity restrictions differ by `supplySource`, as shown below:

|`supplySource`|Behavior                                                                                                                               |
|--------------|---------------------------------------------------------------------------------------------------------------------------------------|
|`APPSTORE`    |Returns results for App Store campaigns. `PostalCode` entities are excluded.                                                           |
|`MAPS`        |Returns results for Apple Maps campaigns. Restricted to US and CA. `Country` entity type excluded. `PostalCode` entities are available.|

### Example

```json
{
  "geoRequest": [
    {
      "id": "123456789",
      "entity": "AdminArea"
    },
    {
      "legacyId": "US|CA|San Francisco",
      "entity": "Locality"
    }
  ],
  "supplySource": "APPSTORE",
  "pagination": {
    "offset": 0,
    "pageSize": 20
  }
}
```

## Topics

### Type Aliases

[`string GeoSearchPostRequest.SupplySource`](/documentation/Apple-Ads-Platform-API/GeoSearchPostRequest/SupplySource-data.typealias)

The supply source context that scopes a geo location search to App Store or Apple Maps eligibility rules.

---

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)