Place Details (nouveau)

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, ainsi que les notes et avis des utilisateurs.

Il existe de nombreuses façons d'obtenir un ID de lieu. Vous pouvez :

APIs Explorer vous permet d'envoyer des requêtes actives afin de vous familiariser avec l'API et ses options:

Essayer

Requêtes Place Details (New)

Une requête Place 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 des en-têtes avec 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'objet Place 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 ou fields, ou de l'en-tête HTTP X-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 de conception pour vous assurer de ne pas demander de données inutiles, ce qui permet d'éviter des temps de traitement et des frais facturés inutiles.

    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):

      id, name*, photos

      * Le champ name inclut le nom de ressource du lieu dans le formulaire : places/PLACE_ID. Utilisez displayName 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, reviews, servesBeer, servesBreakfast, servesBeer,servesBrunchservesCocktailsservesCoffeeservesDessertsservesDinnerservesLunchservesVegetarianFoodservesWinetakeout

  • placeId

    Identifiant textuel qui identifie un lieu de manière unique, renvoyé par une recherche Text Search (New) ou Nearby Search (New). 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 champ name de la réponse. L'ID de lieu autonome est contenu dans le champ id 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. Google met régulièrement à jour les langues acceptées. Cette liste n'est donc pas exhaustive.
    • Si languageCode n'est pas fourni, l'API est définie par défaut sur en. Si vous spécifiez un code de langue non valide, l'API renvoie une erreur INVALID_ARGUMENT.
    • L'API s'efforce de fournir une adresse postale lisible à la fois par l'utilisateur et par les locaux. Pour atteindre cet objectif, il renvoie les adresses postales dans la langue locale, transcrites en script lisible par l'utilisateur si nécessaire, tout en respectant la langue préférée. Toutes les autres adresses s'affichent dans la langue préférée. Les composants d'adresse sont tous renvoyés dans la même langue, qui est choisie à partir du premier composant.
    • Si un nom n'est pas disponible dans la langue préférée, l'API utilise le nom le plus proche.
    • La langue préférée a une petite influence sur l'ensemble de 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 : par exemple, les abréviations de types de rue ou les synonymes qui peuvent être valides dans une langue, mais pas dans une autre.
  • regionCode

    Code de région utilisé pour mettre en forme la réponse, spécifié en tant que valeur de code CLDR à deux caractères. Il n'existe pas de valeur par défaut.

    Si le nom du pays du champ formattedAddress dans la réponse correspond à regionCode, le code pays est omis dans formattedAddress. Ce paramètre n'a aucun effet sur adrFormatAddress, qui inclut toujours le nom du pays, ou sur shortFormattedAddress, 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"). Le paramètre peut avoir une incidence sur les résultats en fonction de la législation applicable.

  • sessionToken

    Les jetons de session sont des chaînes générées par l'utilisateur qui suivent les appels Autocomplete (New) en tant que "sessions". Autocomplete (New) 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 des 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 maintenant 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

API Explorer vous permet de créer des exemples de requêtes afin de vous familiariser avec l'API et ses options.

Pour envoyer une demande:

  1. Sélectionnez l'icône API Développez APIs Explorer. sur le côté droit de la page.
  2. Vous pouvez également définir le paramètre name sur :
    places/PLACE_ID
  3. Vous pouvez également développer la section Afficher les paramètres standards et définir le paramètre fields sur le masque de champ.
  4. Sélectionnez le bouton Execute (Exécuter). Dans la fenêtre pop-up, sélectionnez le compte que vous souhaitez utiliser pour effectuer la requête.
  5. Dans le panneau de l'explorateur d'API, sélectionnez l'icône de développement Développez APIs Explorer. pour développer la fenêtre de l'explorateur d'API.