Method: resolveNames

Résout une liste de noms de lieux (ou d'adresses) en entités géospatiales spécifiques (par exemple, des lieux) sur Google Maps.

Requête HTTP

POST https://mapstools.googleapis.com/v1alpha:resolveNames

L'URL utilise la syntaxe de transcodage gRPC.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON 
{
  "queries": [
    {
      object (LocationQuery)
    }
  ],
  "locationBias": {
    object (LocationBias)
  },
  "regionCode": string
}
Champs
queries[]

object (LocationQuery)

Obligatoire. Liste des requêtes de localisation à résoudre. Vous pouvez spécifier jusqu'à 20 requêtes.
locationBias

object (LocationBias)

Facultatif. Région facultative pour orienter les résultats de la résolution. Si elle est spécifiée, les résultats de la résolution seront biaisés en faveur des entités les plus proches de cette région. L'inclusion de locationBias ou regionCode permet souvent d'obtenir de meilleurs résultats en limitant l'espace de recherche.

Si les deux sont spécifiés, locationBias est prioritaire sur regionCode.locationBiasregionCode
regionCode

string

Facultatif. Code régional facultatif pour orienter les résultats de la résolution. Si spécifié, les résultats de la résolution seront biaisés en faveur des entités qui se trouvent dans ou à proximité de la région spécifiée. Il doit s'agir d'un code de région CLDR. Par exemple, "US" ou "CA". L'inclusion de locationBias ou regionCode permet souvent d'obtenir de meilleurs résultats en limitant l'espace de recherche.

Si les deux options locationBias et regionCode sont spécifiées, locationBias est prioritaire sur regionCode.

Corps de la réponse

Message de réponse pour v1alpha.resolveNames.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "results": [
    {
      object (Result)
    }
  ],
  "failedRequests": {
    integer: {
      object (Status)
    },
    ...
  }
}
Champs
results[]

object (Result)

Uniquement en sortie. Liste des entités résolues à partir des requêtes sur les lieux. Garantit une correspondance exacte avec les index queries de la requête. Une chaîne vide à l'index i indique que la résolution a échoué pour cette requête. Si la résolution a échoué, veuillez vérifier le champ failedRequests pour connaître l'état de l'erreur.
failedRequests

map (key: integer, value: object (Status))

Uniquement en sortie. Carte indiquant les échecs partiels. La clé correspond à l'index de la requête ayant échoué dans le champ queries. La valeur correspond à l'état d'erreur expliquant pourquoi la résolution a échoué.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/maps-platform.mapstools
  • https://www.googleapis.com/auth/cloud-platform.read-only

LocationQuery

Une requête de localisation représente une entité de localisation spécifique qui peut être résolue avec Google Maps. Actuellement, seuls les noms de lieux et les adresses sont acceptés comme requêtes de localisation.

Représentation JSON 
{
  "text": string
}
Champs
text

string

Obligatoire. Requête textuelle à résoudre en une entité géospatiale spécifique sur Google Maps, telle qu'un lieu ou une adresse. Plus la requête est précise, plus la réponse est exacte. Par exemple, "San Francisco", "Googleplex, Mountain View, CA", "1600 Amphitheatre Parkway, Mountain View, CA" ou "Tour Eiffel, Paris". Les requêtes doivent correspondre à une adresse ou à un nom de lieu spécifiques. Les lieux généraux, comme le nom d'une chaîne (par exemple, Starbucks) ou une requête de recherche (par exemple, "restaurants"), ne sont pas acceptés.

LocationBias

Région vers laquelle orienter les résultats de la résolution.

Représentation JSON 
{

  // Union field type can be only one of the following:
  "viewport": {
    object (Viewport)
  }
  // End of list of possible types for union field type.
}
Champs
Champ d'union type. Type de biais de localisation. type ne peut être qu'un des éléments suivants :
viewport

object (Viewport)

Fenêtre d'affichage définie par un cadre de délimitation.

Fenêtre d'affichage

Fenêtre d'affichage de latitude et de longitude, représentée par deux points low et high diagonalement opposés. Une fenêtre d'affichage est considérée comme une région fermée, c'est-à-dire qu'elle inclut sa limite. Les limites de latitude doivent être comprises entre -90 et 90 degrés inclus, et les limites de longitude doivent être comprises entre -180 et 180 degrés inclus. Voici quelques exemples :

  • Si low = high, la fenêtre d'affichage se compose de ce seul point.

  • Si low.longitude > high.longitude, la plage de longitude est inversée (la fenêtre d'affichage traverse la ligne de longitude de 180 degrés).

  • Si low.longitude = -180 degrés et high.longitude = 180 degrés, la fenêtre d'affichage inclut toutes les longitudes.

  • Si low.longitude = 180 degrés et high.longitude = -180 degrés, la plage de longitude est vide.

  • Si low.latitude > high.latitude, la plage de latitude est vide.

low et high doivent être renseignés, et la boîte représentée ne peut pas être vide (comme indiqué dans les définitions ci-dessus). Un viewport vide générera une erreur.

Par exemple, cette fenêtre d'affichage englobe entièrement la ville de New York :

{ "low": { "latitude": 40.477398, "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": -73.70018 } }

Représentation JSON 
{
  "low": {
    object (LatLng)
  },
  "high": {
    object (LatLng)
  }
}
Champs
low

object (LatLng)

Obligatoire. Point bas de la fenêtre d'affichage.
high

object (LatLng)

Obligatoire. Point haut de la fenêtre d'affichage.

LatLng

Objet représentant une paire latitude/longitude. Cette valeur est exprimée par une paire de doubles représentant les degrés de latitude et de longitude. Sauf indication contraire, cet objet doit être conforme à la norme WGS84. Les valeurs doivent se situer dans les limites normalisées.

Représentation JSON 
{
  "latitude": number,
  "longitude": number
}
Champs
latitude

number

Latitude en degrés. Elle doit être comprise dans la plage [-90.0, +90.0].
longitude

number

Longitude en degrés. Elle doit être comprise dans la plage [-180.0, +180.0].

Résultat

Entité résolue unique à partir d'une requête d'emplacement donnée, ainsi que le niveau de confiance de la résolution.

Représentation JSON 
{
  "entity": {
    object (Entity)
  },
  "confidence": enum (Confidence)
}
Champs
entity

object (Entity)

Uniquement en sortie. Entité résolue à partir de la requête de localisation.
confidence

enum (Confidence)

Uniquement en sortie. Niveau de confiance de la résolution.

Confiance

Niveau de confiance de la résolution.

Enums
CONFIDENCE_UNSPECIFIED Valeur par défaut. Cette valeur n'est pas utilisée.
MEDIUM Un niveau de confiance moyen indique que la résolution est probablement correcte, mais qu'il peut y avoir d'autres candidats.
HIGH Un niveau de confiance élevé indique que la résolution est correcte et représente une entité géospatiale spécifique (par exemple, un lieu spécifique).