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/v1: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 biaiser les résultats de la résolution. Si cette option 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. Inclure locationBias ou regionCode permet souvent d'obtenir de meilleurs résultats en limitant l'espace de recherche.

Si locationBias et regionCode sont spécifiés, locationBias est prioritaire sur regionCode.
regionCode

string

Facultatif. Code de région facultatif pour biaiser 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 la région spécifiée ou à proximité. Il doit s'agir d'un code de région CLDR. Par exemple, "US" ou "CA". Inclure locationBias ou regionCode permet souvent d'obtenir de meilleurs résultats en limitant l'espace de recherche.

Si locationBias et regionCode sont spécifiés, locationBias est prioritaire sur regionCode.

Corps de la réponse

Message de réponse pour v1.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)
    },
    ...
  },
  "saveToMapsUrl": string
}
Champs
results[]

object (Result)

Uniquement en sortie. Liste des entités résolues à partir des requêtes de localisation. Correspondance exacte garantie avec les indices 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. Une carte indiquant les échecs partiels. La clé est l'index de la requête ayant échoué dans le champ queries. La valeur est l'état d'erreur détaillant la raison de l'échec de la résolution.

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

string

Uniquement en sortie. Un lien permettant d'enregistrer toutes les entités correctement résolues dans Google Maps.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

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 pour une entité géospatiale spécifique sur Google Maps, comme un lieu ou une adresse. Plus la requête est spécifique, plus la résolution est précise. 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 positions générales telles que le nom d'une chaîne (par exemple, Starbucks) ou une requête de recherche comme "restaurants" ne sont pas acceptées.

LocationBias

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

Représentation JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "viewport": {
    object (Viewport)
  }
  // End of mutually exclusive fields.
}
Champs
Type de biais de localisation. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
viewport

object (Viewport)

Fenêtre d'affichage définie par un cadre de délimitation.
Fin des champs mutuellement exclusifs.

Résultat

Entité unique résolue à partir d'une requête de localisation 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 Une confiance moyenne 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).