GeoBlockedGroup

A blocking rule that names the supply source(s) and reason code(s) restricting a geo location.

Declaration

object GeoBlockedGroup

Properties

Name	Type	Description
`supplySource`	[`SearchSupplySourceType`]	Array of supply source strings this restriction applies to. Values: `APPSTORE`, `MAPS`. Read-only.
`reasons`	[string]	Array of reason codes for the eligibility restriction. See reason codes below. Read-only.

Discussion

The GeoEligibility responses embed GeoBlockedGroup. It describes why a geographic location is blocked for the given supply source. The reasons array mixes two categories of codes with different behavior:

The API always filters hard-block reasons (NO_MUID, NOT_SUPPORTED, SOURCE_REMOVED, COUNTRY_NOT_SUPPORTED, COUNTRY_NOT_SEARCHABLE, MAPS_SOURCE_NOT_MATCHED) out of search results, regardless of request parameters.
The API includes soft-block reasons (LOCALITY_LOW_SEARCH_VOLUME, POSTAL_CODE_SPARSE) in search results by default so clients can decide how to handle them. Pass eligible=true to the GET endpoint to exclude these geos from results entirely as well.

Example

{
  "supplySource": [
    "MAPS"
  ],
  "reasons": [
    "COUNTRY_NOT_SUPPORTED",
    "LOCALITY_LOW_SEARCH_VOLUME"
  ]
}

`reasons` accepted values

Hard-block (always filtered from results):

NO_MUID: No Maps ID. The geo cannot serve in MAPS.
NOT_SUPPORTED: The geo is not supported for this supply source.
SOURCE_REMOVED: The geo has been removed from the Maps source table.
COUNTRY_NOT_SUPPORTED: The country is not in the MAPS program.
COUNTRY_NOT_SEARCHABLE: Country-level geos are not searchable in MAPS.
MAPS_SOURCE_NOT_MATCHED: The geo is not present in Maps data.

Soft-block (included by default, filtered only when eligible=true):

LOCALITY_LOW_SEARCH_VOLUME: The locality has insufficient Maps search volume.
POSTAL_CODE_SPARSE: The postal code has sparse Maps coverage.