Partager via

GeocodingBatchRequestItem interface

  • Référence
Paquet:
@azure-rest/maps-search

Objet Batch Query

Propriétés

addressLine

Ligne de rue officielle d’une adresse relative à la zone, comme spécifié par la localité, ou postalCode, propriétés. L’utilisation classique de cet élément serait de fournir une adresse postale ou toute adresse officielle.

Si la requête est donnée, ne doit pas utiliser ce paramètre.
adminDistrict

Partie de la subdivision de pays d’une adresse, telle que WA.

Si la requête est donnée, ne doit pas utiliser ce paramètre.
adminDistrict2

Le comté pour l’adresse structurée, comme King.

Si la requête est donnée, ne doit pas utiliser ce paramètre.
adminDistrict3

Zone nommée pour l’adresse structurée.

Si la requête est donnée, ne doit pas utiliser ce paramètre.
bbox

Zone rectangulaire sur la terre définie comme un objet de cadre englobant. Les côtés des rectangles sont définis par des valeurs de longitude et de latitude. Pour plus d’informations, consultez Types d’emplacement et de zone. Lorsque vous spécifiez ce paramètre, la zone géographique est prise en compte lors du calcul des résultats d’une requête d’emplacement.

Exemple : [lon1, lat1, lon2, lat2]
coordinates

Point sur la Terre spécifié sous forme de longitude et de latitude. Lorsque vous spécifiez ce paramètre, l’emplacement de l’utilisateur est pris en compte et les résultats retournés peuvent être plus pertinents pour l’utilisateur. Exemple : [lon, lat]
countryRegion

Limitez le résultat du géocodage à un code de région/pays ISO 3166-1 Alpha-2 spécifié, par exemple FR. Cela limitera la recherche à la région spécifiée.

Si la requête est donnée, ne doit pas utiliser ce paramètre.
locality

Partie de localité d’une adresse, par exemple Seattle.

Si la requête est donnée, ne doit pas utiliser ce paramètre.
optionalId

ID de la requête qui s’affiche dans batchItem correspondant
postalCode

Partie du code postal d’une adresse.

Si la requête est donnée, ne doit pas utiliser ce paramètre.
query

Chaîne qui contient des informations sur un emplacement, telles qu’une adresse ou un nom de point de repère.
top

Nombre maximal de réponses qui seront retournées. Valeur par défaut : 5, minimum : 1 et maximum : 20.
view

Chaîne qui spécifie un code de région/pays ISO 3166-1 Alpha-2. Cela modifie les frontières et les étiquettes géopolitiques contestées pour qu’elles s’alignent sur la région utilisateur spécifiée.

Détails de la propriété

addressLine

Ligne de rue officielle d’une adresse relative à la zone, comme spécifié par la localité, ou postalCode, propriétés. L’utilisation classique de cet élément serait de fournir une adresse postale ou toute adresse officielle.

Si la requête est donnée, ne doit pas utiliser ce paramètre.

addressLine?: string

Valeur de propriété

string

adminDistrict

Partie de la subdivision de pays d’une adresse, telle que WA.

Si la requête est donnée, ne doit pas utiliser ce paramètre.

adminDistrict?: string

Valeur de propriété

string

adminDistrict2

Le comté pour l’adresse structurée, comme King.

Si la requête est donnée, ne doit pas utiliser ce paramètre.

adminDistrict2?: string

Valeur de propriété

string

adminDistrict3

Zone nommée pour l’adresse structurée.

Si la requête est donnée, ne doit pas utiliser ce paramètre.

adminDistrict3?: string

Valeur de propriété

string

bbox

Zone rectangulaire sur la terre définie comme un objet de cadre englobant. Les côtés des rectangles sont définis par des valeurs de longitude et de latitude. Pour plus d’informations, consultez Types d’emplacement et de zone. Lorsque vous spécifiez ce paramètre, la zone géographique est prise en compte lors du calcul des résultats d’une requête d’emplacement.

Exemple : [lon1, lat1, lon2, lat2]

bbox?: number[]

Valeur de propriété

number[]

coordinates

Point sur la Terre spécifié sous forme de longitude et de latitude. Lorsque vous spécifiez ce paramètre, l’emplacement de l’utilisateur est pris en compte et les résultats retournés peuvent être plus pertinents pour l’utilisateur. Exemple : [lon, lat]

coordinates?: number[]

Valeur de propriété

number[]

countryRegion

Limitez le résultat du géocodage à un code de région/pays ISO 3166-1 Alpha-2 spécifié, par exemple FR. Cela limitera la recherche à la région spécifiée.

Si la requête est donnée, ne doit pas utiliser ce paramètre.

countryRegion?: string

Valeur de propriété

string

locality

Partie de localité d’une adresse, par exemple Seattle.

Si la requête est donnée, ne doit pas utiliser ce paramètre.

locality?: string

Valeur de propriété

string

optionalId

ID de la requête qui s’affiche dans batchItem correspondant

optionalId?: string

Valeur de propriété

string

postalCode

Partie du code postal d’une adresse.

Si la requête est donnée, ne doit pas utiliser ce paramètre.

postalCode?: string

Valeur de propriété

string

query

Chaîne qui contient des informations sur un emplacement, telles qu’une adresse ou un nom de point de repère.

query?: string

Valeur de propriété

string

top

Nombre maximal de réponses qui seront retournées. Valeur par défaut : 5, minimum : 1 et maximum : 20.

top?: number

Valeur de propriété

number

view

Chaîne qui spécifie un code de région/pays ISO 3166-1 Alpha-2. Cela modifie les frontières et les étiquettes géopolitiques contestées pour qu’elles s’alignent sur la région utilisateur spécifiée.

view?: string

Valeur de propriété

string