---
title: SearchEntity
framework: Apple Ads Platform API
role: symbol
role_heading: Object
platforms: [apple ads platform api 1.0+]
path: apple-ads-platform-api/searchentity
---

# SearchEntity

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

## Declaration

```data
object SearchEntity
```

## Properties

id: Numeric geo location identifier. Example: "11390462". Read-only. legacyId: Pipe-delimited geo identifier encoding the hierarchy. Examples: US, US|CA, US|CA|San Francisco, US|TX|78238. Read-only. entity: Geo entity type. Values: Country, AdminArea, Locality, PostalCode. Read-only. displayName: Localized display name with full hierarchy. Example: "San Francisco, California, United States". Read-only. countryOrRegion: ISO 3166-1 alpha-2 country code. Read-only. adminArea: State or province identifier. Present for AdminArea, Locality, and PostalCode entities. Read-only. locality: City or locality name. Present for Locality entities only. Read-only. postalCode: Postal code value. Present for PostalCode entities only. Read-only. eligibility: Supply source eligibility restrictions scoped to the supplySource specified in the request. See GeoEligibility. Absent from the response when no restrictions apply. Read-only.

## Discussion

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 {   "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

- [SearchEntity.Eligibility](apple-ads-platform-api/searchentity/eligibility-data.dictionary.md)

## See Also

- [GeoRequest](apple-ads-platform-api/georequest.md)
- [GeoSearchPostRequest](apple-ads-platform-api/geosearchpostrequest.md)
- [GeoSearchResponse](apple-ads-platform-api/geosearchresponse.md)
- [GeoSearchPagination](apple-ads-platform-api/geosearchpagination.md)
- [GeoEligibility](apple-ads-platform-api/geoeligibility.md)
- [GeoBlockedGroup](apple-ads-platform-api/geoblockedgroup.md)