Une fois que vous disposez d'un ID de lieu, vous pouvez demander plus de détails sur un établissement ou un point d'intérêt particulier en envoyant une requête Place Details (New). Une requête Place Details (New) renvoie des informations plus complètes sur le lieu indiqué, telles que son adresse complète, son numéro de téléphone, les notes et les avis des visiteurs.
Il existe de nombreuses façons d'obtenir un ID de lieu. Vous pouvez :
- Text Search (nouvelle version) ou Nearby Search (nouvelle version)
- API Geocoding
- API Routes
- API Address Validation
- Place Autocomplete
APIs Explorer vous permet d'envoyer des requêtes en direct afin que vous puissiez vous familiariser avec l'API et ses options:
EssayerRequêtes Place Details (New)
Une requête Places Details est une requête HTTP GET au format suivant:
https://places.googleapis.com/v1/places/PLACE_ID
Transmettez tous les paramètres en tant que paramètres d'URL ou dans les en-têtes dans la requête GET. Exemple :
https://places.googleapis.com/v1/places/ChIJj61dQgK6j4AR4GeTYWZsKWw?fields=id,displayName&key=API_KEY
Ou dans une commande cURL:
curl -X GET -H 'Content-Type: application/json' \ -H "X-Goog-Api-Key: API_KEY" \ -H "X-Goog-FieldMask: id,displayName" \ https://places.googleapis.com/v1/places/ChIJj61dQgK6j4AR4GeTYWZsKWw
Réponses Place Details (New)
Place Details (New) renvoie un objet JSON en tant que réponse. Dans la réponse :
- La réponse est représentée par un objet
Place
. L'objetPlace
contient des informations détaillées sur le lieu. - Le paramètre FieldMask transmis dans la requête spécifie la liste des champs renvoyés dans l'objet
Place
.
L'objet JSON complet se présente sous la forme suivante:
{ "name": "places/ChIJkR8FdQNB0VQRm64T_lv1g1g", "id": "ChIJkR8FdQNB0VQRm64T_lv1g1g", "displayName": { "text": "Trinidad" } ... }
Paramètres obligatoires
-
FieldMask
Spécifiez la liste des champs à renvoyer dans la réponse en créant un masque de champ de réponse. Transmettez le masque de champ de réponse à la méthode à l'aide du paramètre d'URL
$fields
oufields
, ou de l'en-tête HTTPX-Goog-FieldMask
. Il n'existe pas de liste par défaut des champs renvoyés dans la réponse. Si vous omettez le masque de champ, la méthode renvoie une erreur.Le masquage de champ est une bonne pratique à suivre pour vous assurer de ne pas demander de données inutiles, ce qui permet d'éviter le temps de traitement et les frais facturés.
Spécifiez une liste de types de données de lieu à renvoyer, séparés par une virgule. Par exemple, pour récupérer le nom à afficher et l'adresse du lieu.
X-Goog-FieldMask: displayName,formattedAddress
Utilisez
*
pour récupérer tous les champs.X-Goog-FieldMask: *
Renseignez un ou plusieurs des champs suivants:
Les champs suivants déclenchent le SKU Place Details (IDs Only):
attributions
,id
,name
*,photos
* Le champname
contient le nom de ressource du lieu dans le formulaire:places/PLACE_ID
. UtilisezdisplayName
pour accéder au nom textuel du lieu.Les champs suivants déclenchent le SKU Place Details (Location Only):
addressComponents
,adrFormatAddress
,formattedAddress
,location
,plusCode
,shortFormattedAddress
,types
,viewport
Les champs suivants déclenchent le SKU Place Details (Basic):
accessibilityOptions
,businessStatus
,displayName
,googleMapsUri
,iconBackgroundColor
,iconMaskBaseUri
,primaryType
,primaryTypeDisplayName
,subDestinations
,utcOffsetMinutes
Les champs suivants déclenchent le SKU Place Details (Advanced):
currentOpeningHours
,currentSecondaryOpeningHours
,internationalPhoneNumber
,nationalPhoneNumber
,priceLevel
,rating
,regularOpeningHours
,regularSecondaryOpeningHours
,userRatingCount
,websiteUri
Les champs suivants déclenchent le SKU Place Details (Preferred):
allowsDogs
,curbsidePickup
,delivery
,dineIn
,editorialSummary
,evChargeOptions
,fuelOptions
,goodForChildren
,goodForGroups
,goodForWatchingSports
,liveMusic
,menuForChildren
,parkingOptions
,paymentOptions
,outdoorSeating
,reservable
,restroom
,reviews
,servesBeer
,delivery
,delivery
,delivery
servesBreakfast
servesBrunch
servesCocktails
servesCoffee
servesDessert
servesDinner
servesLunch
servesVegetarianFood
servesWine
takeout
-
placeId
Identifiant textuel qui identifie un lieu de manière unique, renvoyé par une requête Text Search (nouvelle version) ou Nearby Search (nouvelle). Pour en savoir plus sur les ID de lieu, consultez la présentation des ID de lieu.
La chaîne
places/PLACE_ID
est également appelée nom de ressource du lieu. Dans la réponse d'une requête Place Details (New), Nearby Search (New) et Text Search (New), cette chaîne est contenue dans le champname
de la réponse. L'ID de lieu autonome est contenu dans le champid
de la réponse.
Paramètres facultatifs
languageCode
Langue dans laquelle les résultats doivent être renvoyés.
- Consultez la liste des langues acceptées. Cette liste n'est peut-être pas exhaustive, car Google met régulièrement à jour les langues acceptées.
-
Si
languageCode
n'est pas fourni, l'API est définie par défaut suren
. Si vous spécifiez un code de langue non valide, l'API renvoie une erreurINVALID_ARGUMENT
. - L'API s'efforce de fournir une adresse postale lisible à la fois pour l'utilisateur et pour les locaux. Pour atteindre cet objectif, il renvoie les adresses postales dans la langue locale, translittérées en un script que l'utilisateur peut lire si nécessaire, en tenant compte de la langue préférée. Toutes les autres adresses sont renvoyées dans la langue préférée. Les composants d'adresse sont tous renvoyés dans la même langue, choisie dans le premier composant.
- Si un nom n'est pas disponible dans la langue préférée, l'API utilise la correspondance la plus proche.
- La langue préférée a une petite influence sur l'ensemble des résultats que l'API choisit de renvoyer et sur l'ordre dans lequel ils sont renvoyés. Le geocoder interprète les abréviations différemment selon la langue. Il peut s'agir, par exemple, des abréviations correspondant aux types de rues ou des synonymes qui peuvent être valides dans une langue, mais pas dans une autre.
regionCode
Code régional utilisé pour mettre en forme la réponse, spécifié sous la forme d'une valeur de code CLDR à deux caractères. Il n'existe pas de valeur par défaut.
Si le nom de pays du champ
formattedAddress
dans la réponse correspond àregionCode
, le code pays est omis deformattedAddress
. Ce paramètre n'a aucun effet suradrFormatAddress
, qui inclut toujours le nom du pays, ni surshortFormattedAddress
, qui ne l'inclut jamais.La plupart des codes CLDR sont identiques aux codes ISO 3166-1, à quelques exceptions près. Par exemple, le ccTLD du Royaume-Uni est "uk" (.co.uk), tandis que son code ISO 3166-1 est "gb" (techniquement pour l'entité "Royaume-Uni de Grande-Bretagne et d'Irlande du Nord"). Ce paramètre peut avoir un impact sur les résultats en fonction du droit applicable.
-
sessionToken
Les jetons de session sont des chaînes générées par l'utilisateur qui suivent les appels de la saisie semi-automatique (nouveau) comme des "sessions". Autocomplete (nouveau) utilise des jetons de session pour regrouper les phases de requête et de sélection de lieux d'une recherche avec saisie semi-automatique d'un utilisateur dans une session distincte à des fins de facturation. Les jetons de session sont transmis dans les appels Place Details (New) qui suivent les appels Autocomplete (New). Pour en savoir plus, consultez la section Jetons de session.
Exemple Place Details
L'exemple suivant demande les détails d'un lieu par placeId
:
curl -X GET -H 'Content-Type: application/json' \ -H "X-Goog-Api-Key: API_KEY" \ -H "X-Goog-FieldMask: id,displayName" \ https://places.googleapis.com/v1/places/ChIJj61dQgK6j4AR4GeTYWZsKWw
Notez que l'en-tête X-Goog-FieldMask
spécifie que la réponse contient les champs de données suivants: id,displayName
.
La réponse se présente alors sous la forme suivante:
{ "id": "ChIJj61dQgK6j4AR4GeTYWZsKWw", "displayName": { "text": "Googleplex", "languageCode": "en" } }
Ajoutez d'autres types de données au masque de champ pour renvoyer des informations supplémentaires.
Par exemple, ajoutez formattedAddress,plusCode
pour inclure l'adresse et le Plus Code dans la réponse:
curl -X GET -H 'Content-Type: application/json' \ -H "X-Goog-Api-Key: API_KEY" \ -H "X-Goog-FieldMask: id,displayName,formattedAddress,plusCode" \ https://places.googleapis.com/v1/places/ChIJj61dQgK6j4AR4GeTYWZsKWw
La réponse se présente désormais sous la forme suivante:
{ "id": "ChIJj61dQgK6j4AR4GeTYWZsKWw", "formattedAddress": "1600 Amphitheatre Pkwy, Mountain View, CA 94043, USA", "plusCode": { "globalCode": "849VCWC7+RW", "compoundCode": "CWC7+RW Mountain View, CA, USA" }, "displayName": { "text": "Googleplex", "languageCode": "en" } }
Essayer
APIs Explorer vous permet de créer des exemples de requêtes afin que vous puissiez vous familiariser avec l'API et ses options.
Pour envoyer une demande:
- Sélectionnez l'icône API sur le côté droit de la page.
- Vous pouvez également définir le paramètre
name
sur :places/PLACE_ID
- Vous pouvez également développer Afficher les paramètres standards et définir le paramètre
fields
sur le masque de champ. - Sélectionnez le bouton Execute (Exécuter). Dans le pop-up, sélectionnez le compte que vous souhaitez utiliser pour effectuer la demande.
Dans le panneau APIs Explorer, sélectionnez l'icône de développement pour développer la fenêtre de l'explorateur d'API.