Method: searchAlongRoute

Rechercher des lieux le long d'un itinéraire

Requête HTTP

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

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
{
  "textQuery": string,
  "languageCode": string,
  "regionCode": string,
  "routingPreference": enum (RoutingPreference),
  "includeExtendedDetails": boolean,
  "travelMode": enum (RouteTravelMode),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "encodedPolyline": string,
  "retrievalToken": string,
  "routeEndpoints": {
    object (RouteEndpoints)
  }
  // End of mutually exclusive fields.
}
Champs
textQuery

string

Obligatoire. Requête de recherche en langage naturel (par exemple, "bornes pour véhicules électriques", "café").

languageCode

string

Facultatif. Langue du résumé et des détails du lieu. La valeur par défaut est "en-US".

regionCode

string

Facultatif. Code pays/région (CLDR) de l'emplacement (par exemple, "US").

routingPreference

enum (RoutingPreference)

Facultatif. Préférence de routage facultative spécifiant comment les données de trafic sont utilisées. La valeur par défaut est TRAFFIC_UNAWARE.

includeExtendedDetails

boolean

Facultatif. Inclut des détails étendus sur le lieu dans la réponse.

Définissez ce champ sur true lorsque la requête de l'utilisateur nécessite des insights qualitatifs enrichis, une dynamique en temps réel ou des attributs d'entité spécialisés : avis qualitatifs, sentiment des clients et commentaires. - Offres spécifiques telles que des éléments de menu, des plats, des spécialités culinaires, des boissons ou des points forts de l'établissement. - Atmosphère, décoration intérieure, esthétique, ambiance ou humeur qualitative. - Données en temps réel et spécifications des établissements spécialisés, règles/conseils pour les visiteurs, temps d'attente.

Laissez false (par défaut) pour les recherches standards (par exemple, cuisines, types de magasins), les recherches de lieux/adresses, les coordonnées, les horaires d'ouverture et les métadonnées/services standards.

L'activation de ce champ peut entraîner une latence plus élevée.

travelMode

enum (RouteTravelMode)

Facultatif. Spécifie le mode de transport utilisé pour calculer l'itinéraire et les détours. La valeur par défaut est DRIVE. WALK et BICYCLE ne sont compatibles qu'avec routeEndpoints. TRANSIT n'est pas compatible.

Spécification de l'itinéraire : un itinéraire existant, un jeton d'itinéraire ou des points de terminaison de départ/destination. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
encodedPolyline

string

Chaîne de polyligne encodée représentant l'itinéraire. Consultez https://developers.google.com/maps/documentation/utilities/polylinealgorithm.

retrievalToken

string

Jeton de récupération renvoyé par un appel v1alpha.computeRoutes précédent représentant l'itinéraire.

routeEndpoints

object (RouteEndpoints)

Points de terminaison d'itinéraire explicites (point de départ et destination).

Fin des champs mutuellement exclusifs.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de SearchAlongRouteResponse.

Champs d'application des autorisations

Requiert le champ d'application OAuth suivant :

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