Partager via


Search - Get Search Address

Permet d’obtenir les coordonnées de latitude et de longitude d’une adresse postale dans un format d’entrée non structuré ou de requête.

L’API Get Search Address est une requête HTTP GET qui retourne les coordonnées de latitude et de longitude lorsqu’elles sont passées dans une adresse postale ou le nom d’un lieu en tant que critères de recherche.

Dans de nombreux cas, le service de recherche complet peut être trop important, pour instance si vous n’êtes intéressé que par le géocodage traditionnel. Recherche sont également accessibles exclusivement pour la recherche d’adresse. Le géocodage est effectué en appuyant sur le point de terminaison de géocode avec uniquement l’adresse ou l’adresse partielle en question. L’index de recherche de géocodage sera interrogé pour tout ce qui se trouve au-dessus des données au niveau de la rue. Aucun point d’arrêt n’est retourné. Notez que le géocodeur est très tolérant aux fautes de frappe et aux adresses incomplètes. Il s’occupera également de tout, des adresses postales exactes ou des rues ou intersections ainsi que des zones géographiques de niveau supérieur telles que les centres-villes, les comtés, les états, etc.

GET https://atlas.microsoft.com/search/address/{format}?api-version=1.0&query={query}
GET https://atlas.microsoft.com/search/address/{format}?api-version=1.0&query={query}&typeahead={typeahead}&limit={limit}&ofs={ofs}&countrySet={countrySet}&lat={lat}&lon={lon}&radius={radius}&topLeft={topLeft}&btmRight={btmRight}&language={language}&extendedPostalCodesFor={extendedPostalCodesFor}&entityType={entityType}&view={view}

Paramètres URI

Nom Dans Obligatoire Type Description
format
path True

ResponseFormat

Format souhaité de la réponse. La valeur peut être json ou xml.

api-version
query True

string

Numéro de version de l’API Azure Maps.

query
query True

string

L’adresse à rechercher (par exemple, « 1 Microsoft way, Redmond, WA ») doit être correctement codée sur l’URL.

btmRight
query

string

Position inférieure droite du cadre englobant. Par exemple, 37.553,-122.453

countrySet
query

string[]

Chaîne séparée par des virgules de codes pays/régions, par exemple FR,ES. Cela limitera la recherche aux pays/régions spécifiés.

entityType
query

GeographicEntityType

Spécifie le niveau de filtrage effectué sur les zones géographiques. Réduit la recherche des types d’entités géographiques spécifiés, par exemple, renvoyer uniquement une municipalité. La réponse obtenue contient l’ID de géographie, ainsi que le type d’entité mis en correspondance. Si vous fournissez plusieurs entités en tant que liste séparée par des virgules, le point de terminaison retourne la « plus petite entité disponible ». L’ID geometry retourné peut être utilisé pour obtenir la géométrie de cette zone géographique via Obtenir Recherche API Polygone. Les paramètres suivants sont ignorés lorsque entityType est défini :

  • Rubrique
  • nombre
  • returnRoadUse
  • returnSpeedLimit
  • roadUse
  • returnMatchType
extendedPostalCodesFor
query

SearchIndexes[]

Index pour lesquels les codes postaux étendus doivent être inclus dans les résultats.

Les index disponibles sont les suivants :

Addr = Plages d’adresses

Géo = Zones géographiques

PAD = Adresses de point

POI = Points d’intérêt

Str = Rues

XStr = Rues croisées (intersections)

La valeur doit être une liste séparée par des virgules de types d’index (dans n’importe quel ordre) ou Aucun pour aucun index.

Par défaut, les codes postaux étendus sont inclus pour tous les index à l’exception de Geo. Les listes de codes postaux étendues pour les zones géographiques peuvent être assez longues et doivent donc être demandées explicitement en cas de besoin.

Exemples d'utilisation :

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=None

Le code postal étendu est retourné en tant que propriété extendedPostalCode d’une adresse. La disponibilité dépend de la région.

language
query

string

Langue dans laquelle les résultats de la recherche doivent être retournés. Doit être l’une des balises de langue IETF prises en charge, ne respectant pas la casse. Lorsque les données dans la langue spécifiée ne sont pas disponibles pour un champ spécifique, la langue par défaut est utilisée.

Pour plus d’informations, consultez Langues prises en charge .

lat
query

number

double

Latitude où les résultats doivent être biaisés. Par exemple, 37,337

limit
query

integer

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

lon
query

number

double

Longitude où les résultats doivent être biaisés. Par exemple , -121,89

ofs
query

integer

Décalage de départ des résultats retournés dans le jeu de résultats complet. Valeur par défaut : 0

radius
query

integer

Rayon en mètres à pour que les résultats soient limités à la zone définie

topLeft
query

string

Position supérieure gauche du cadre englobant. Par exemple, 37.553,-122.453

typeahead
query

boolean

Propriété booléenne. Si l’indicateur typeahead est défini, la requête est interprétée comme une entrée partielle et la recherche passe en mode prédictif

view
query

LocalizedMapView

Le paramètre View (également appelé paramètre « région utilisateur ») vous permet d’afficher les cartes correctes pour un pays/région spécifique pour les régions géopolitiquement contestées. Les différents pays/régions ont des vues différentes de ces régions, et le paramètre View permet à votre application de se conformer à l’affichage requis par le pays/la région que votre application servira. Par défaut, le paramètre View est défini sur « Unified », même si vous ne l’avez pas défini dans la requête. Il vous incombe de déterminer l'emplacement de vos utilisateurs, puis de définir correctement le paramètre Affichage correspondant à cet emplacement. Vous avez aussi la possibilité de définir le paramètre d’affichage « Vue=Auto », qui retourne les données cartographiques correspondant à l’adresse IP de la requête. Le paramètre View dans Azure Maps doit être utilisé conformément aux lois applicables, y compris celles relatives au mappage, du pays ou de la région où les cartes, images et autres données et contenus tiers auxquels vous êtes autorisé à accéder via Azure Maps sont disponibles. Exemple : view=IN.

Reportez-vous à Vues prises en charge pour plus d’informations et pour voir les vues disponibles.

En-tête de la demande

Nom Obligatoire Type Description
x-ms-client-id

string

Spécifie le compte destiné à être utilisé conjointement avec le modèle de sécurité Microsoft Entra ID. Il représente un ID unique pour le compte Azure Maps et peut être récupéré à partir de l’API compte du plan de gestion Azure Maps. Pour utiliser Microsoft Entra ID sécurité dans Azure Maps consultez les articles suivants pour obtenir des conseils.

Réponses

Nom Type Description
200 OK

SearchAddressResult

Ok

Other Status Codes

ErrorResponse

Une erreur inattendue s’est produite.

Sécurité

AADToken

Il s’agit des flux Microsoft Entra OAuth 2.0. Lorsqu’il est associé au contrôle d’accès en fonction du rôle Azure, il peut être utilisé pour contrôler l’accès à Azure Maps API REST. Les contrôles d’accès en fonction du rôle Azure sont utilisés pour désigner l’accès à un ou plusieurs Azure Maps compte de ressource ou sous-ressources. Tout utilisateur, groupe ou principal de service peut se voir accorder l’accès via un rôle intégré ou un rôle personnalisé composé d’une ou plusieurs autorisations pour Azure Maps API REST.

Pour implémenter des scénarios, nous vous recommandons d’afficher les concepts d’authentification. En résumé, cette définition de sécurité fournit une solution pour modéliser des applications via des objets capables de contrôler l’accès sur des API et des étendues spécifiques.

Notes

  • Cette définition de sécurité nécessite l’utilisation de l’en-tête x-ms-client-id pour indiquer à quelle ressource Azure Maps l’application demande l’accès. Vous pouvez l’acquérir à partir de l’API de gestion maps .
  • est Authorization URL spécifique au cloud public Azure instance. Les clouds souverains ont des URL d’autorisation et des configurations Microsoft Entra ID uniques.
  • Le contrôle d’accès en fonction du rôle Azure est configuré à partir du plan de gestion Azure via Portail Azure, PowerShell, CLI, kits SDK Azure ou API REST.
  • L’utilisation du Kit de développement logiciel (SDK) web Azure Maps permet une configuration basée sur la configuration d’une application pour plusieurs cas d’usage.
  • Pour plus d’informations sur Plateforme d'identités Microsoft, consultez Plateforme d'identités Microsoft vue d’ensemble.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
https://atlas.microsoft.com/.default https://atlas.microsoft.com/.default

subscription-key

Il s’agit d’une clé partagée qui est provisionnée lorsque vous créez un compte Azure Maps dans le Portail Azure ou à l’aide de PowerShell, cli, kits SDK Azure ou API REST.

Avec cette clé, n’importe quelle application peut accéder à toutes les API REST. En d’autres termes, cette clé peut être utilisée comme clé master dans le compte dans lequel elle est émise.

Pour les applications exposées publiquement, nous vous recommandons d’utiliser l’approche des applications clientes confidentielles pour accéder Azure Maps API REST afin que votre clé puisse être stockée en toute sécurité.

Type: apiKey
Dans: query

SAS Token

Il s’agit d’un jeton de signature d’accès partagé créé à partir de l’opération Répertorier les SAP sur la ressource Azure Maps via le plan de gestion Azure via Portail Azure, PowerShell, CLI, kits SDK Azure ou API REST.

Avec ce jeton, toute application est autorisée à accéder avec des contrôles d’accès en fonction du rôle Azure et un contrôle précis à l’expiration, au taux et à la ou les régions d’utilisation du jeton particulier. En d’autres termes, le jeton SAP peut être utilisé pour permettre aux applications de contrôler l’accès de manière plus sécurisée que la clé partagée.

Pour les applications exposées publiquement, nous vous recommandons de configurer une liste spécifique d’origines autorisées sur la ressource de compte Map afin de limiter les abus de rendu et de renouveler régulièrement le jeton SAS.

Type: apiKey
Dans: header

Exemples

Search detail address 15127 NE 24th Street, Redmond, WA 98052

Exemple de requête

GET https://atlas.microsoft.com/search/address/json?api-version=1.0&query=15127 NE 24th Street, Redmond, WA 98052

Exemple de réponse

{
  "summary": {
    "query": "15127 NE 24th Street, Redmond, WA 98052",
    "queryType": "NON_NEAR",
    "queryTime": 58,
    "numResults": 1,
    "offset": 0,
    "totalResults": 1,
    "fuzzyLevel": 1
  },
  "results": [
    {
      "type": "Point Address",
      "id": "US/PAD/p0/19173426",
      "score": 14.51,
      "address": {
        "streetNumber": "15127",
        "streetName": "NE 24th St",
        "municipalitySubdivision": "Redmond",
        "municipality": "Redmond, Adelaide, Ames Lake, Avondale, Earlmount",
        "countrySecondarySubdivision": "King",
        "countryTertiarySubdivision": "Seattle East",
        "countrySubdivisionCode": "WA",
        "postalCode": "98052",
        "extendedPostalCode": "980525544",
        "countryCode": "US",
        "country": "United States Of America",
        "countryCodeISO3": "USA",
        "freeformAddress": "15127 NE 24th St, Redmond, WA 980525544",
        "countrySubdivisionName": "Washington"
      },
      "position": {
        "lat": 47.6308,
        "lon": -122.1385
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.6317,
          "lon": -122.13983
        },
        "btmRightPoint": {
          "lat": 47.6299,
          "lon": -122.13717
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 47.6315,
            "lon": -122.13852
          }
        }
      ]
    }
  ]
}

Définitions

Nom Description
Address

Adresse du résultat

AddressRanges

Décrit la plage d’adresses des deux côtés de la rue pour un résultat de recherche. Les coordonnées des emplacements de début et de fin de la plage d’adresses sont incluses.

BoundingBox

La fenêtre d’affichage qui couvre le résultat représenté par les coordonnées supérieure gauche et inférieure droite de la fenêtre d’affichage.

BoundingBoxCompassNotation

Cadre englobant de l’emplacement.

Brand

Marque associée au poI

Classification

Classification du POINT d’identification retourné

ClassificationName

Nom de la classification

DataSources

Section facultative. ID de référence à utiliser avec l’API Get Recherche Polygon.

Entity

Source du type d’entité du cadre englobant. Pour le géocodage inverse, cela est toujours égal à la position.

EntryPoint

Point d’entrée du POI retourné.

EntryPointType

Type de point d’entrée. La valeur peut être main ou mineure.

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

ErrorDetail

Détail de l’erreur.

ErrorResponse

Réponse d’erreur

GeographicEntityType

Type d’entité Geography. Présente uniquement lorsque entityType a été demandé et est disponible.

Geometry

Informations sur la forme géométrique du résultat. Présent uniquement si type == Geography.

LatLongPairAbbreviated

Emplacement représenté sous la forme d’une latitude et d’une longitude utilisant des noms courts « lat » & « lon ».

LocalizedMapView

Le paramètre View (également appelé paramètre « région utilisateur ») vous permet d’afficher les cartes correctes pour un pays/région spécifique pour les régions géopolitiquement contestées. Les différents pays/régions ont des vues différentes de ces régions, et le paramètre View permet à votre application de se conformer à l’affichage requis par le pays/la région que votre application servira. Par défaut, le paramètre View est défini sur « Unified », même si vous ne l’avez pas défini dans la requête. Il vous incombe de déterminer l'emplacement de vos utilisateurs, puis de définir correctement le paramètre Affichage correspondant à cet emplacement. Vous avez aussi la possibilité de définir le paramètre d’affichage « Vue=Auto », qui retourne les données cartographiques correspondant à l’adresse IP de la requête. Le paramètre View dans Azure Maps doit être utilisé conformément aux lois applicables, y compris celles relatives au mappage, du pays ou de la région où les cartes, images et autres données et contenus tiers auxquels vous êtes autorisé à accéder via Azure Maps sont disponibles. Exemple : view=IN.

Reportez-vous à Vues prises en charge pour plus d’informations et pour voir les vues disponibles.

MatchType

Types de correspondance pour une opération de recherche d’adresses inversées.

OperatingHours

Heures d’ouverture d’un POI (Points d’intérêt).

OperatingHoursTime

Représente une date et une heure

OperatingHoursTimeRange

Plage horaire ouverte pour une journée

PointOfInterest

Détails du POINT d’identification retourné, y compris des informations telles que le nom, le téléphone, l’adresse URL et les classifications.

PointOfInterestCategorySet

Catégorie POI

QueryType

Type de requête retourné : NEARBY ou NON_NEAR.

ResponseFormat

Format souhaité de la réponse. La valeur peut être json ou xml.

SearchAddressResult

Cet objet est retourné à partir d’un Recherche d’appels réussis.

SearchAddressResultItem

Objet Result pour une réponse d’API Recherche.

SearchAddressResultType

Valeurs possibles :

  • POI
  • Rue
  • Geography
  • Adresse exacte
  • Plage d’adresses
  • Croisement
SearchIndexes

Index pour lesquels les codes postaux étendus doivent être inclus dans les résultats.

Les index disponibles sont les suivants :

Addr = Plages d’adresses

Géo = Zones géographiques

PAD = Adresses de point

POI = Points d’intérêt

Str = Rues

XStr = Rues croisées (intersections)

La valeur doit être une liste séparée par des virgules de types d’index (dans n’importe quel ordre) ou Aucun pour aucun index.

Par défaut, les codes postaux étendus sont inclus pour tous les index à l’exception de Geo. Les listes de codes postaux étendues pour les zones géographiques peuvent être assez longues et doivent donc être demandées explicitement en cas de besoin.

Exemples d'utilisation :

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=None

Le code postal étendu est retourné en tant que propriété extendedPostalCode d’une adresse. La disponibilité dépend de la région.

SearchSummary

Objet summary pour une réponse d’API Recherche.

Address

Adresse du résultat

Nom Type Description
boundingBox

BoundingBoxCompassNotation

Zone englobante de l’emplacement.

buildingNumber

string

Numéro d’immeuble dans la rue. DEPRECATED, utilisez plutôt streetNumber.

country

string

nom du pays/de la région

countryCode

string

Pays (Remarque : il s’agit d’un code à deux lettres, et non d’un nom de pays/région.)

countryCodeISO3

string

Code de pays ISO alpha-3

countrySecondarySubdivision

string

County

countrySubdivision

string

State or Province

countrySubdivisionCode

string

countrySubdivisionCode préfixé par countryCode ( countryCode-countrySubdivisionCode ) et le trait d’union forme le code ISO 3166-2. Exemples : TX pour le Texas, SCT pour l’Écosse et ON pour l’Ontario.

countrySubdivisionName

string

Nom complet d’un premier niveau de hiérarchie administrative pays/région. Ce champ apparaît uniquement dans le cas où countrySubdivision est présenté sous une forme abrégée. Pris en charge uniquement pour les États-Unis, le Canada et le Royaume-Uni.

countryTertiarySubdivision

string

Zone nommée

crossStreet

string

Nom de la rue traversée.

extendedPostalCode

string

Code postal étendu (la disponibilité dépend de la région).

freeformAddress

string

Ligne d’adresse mise en forme selon les règles de mise en forme du pays/région d’origine d’un Result, ou dans le cas d’un pays/région, son nom complet de pays/région.

localName

string

Composant d’adresse qui représente le nom d’une zone géographique ou d’une localité qui regroupe plusieurs objets adressables à des fins d’adressage, sans être une unité administrative. Ce champ est utilisé pour générer la freeformAddress propriété. localName représente la municipalité postale. Selon l’emplacement, localName est le nom communément connu d’une ville ou d’une ville. Pour le nom communément connu d’une ville ou d’une ville, utilisez localName au lieu de municipality.

municipality

string

Ville/ Ville
Remarque : municipality représente la municipalité résidentielle. Selon l’emplacement, la municipality valeur peut différer du nom communément connu d’une ville ou d’une ville. Pour le nom communément connu de la ville ou de la ville, il est suggéré d’utiliser la localName valeur à la place de la municipality valeur.

municipalitySubdivision

string

Sub / Super City

neighbourhood

string

Un quartier est une zone géographiquement localisée au sein d’une ville avec des caractéristiques distinctives et des interactions sociales entre les habitants.

postalCode

string

Postal Code / Zip Code

routeNumbers

string[]

Codes utilisés pour identifier sans ambiguïté la rue

street

string

Nom de la rue. DEPRECATED, utilisez streetName à la place.

streetName

string

Nom de la rue.

streetNameAndNumber

string

Nom et numéro de la rue.

streetNumber

string

Numéro d’immeuble dans la rue.

AddressRanges

Décrit la plage d’adresses des deux côtés de la rue pour un résultat de recherche. Les coordonnées des emplacements de début et de fin de la plage d’adresses sont incluses.

Nom Type Description
from

LatLongPairAbbreviated

Emplacement représenté sous la forme d’une latitude et d’une longitude utilisant des noms courts « lat » & « lon ».

rangeLeft

string

Plage d’adresses sur le côté gauche de la rue.

rangeRight

string

Plage d’adresses sur le côté droit de la rue.

to

LatLongPairAbbreviated

Emplacement représenté sous la forme d’une latitude et d’une longitude utilisant des noms courts « lat » & « lon ».

BoundingBox

La fenêtre d’affichage qui couvre le résultat représenté par les coordonnées supérieure gauche et inférieure droite de la fenêtre d’affichage.

Nom Type Description
btmRightPoint

LatLongPairAbbreviated

Emplacement représenté sous la forme d’une latitude et d’une longitude utilisant des noms courts « lat » & « lon ».

topLeftPoint

LatLongPairAbbreviated

Emplacement représenté sous la forme d’une latitude et d’une longitude utilisant des noms courts « lat » & « lon ».

BoundingBoxCompassNotation

Cadre englobant de l’emplacement.

Nom Type Description
entity

Entity

Source du type d’entité du cadre englobant. Pour le géocodage inverse, cela est toujours égal à la position.

northEast

string

Latitude nord-est, coordonnée de longitude du cadre englobant sous forme de flotteurs séparés par des virgules

southWest

string

Latitude sud-ouest, coordonnée de longitude du cadre englobant sous forme de flotteurs séparés par des virgules

Brand

Marque associée au poI

Nom Type Description
name

string

Nom de la marque

Classification

Classification du POINT d’identification retourné

Nom Type Description
code

string

Propriété code

names

ClassificationName[]

Tableau de noms

ClassificationName

Nom de la classification

Nom Type Description
name

string

Nom de la propriété

nameLocale

string

Propriété Name Locale

DataSources

Section facultative. ID de référence à utiliser avec l’API Get Recherche Polygon.

Nom Type Description
geometry

Geometry

Informations sur la forme géométrique du résultat. Présent uniquement si type == Geography.

Entity

Source du type d’entité du cadre englobant. Pour le géocodage inverse, cela est toujours égal à la position.

Nom Type Description
position

string

Entité position

EntryPoint

Point d’entrée du POI retourné.

Nom Type Description
position

LatLongPairAbbreviated

Emplacement représenté sous la forme d’une latitude et d’une longitude utilisant des noms courts « lat » & « lon ».

type

EntryPointType

Type de point d’entrée. La valeur peut être main ou mineure.

EntryPointType

Type de point d’entrée. La valeur peut être main ou mineure.

Nom Type Description
main

string

minor

string

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom Type Description
info

object

Informations supplémentaires

type

string

Type d’informations supplémentaires.

ErrorDetail

Détail de l’erreur.

Nom Type Description
additionalInfo

ErrorAdditionalInfo[]

Informations supplémentaires sur l’erreur.

code

string

Code d'erreur.

details

ErrorDetail[]

Détails de l’erreur.

message

string

Message d’erreur.

target

string

Cible d’erreur.

ErrorResponse

Réponse d’erreur

Nom Type Description
error

ErrorDetail

Objet d’erreur.

GeographicEntityType

Type d’entité Geography. Présente uniquement lorsque entityType a été demandé et est disponible.

Nom Type Description
Country

string

nom du pays/de la région

CountrySecondarySubdivision

string

County

CountrySubdivision

string

State or Province

CountryTertiarySubdivision

string

Zone nommée

Municipality

string

Ville/ Ville

MunicipalitySubdivision

string

Sub / Super City

Neighbourhood

string

Quartier

PostalCodeArea

string

Postal Code / Zip Code

Geometry

Informations sur la forme géométrique du résultat. Présent uniquement si type == Geography.

Nom Type Description
id

string

Transmettez ce paramètre en tant que geometryId à l’API Get Recherche Polygon pour extraire les informations géométriques de ce résultat.

LatLongPairAbbreviated

Emplacement représenté sous la forme d’une latitude et d’une longitude utilisant des noms courts « lat » & « lon ».

Nom Type Description
lat

number

Propriété Latitude

lon

number

Longitude, propriété

LocalizedMapView

Le paramètre View (également appelé paramètre « région utilisateur ») vous permet d’afficher les cartes correctes pour un pays/région spécifique pour les régions géopolitiquement contestées. Les différents pays/régions ont des vues différentes de ces régions, et le paramètre View permet à votre application de se conformer à l’affichage requis par le pays/la région que votre application servira. Par défaut, le paramètre View est défini sur « Unified », même si vous ne l’avez pas défini dans la requête. Il vous incombe de déterminer l'emplacement de vos utilisateurs, puis de définir correctement le paramètre Affichage correspondant à cet emplacement. Vous avez aussi la possibilité de définir le paramètre d’affichage « Vue=Auto », qui retourne les données cartographiques correspondant à l’adresse IP de la requête. Le paramètre View dans Azure Maps doit être utilisé conformément aux lois applicables, y compris celles relatives au mappage, du pays ou de la région où les cartes, images et autres données et contenus tiers auxquels vous êtes autorisé à accéder via Azure Maps sont disponibles. Exemple : view=IN.

Reportez-vous à Vues prises en charge pour plus d’informations et pour voir les vues disponibles.

Nom Type Description
AE

string

Émirats Arabes Unis (affichage arabe)

AR

string

Argentine (affichage argentin)

Auto

string

Retourne les données cartographiques correspondant à l’adresse IP de la requête.

BH

string

Bahreïn (affichage arabe)

IN

string

Inde (affichage indien)

IQ

string

Irak (affichage arabe)

JO

string

Jordanie (affichage arabe)

KW

string

Koweït (affichage arabe)

LB

string

Liban (affichage arabe)

MA

string

Maroc (affichage marocain)

OM

string

Oman (affichage arabe)

PK

string

Pakistan (affichage pakistanais)

PS

string

Autorité palestinienne (affichage arabe)

QA

string

Qatar (affichage arabe)

SA

string

Arabie Saoudite (affichage arabe)

SY

string

Syrie (affichage arabe)

Unified

string

Affichage unifié (Autres)

YE

string

Yémen (affichage arabe)

MatchType

Types de correspondance pour une opération de recherche d’adresses inversées.

Nom Type Description
AddressPoint

string

HouseNumberRange

string

Street

string

OperatingHours

Heures d’ouverture d’un POI (Points d’intérêt).

Nom Type Description
mode

string

Valeur utilisée dans la requête : none ou « nextSevenDays »

timeRanges

OperatingHoursTimeRange[]

Liste des intervalles de temps pour les 7 prochains jours

OperatingHoursTime

Représente une date et une heure

Nom Type Description
date

string

Représente la date de calendrier actuelle dans le fuseau horaire poI, par exemple « 2019-02-07 ».

hour

integer

Les heures sont au format 24 heures à l’heure locale d’un point d’identification personnelle ; les valeurs possibles sont 0 à 23.

minute

integer

Les minutes sont à l’heure locale d’un POINT d’identification ; les valeurs possibles sont comprises entre 0 et 59.

OperatingHoursTimeRange

Plage horaire ouverte pour une journée

Nom Type Description
endTime

OperatingHoursTime

Point dans la plage de 7 jours suivant quand un POI donné est en cours de fermeture, ou le début de la plage s’il a été fermé avant la plage.

startTime

OperatingHoursTime

Point dans la plage de 7 jours suivant quand un POI donné est ouvert, ou le début de la plage s’il a été ouvert avant la plage.

PointOfInterest

Détails du POINT d’identification retourné, y compris des informations telles que le nom, le téléphone, l’adresse URL et les classifications.

Nom Type Description
brands

Brand[]

Tableau de marques. Nom de la marque pour le POI retourné.

categories

string[]

Tableau de catégories

categorySet

PointOfInterestCategorySet[]

Liste des catégories de POI les plus spécifiques

classifications

Classification[]

Tableau de classification

name

string

Nom de la propriété POI

openingHours

OperatingHours

Heures d’ouverture d’un point d’intérêt pour un point d’intérêt.

phone

string

Propriété Numéro de téléphone

url

string

Propriété URL du site web

PointOfInterestCategorySet

Catégorie POI

Nom Type Description
id

integer

ID de la catégorie

QueryType

Type de requête retourné : NEARBY ou NON_NEAR.

Nom Type Description
NEARBY

string

Recherche a été effectué autour d’une certaine latitude et longitude avec un rayon défini

NON_NEAR

string

Recherche a été effectué globalement, sans biaiser à une certaine latitude et longitude, et aucun rayon défini

ResponseFormat

Format souhaité de la réponse. La valeur peut être json ou xml.

Nom Type Description
json

string

Format d’échange de données de notation d’objet JavaScript

xml

string

Langage de balisage extensible

SearchAddressResult

Cet objet est retourné à partir d’un Recherche d’appels réussis.

Nom Type Description
results

SearchAddressResultItem[]

Liste des résultats de l’API Recherche.

summary

SearchSummary

Objet summary pour une réponse d’API Recherche

SearchAddressResultItem

Objet Result pour une réponse d’API Recherche.

Nom Type Description
address

Address

Adresse du résultat

addressRanges

AddressRanges

Décrit la plage d’adresses des deux côtés de la rue pour un résultat de recherche. Les coordonnées des emplacements de début et de fin de la plage d’adresses sont incluses.

dataSources

DataSources

Section facultative. Id de géométrie de référence à utiliser avec l’API Get Recherche Polygon.

detourTime

integer

Temps de détour en secondes. Retourné uniquement pour les appels à l’API Recherche Along Route.

dist

number

Distance en ligne droite entre le résultat et l’emplacement géographique en mètres.

entityType

GeographicEntityType

Type d’entité Geography. Présente uniquement lorsque entityType a été demandé et est disponible.

entryPoints

EntryPoint[]

Tableau de points d’entrée. Ceux-ci décrivent les types d’entrées disponibles à l’emplacement. Le type peut être « main » pour les entrées main comme une porte d’entrée, ou un hall d’entrée, et « mineur », pour les portes latérales et arrière.

id

string

Id, propriété

info

string

Informations sur la source de données d’origine du résultat. Utilisé pour les demandes de support.

matchType

MatchType

Informations sur le type de correspondance.

Valeurs possibles :

  • AddressPoint
  • HouseNumberRange
  • Rue
poi

PointOfInterest

Détails du POINT d’identification retourné, y compris des informations telles que le nom, le téléphone, l’adresse URL et les classifications.

position

LatLongPairAbbreviated

Emplacement représenté sous la forme d’une latitude et d’une longitude utilisant des noms courts « lat » & « lon ».

score

number

Valeur dans un jeu de résultats pour indiquer le score de correspondance relatif entre les résultats. Vous pouvez l’utiliser pour déterminer que le résultat x est deux fois plus susceptible d’être aussi pertinent que le résultat y si la valeur de x est 2x la valeur de y. Les valeurs varient d’une requête à l’autre et sont uniquement destinées à une valeur relative pour un jeu de résultats.

type

SearchAddressResultType

Valeurs possibles :

  • POI
  • Rue
  • Geography
  • Adresse exacte
  • Plage d’adresses
  • Croisement
viewport

BoundingBox

La fenêtre d’affichage qui couvre le résultat représenté par les coordonnées supérieure gauche et inférieure droite de la fenêtre d’affichage.

SearchAddressResultType

Valeurs possibles :

  • POI
  • Rue
  • Geography
  • Adresse exacte
  • Plage d’adresses
  • Croisement
Nom Type Description
Address Range

string

Cross Street

string

Geography

string

POI

string

Point Address

string

Street

string

SearchIndexes

Index pour lesquels les codes postaux étendus doivent être inclus dans les résultats.

Les index disponibles sont les suivants :

Addr = Plages d’adresses

Géo = Zones géographiques

PAD = Adresses de point

POI = Points d’intérêt

Str = Rues

XStr = Rues croisées (intersections)

La valeur doit être une liste séparée par des virgules de types d’index (dans n’importe quel ordre) ou Aucun pour aucun index.

Par défaut, les codes postaux étendus sont inclus pour tous les index à l’exception de Geo. Les listes de codes postaux étendues pour les zones géographiques peuvent être assez longues et doivent donc être demandées explicitement en cas de besoin.

Exemples d'utilisation :

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=None

Le code postal étendu est retourné en tant que propriété extendedPostalCode d’une adresse. La disponibilité dépend de la région.

Nom Type Description
Addr

string

Geo

string

PAD

string

POI

string

Str

string

Xstr

string

SearchSummary

Objet summary pour une réponse d’API Recherche.

Nom Type Description
fuzzyLevel

integer

Niveau flou maximal requis pour fournir des résultats.

geoBias

LatLongPairAbbreviated

Indication lorsque le moteur de recherche interne a appliqué un biais géospatial pour améliorer le classement des résultats. Dans certaines méthodes, cela peut être affecté en définissant les paramètres lat et lon lorsqu’ils sont disponibles. Dans d’autres cas, elle est purement interne.

limit

integer

Nombre maximal de réponses qui seront retournées

numResults

integer

Nombre de résultats dans la réponse.

offset

integer

Décalage de départ du résultat retourné dans le jeu de résultats complet.

query

string

Paramètre de requête utilisé pour produire ces résultats de recherche.

queryTime

integer

Temps passé à résoudre la requête, en millisecondes.

queryType

QueryType

Type de requête retourné : NEARBY ou NON_NEAR.

totalResults

integer

Nombre total de résultats trouvés.