Package google.maps.geocode.v4alpha

Index

DestinationService

Service permettant de récupérer des destinations.

Une destination fournit un contexte hiérarchique sur un lieu, ce qui vous permet, par exemple, de trouver des immeubles d'appartements dans un complexe d'appartements plus grand et inversement. Il fournit également des points de navigation adaptés à des cas d'utilisation tels que le covoiturage ou la livraison.

SearchDestinations

rpc SearchDestinations(SearchDestinationsRequest) returns (SearchDestinationsResponse)

Cette méthode effectue une recherche de destination et renvoie une liste de destinations.

Champs d'application des autorisations

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

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

GeocodeService

Service permettant d'effectuer le géocodage.

GeocodeAddress

rpc GeocodeAddress(GeocodeAddressRequest) returns (GeocodeAddressResponse)

Cette méthode effectue un geocoding d'adresse, qui mappe une adresse à un LatLng. Il fournit également des informations structurées sur l'adresse.

Champs d'application des autorisations

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

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/maps-platform.geocode
  • https://www.googleapis.com/auth/maps-platform.geocode.address
GeocodeLocation

rpc GeocodeLocation(GeocodeLocationRequest) returns (GeocodeLocationResponse)

Cette méthode effectue un geocoding d'emplacement, qui mappe un LatLng à une adresse. Il fournit également des informations structurées sur l'adresse.

Champs d'application des autorisations

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

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/maps-platform.geocode
  • https://www.googleapis.com/auth/maps-platform.geocode.location
GeocodePlace

rpc GeocodePlace(GeocodePlaceRequest) returns (GeocodeResult)

Cette méthode effectue une recherche de géocodage à l'aide d'un ID de lieu.

Champs d'application des autorisations

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

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/maps-platform.geocode
  • https://www.googleapis.com/auth/maps-platform.geocode.place

Destination

Une destination. Cela inclut le lieu principal, les lieux associés, les entrées et les points de navigation.

Champs
primary

PlaceView

Lieu principal identifié par primary_query dans la requête.

containing_places[]

PlaceView

Les lieux moins précis dans lesquels se trouve le lieu principal. Par exemple, le complexe d'appartements qui contient ce bâtiment.

sub_destinations[]

PlaceView

Sous-destinations plus précises du lieu principal. Par exemple, les unités contenues dans un bâtiment.

Remarque : Par rapport à SubDestination renvoyé par l'API Places, cette liste de sous-destinations est plus exhaustive et chaque sous-destination contient plus d'informations.

landmarks[]

Landmark

Points de repère pouvant être utilisés pour indiquer où se trouve la destination ou aider à l'arrivée.

entrances[]

Entrance

Entrées pour cette destination.

navigation_points[]

NavigationPoint

Points de navigation pour cette destination.

arrival_summary

Destination.ArrivalSummary

Résumé généré par IA de l'expérience à l'arrivée à la destination.

ArrivalSummary

Résumé généré par IA de l'expérience à l'arrivée à la destination.

Champs
text

LocalizedText

Résumé de l'expérience à l'arrivée à la destination.

flag_content_url

string

Lien permettant aux utilisateurs de signaler un problème concernant le résumé.

disclosure_text

LocalizedText

Uniquement en sortie. Contient le texte de divulgation pour le récapitulatif de l'arrivée.

Entrée

Une entrée est une paire de coordonnées de latitude/longitude qui définit l'emplacement d'un point d'entrée et de sortie pour un lieu.

Champs
location

LatLng

Emplacement de l'entrée.

tags[]

Entrance.Tag

Liste des tags décrivant l'entrée.

place

string

Structure sur laquelle se trouve physiquement cette entrée, au format places/{place_id}.

Tag

Caractéristiques décrivant une entrée.

Enums
TAG_UNSPECIFIED Non utilisé.
PREFERRED

L'entrée permet probablement d'accéder physiquement au lieu principal de la destination renvoyée. Un lieu peut comporter plusieurs entrées préférées. Si une entrée ne comporte pas ce tag, cela signifie qu'elle se trouve physiquement dans le même bâtiment que le lieu principal, mais qu'elle ne donne pas nécessairement accès au lieu.

Par exemple, si le lieu principal est un restaurant dans un centre commercial, les entrées "PRÉFÉRÉES" seront celles qui mènent probablement au restaurant lui-même, tandis que les autres entrées renvoyées seront d'autres entrées du bâtiment, comme celles d'autres restaurants du centre commercial.

Si le lieu principal est un bâtiment, les entrées PREFERRED seront celles qui mènent à la partie "principale" du bâtiment. Par exemple, dans un centre commercial, les entrées PREFERRED sont celles qui permettent d'accéder au hall principal. En revanche, si une entrée ne permet d'accéder qu'à un magasin situé sur le côté du bâtiment, il ne s'agit pas d'une entrée PREFERRED.

Remarque : Une entrée PREFERRED ne donne pas forcément accès au lieu principal, et une entrée non PREFERRED peut donner accès au lieu principal.

GeocodeAddressRequest

Message de requête pour GeocodeService.GeocodeAddress.

Champs
location_bias

GeocodeAddressRequest.LocationBias

Facultatif. Région dans laquelle effectuer la recherche. Cet emplacement sert de biais, ce qui signifie que des résultats autour de l'emplacement indiqué peuvent être renvoyés.

language_code

string

Facultatif. Langue dans laquelle les résultats doivent être renvoyés.

region_code

string

Facultatif. Code régional. Code régional, spécifié sous la forme d'une valeur ccTLD (TLD pour top-level domain, domaine de premier niveau) à deux caractères. Ce paramètre a une incidence sur les résultats en fonction de la loi applicable. Ce paramètre influera également sur les résultats du service, sans les limiter totalement.

Champ d'union address_input. Adresse à géocoder. address_input ne peut être qu'un des éléments suivants :
address_query

string

Adresse non structurée à géocoder.

address

PostalAddress

Adresse structurée à géocoder au format adresse postale.

LocationBias

Région dans laquelle effectuer la recherche. Cet emplacement sert de biais, ce qui signifie que des résultats autour de l'emplacement indiqué peuvent être renvoyés.

Champs
Champ d'union type. Types de biais de localisation. type ne peut être qu'un des éléments suivants :
rectangle

Viewport

Boîte rectangulaire définie par les angles nord-est et sud-ouest. rectangle.high() doit correspondre au point nord-est de la fenêtre d'affichage rectangulaire. rectangle.low() doit correspondre au point sud-ouest de la fenêtre d'affichage rectangulaire. rectangle.low().latitude() ne peut pas être supérieur à rectangle.high().latitude(). Cela entraînera une plage de latitude vide. Un rectangle de fenêtre d'affichage ne peut pas avoir une largeur supérieure à 180 degrés.

GeocodeAddressResponse

Message de réponse pour GeocodeService.GeocodeAddress.

Champs
results[]

GeocodeResult

Résultat du geocoding.

GeocodeLocationRequest

Message de requête pour GeocodeService.GeocodeLocation.

Champs
language_code

string

Facultatif. Langue dans laquelle les résultats doivent être renvoyés.

region_code

string

Facultatif. Code régional. Code régional, spécifié sous la forme d'une valeur ccTLD (TLD pour top-level domain, domaine de premier niveau) à deux caractères. Ce paramètre a une incidence sur les résultats en fonction de la loi applicable.

types[]

string

Facultatif. Ensemble de tags de type permettant de limiter les résultats. Les résultats qui ne correspondent à aucun des types spécifiés sont supprimés.

Pour obtenir la liste complète des valeurs possibles, consultez les tableaux A et B sur la page https://developers.google.com/maps/documentation/places/web-service/place-types.

granularity[]

GeocodeResult.Granularity

Facultatif. Filtre d'une ou plusieurs énumérations de précision de localisation.

Champ d'union location_input. Emplacement à géocoder. location_input ne peut être qu'un des éléments suivants :
location_query

string

Emplacement au format "lat,lng". Par exemple, "64.7611872,-18.4705364".

location

LatLng

Emplacement au format structuré.

GeocodeLocationResponse

Message de réponse pour GeocodeService.GeocodeLocation.

Champs
results[]

GeocodeResult

Résultat du geocoding.

plus_code

PlusCode

Plus Code de la zone géographique dans la demande.

GeocodePlaceRequest

Message de requête pour GeocodeService.GeocodePlace.

Champs
place

string

Obligatoire. Identifiant de lieu à géocoder au format places/{place}.

language_code

string

Facultatif. Langue dans laquelle les résultats doivent être renvoyés.

region_code

string

Facultatif. Code régional. Code régional, spécifié sous la forme d'une valeur ccTLD (TLD pour top-level domain, domaine de premier niveau) à deux caractères. Ce paramètre a une incidence sur les résultats en fonction de la loi applicable.

GeocodeResult

Un résultat de géocodage contient des informations géographiques sur un lieu.

Champs
place

string

Identifiant complet du lieu pour ce résultat. Au format "//places.googleapis.com/places/{placeID}". Pour en savoir plus, consultez https://developers.google.com/maps/documentation/places/web-service/place-id.

place_id

string

ID du lieu pour ce résultat.

location

LatLng

Latlng de cette adresse.

granularity

GeocodeResult.Granularity

Précision de la position.

viewport

Viewport

Fenêtre d'affichage adaptée à l'affichage du résultat du géocodage.

bounds

Viewport

Cadre de délimitation de l'adresse.

formatted_address

string

Adresse mise en forme sur une seule ligne.

postal_address

PostalAddress

Adresse au format postal.

address_components[]

GeocodeResult.AddressComponent

Composants répétés pour chaque niveau de localité.

postal_code_localities[]

LocalizedText

Liste complète des localités contenues dans le code postal.

Ce champ n'est renseigné que lorsque le résultat est de type "postal_code".

types[]

string

Ensemble de tags de type pour ce résultat. Par exemple, "political" et "administrative_area".

Pour obtenir la liste complète des valeurs possibles, consultez les tableaux A et B sur la page https://developers.google.com/maps/documentation/places/web-service/place-types.

plus_code

PlusCode

Plus Code de l'emplacement dans ce géocode.

AddressComponent

Composants structurés qui forment l'adresse mise en forme, si ces informations sont disponibles.

Champs
long_text

string

Description complète ou nom du composant d'adresse. Par exemple, un composant d'adresse pour le pays "Australie" peut avoir un nom long "Australie".

short_text

string

Nom textuel abrégé du composant d'adresse, s'il est disponible. Par exemple, un composant d'adresse pour le pays de l'Australie peut avoir le nom court "AU".

types[]

string

Tableau indiquant le ou les types du composant d'adresse.

Pour en savoir plus, consultez https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types.

language_code

string

Langue utilisée pour mettre en forme ces composants, en notation CLDR.

Précision

Précision de la position.

Enums
GRANULARITY_UNSPECIFIED Ne pas utiliser.
ROOFTOP Emplacement non interpolé d'une parcelle de terrain réelle correspondant à l'adresse trouvée.
RANGE_INTERPOLATED Interpolé à partir d'une plage de numéros de rue. Par exemple, si nous savons qu'un segment d'Amphitheatre Pkwy contient les numéros 1600 à 1699, le numéro 1650 peut être placé à mi-chemin entre ses points de terminaison.
GEOMETRIC_CENTER Centre géométrique d'un élément pour lequel nous disposons de données polygonales.
APPROXIMATE Tout le reste.

Point de repère

Les points de repère permettent de communiquer l'emplacement de la destination ou d'aider à y arriver.

Champs
relational_description

LocalizedText

Description lisible par l'humain du lien entre la destination et le point de repère. Par exemple : "Près de l'Empire State Building" ou "En face de la Maison-Blanche".

tags[]

Landmark.Tag

Tags décrivant comment le point de repère peut être utilisé dans le contexte de la destination.

straight_line_distance_meters

double

Uniquement en sortie. Distance en ligne droite entre ce point de repère et la destination, en mètres.

travel_distance_meters

double

Uniquement en sortie. Distance (en mètres) entre ce repère et la destination sur le réseau routier.

Champ d'union landmark. Le repère. landmark ne peut être qu'un des éléments suivants :
place

PlaceView

Lieu représentant ce point de repère.

Tag

Liste de tous les tags possibles qui décrivent comment un point de repère peut être utilisé dans le contexte d'une destination.

Si une adresse comporte à la fois les balises ADDRESS et ARRIVAL, cela signifie que le point de repère est à la fois connu localement et proche de la destination.

Enums
TAG_UNSPECIFIED Non utilisé.
ADDRESS Un lieu important au niveau local qui peut être utilisé pour identifier la position générale de la destination. Généralement à quelques centaines de mètres de la destination. Elles sont semblables aux points de repère renvoyés par la fonctionnalité de description d'adresse de l'API Geocoding : https://developers.google.com/maps/documentation/geocoding/address-descriptors/requests-address-descriptors.
ARRIVAL Un lieu qui peut être utilisé pour vous aider à arriver à destination. Utile pour la navigation une fois que vous êtes proche de la destination. Par exemple, ce point de repère peut être un lieu situé en face de la destination. Un point de repère associé à cette balise est généralement plus proche de la destination que ceux associés à la balise ADDRESS.

Un point de navigation est un lieu situé à côté d'une route où la navigation peut se terminer.

Champs
navigation_point_token

string

Uniquement en sortie. Jeton pouvant être utilisé pour identifier ce point de navigation.

display_name

LocalizedText

Nom à afficher de ce point de navigation. Par exemple, "5e Avenue" ou "Porte B".

location

LatLng

Point à côté de la section de route où la navigation doit se terminer. Le point est intentionnellement légèrement décalé par rapport à l'axe de la route pour indiquer clairement le côté de la route où se trouve le lieu.

travel_modes[]

NavigationPoint.TravelMode

Modes de déplacement adaptés à ce point de navigation.

usages[]

NavigationPoint.Usage

Usages acceptés par ce point de navigation.

TravelMode

Modes de déplacement adaptés à ce point de navigation.

Enums
TRAVEL_MODE_UNSPECIFIED Non utilisé.
DRIVE Convient à la conduite.
WALK Convient à la marche.

Utilisation

Usages acceptés par ce point de navigation.

Enums
USAGE_UNSPECIFIED Non utilisé.
UNKNOWN Type d'utilisation inconnu. La plupart des points de navigation seront UNKNOWN, ce qui ne signifie pas nécessairement que leur utilisation est limitée de quelque manière que ce soit. Cette navigation peut toujours convenir pour la prise en charge et/ou la dépose.
DROPOFF Convient pour déposer un passager. (par exemple, un lieu de dépose pour un service de covoiturage).
PICKUP Convient pour prendre un passager. (par exemple, un lieu de prise en charge pour un service de covoiturage).

PlaceView

Représente une vue d'un lieu dans l'API Places. Il fournit également des informations supplémentaires spécifiques aux destinations, telles que le type de structure et le polygone d'affichage.

Dans certains cas, un PlaceView avec le même ID de lieu peut différer de ce qui est renvoyé par l'API Places pour les champs types et display_name.

Champs
place

string

Nom de ressource de ce lieu, au format places/{placeId}.

display_name

LocalizedText

Description du lieu lisible par l'utilisateur. Par exemple, "Porte B", "McDonald's"

primary_type

string

Type de lieu principal. Pour obtenir la liste des valeurs possibles, consultez https://developers.google.com/maps/documentation/places/web-service/place-types.

Remarque : Ce champ n'est pas toujours renseigné. Dans ce cas, préparez-vous à utiliser le champ types.

types[]

string

Tous les types de lieux associés à ce lieu. Pour obtenir la liste des valeurs possibles, consultez https://developers.google.com/maps/documentation/places/web-service/place-types.

formatted_address

string

Adresse sur une seule ligne.

postal_address

PostalAddress

Adresse structurée.

structure_type

PlaceView.StructureType

Type de structure correspondant à ce lieu.

location

LatLng

Emplacement de ce lieu. Pour les lieux avec des polygones d'affichage, cela peut représenter un bon endroit pour placer un repère sur la carte.

display_polygon

Struct

Contour du polygone du lieu au format GeoJSON, en utilisant le format RFC 7946 : https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.6.

Remarque : Le format RFC 7946 est compatible avec les MultiPolygones. Un objet display_polygon peut donc représenter plusieurs polygones.

StructureType

Type de structure que représente ce lieu.

Enums
STRUCTURE_TYPE_UNSPECIFIED Non utilisé.
POINT Un emplacement ponctuel.
SECTION Sous-section d'un bâtiment.
BUILDING Un bâtiment.
GROUNDS Vaste zone qui contient généralement plusieurs bâtiments, comme un campus universitaire, un complexe d'appartements ou un centre commercial.

PlusCode

Un Plus Code (http://plus.codes) est une référence de lieu qui se présente sous deux formats : un code global définissant un rectangle de 14 m x 14 m (1/8000e de degré) ou plus petit, et un code composé, qui remplace le préfixe par une référence de lieu.

Champs
global_code

string

Code global (complet) du lieu, tel que "9FWM33GV+HQ", représentant une zone de 1/8000e de degré par 1/8000e de degré (environ 14 mètres sur 14 mètres).

compound_code

string

Code composé du lieu, tel que "33GV+HQ, Ramberg, Norvège ", contenant le suffixe du code global et remplaçant le préfixe par le nom mis en forme d'une entité de référence.

SearchDestinationsRequest

Message de requête pour DestinationService.SearchDestinations.

Champs
travel_modes[]

NavigationPoint.TravelMode

Facultatif. Modes de déplacement pour lesquels filtrer les points de navigation. Cela a une incidence sur le champ navigation_points renvoyé dans la réponse. Si ce paramètre est vide, les points de navigation de tous les modes de transport peuvent être renvoyés.

language_code

string

Facultatif. Langue dans laquelle les résultats doivent être renvoyés.

region_code

string

Facultatif. Code régional. Code régional, spécifié sous la forme d'une valeur ccTLD (TLD pour top-level domain, domaine de premier niveau) à deux caractères. Ce paramètre a une incidence sur les résultats en fonction de la loi applicable. Ce paramètre influe également sur les résultats du service, sans les limiter totalement.

Champ d'union primary_query. Interrogez la destination principale. Il peut s'agir d'un lieu, d'une adresse complète ou d'une position LatLng. Il ne sera pas possible de transformer en destination certains lieux et adresses pour lesquels les informations sont minimales.

Les destinations sont créées autour de la requête principale spécifiée.

Remarque : Seuls les lieux et les adresses pouvant servir de destination de navigation sont acceptés. Par exemple, un lieu représentant une maison ou un complexe d'appartements peut être utilisé comme requête principale, mais pas un lieu représentant une localité ou une zone administrative. primary_query ne peut être qu'un des éléments suivants :

place

string

Nom de ressource d'un lieu, au format places/{place_id}.

address_query

SearchDestinationsRequest.AddressQuery

Adresse postale.

location_query

SearchDestinationsRequest.LocationQuery

une position exacte.

AddressQuery

Adresse postale que vous souhaitez rechercher. Lorsque vous spécifiez les adresses, respectez le format utilisé par les services postaux nationaux du pays concerné.

Champs
Champ d'union kind. Requête d'adresse. kind ne peut être qu'un des éléments suivants :
address

PostalAddress

Adresse postale.

address_query

string

Adresse postale mise en forme sur une seule ligne.

LocationQuery

Requête de localisation permettant d'identifier une destination principale à proximité.

Remarque : Si la requête de localisation se trouve dans un bâtiment contenant des locaux secondaires, il est possible que le lieu principal renvoyé soit un local secondaire. Dans ce cas, le champ "containing_places" inclura le bâtiment.

Champs
place_filter

SearchDestinationsRequest.LocationQuery.PlaceFilter

Facultatif. Filtres à appliquer aux candidats de destination.

Champ d'union kind. Requête de localisation. kind ne peut être qu'un des éléments suivants :
location

LatLng

Emplacement LatLng précis.

PlaceFilter

Filtres à appliquer aux candidats de destination.

Champs
structure_type

PlaceView.StructureType

Facultatif. Si cette valeur est spécifiée, toutes les destinations sont garanties d'avoir un lieu principal avec ce type de structure. Cela peut entraîner le filtrage de certaines destinations ou l'affinage/l'élargissement des destinations renvoyées.

Par exemple, si GROUNDS est spécifié, toutes les destinations renvoyées auront un lieu principal avec le type de structure GROUNDS. Cela peut entraîner le filtrage de certaines destinations qui ne font pas partie d'un lieu ou l'agrégation des destinations renvoyées au niveau du lieu.

Ce champ permet également d'extraire plus facilement les polygones d'affichage des bâtiments. Par exemple, si BUILDING est spécifié, le polygone d'affichage du lieu principal correspondra au bâtiment situé à l'emplacement indiqué.

addressability

SearchDestinationsRequest.LocationQuery.PlaceFilter.Addressability

Facultatif. Si cette valeur est spécifiée, seules les destinations qui répondent aux critères d'adressabilité correspondants sont renvoyées.

Adressabilité

Définit les options de filtrage de l'adressabilité. De nouvelles valeurs pourront être ajoutées à l'avenir.

Enums
ADDRESSABILITY_UNSPECIFIED Si aucune valeur n'est spécifiée, le service choisit une valeur par défaut appropriée.
ANY L'adressabilité n'est pas un critère de filtrage. Les destinations sont renvoyées, qu'elles soient adressables ou non.
PRIMARY Toutes les destinations renvoyées auront un lieu principal avec une adresse ou un nom au niveau de la rue.
WEAK Toutes les destinations renvoyées auront soit un lieu principal, soit une sous-destination avec une adresse ou un nom de rue.

SearchDestinationsResponse

Message de réponse pour DestinationService.SearchDestinations.

Champs
destinations[]

Destination

Liste des destinations.

Le service renvoie un résultat si une destination principale peut être identifiée sans ambiguïté à partir de la requête principale. Sinon, le service peut renvoyer plusieurs résultats pour lever l'ambiguïté ou aucun résultat.