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

# SearchEntity

A single geographic location result returned by the geo search endpoints.

```
object SearchEntity
```

## Discussion

The `SearchEntity` object is a single geographic location result returned by the geo search endpoints. It provides multiple identifiers for the same location: `id` (numeric) for use as a targeting value in `AdGroupTargeting`, and `legacyId` (pipe-delimited) for human-readable reference. The `entity` field classifies the geographic granularity from `Country` down to `PostalCode`.

The `eligibility` field indicates whether you can use the location for ads on the requested supply source.

- If `eligibility` is absent from the response, no restrictions apply.
- If it contains `blockedGroups`, the location has one or more blocking reasons for that supply source (for example, low search volume, sparse coverage, or a hard-block condition), but the API still returns it with this data so the client can decide how to present it.
- The API scopes eligibility to the single `supplySource` specified in the request.
- The response includes only `blockedGroups` matching that supply source.

### Example

```json
{
  "id": "555666777",
  "legacyId": "US|CA|San Francisco|94103",
  "entity": "PostalCode",
  "displayName": "94103, San Francisco, California, United States",
  "countryOrRegion": "US",
  "adminArea": "CA",
  "postalCode": "94103",
  "eligibility": {
    "blockedGroups": [
      {
        "supplySource": ["MAPS"],
        "reasons": ["POSTAL_CODE_SPARSE"]
      }
    ]
  }
}
```

## Topics

### Dictionaries

[`object SearchEntity.Eligibility`](/documentation/Apple-Ads-Platform-API/SearchEntity/Eligibility-data.dictionary)

Supply source eligibility restrictions for this search entity.

---

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)