Place Details (nouveau)

Sélectionnez une plate-forme : Android iOS JavaScript Services Web

Une fois que vous disposez d'un ID de lieu, vous pouvez demander plus d'informations sur un établissement ou un point d'intérêt particulier en envoyant une requête Place Details (New) (Informations sur le lieu (nouveau)). Une requête Place Details (New) renvoie des informations plus complètes sur le lieu indiqué, comme son adresse complète, son numéro de téléphone, les avis et notes des visiteurs.

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

L'explorateur d'API vous permet d'envoyer des requêtes en direct 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 sous la forme suivante:

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 le cadre de 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)

"Informations sur le lieu (nouveau)" renvoie un objet JSON en 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 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. Aucune liste par défaut des champs renvoyés n'est fournie 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 à appliquer pour vous assurer de ne pas demander de données inutiles. Vous pourrez ainsi réduire 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: *

    Spécifiez un ou plusieurs des champs suivants:

    • Les champs suivants déclenchent le SKU Place Details (IDs Only):

      attributions, 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, containingPlaces, displayName, googleMapsLinks*, googleMapsUri, iconBackgroundColor, iconMaskBaseUri, primaryType, primaryTypeDisplayName, pureServiceAreaBusiness, subDestinations, utcOffsetMinutes

      * Le champ googleMapsLinks est en phase de pré-disponibilité générale et n'est pas facturé (facturation de 0 $) pendant la phase de prévisualisation.

    • Les champs suivants déclenchent le SKU Place Details (Advanced):

      currentOpeningHours, currentSecondaryOpeningHours, internationalPhoneNumber, nationalPhoneNumber, priceLevel, priceRange, 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, routingSummaries,* servesBeer, servesBreakfast, servesBrunch, servesCocktails, servesCoffee, servesDessert, servesDinner, servesLunch, servesVegetarianFood, servesWine, takeout

      * Recherche textuelle et Recherche à proximité uniquement

  • placeId

    Identifiant textuel qui identifie un lieu de manière unique, renvoyé par une requête Text Search (New) (Recherche textuelle (nouvelle version)) ou Nearby Search (New) (Recherche à proximité (nouvelle version)). 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. 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. 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, la valeur par défaut de l'API est en. Si vous spécifiez un code de langue non valide, l'API renvoie une erreur INVALID_ARGUMENT.
    • L'API met tout en œuvre pour fournir une adresse postale lisible à la fois pour l'utilisateur et les locaux. Pour ce faire, il renvoie les adresses dans la langue locale, translitérées dans un script lisible par l'utilisateur si nécessaire, en respectant la langue préférée. Toutes les autres adresses sont renvoyées dans la langue préférée. Les composants de l'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 de votre choix, l'API utilise la correspondance la plus proche.
    • La langue préférée a une faible 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 de région 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 du pays du champ formattedAddress de la réponse correspond à regionCode, le code pays est omis de formattedAddress. Ce paramètre n'a aucun effet sur adrFormatAddress, qui inclut toujours le nom du pays, ni 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 lieu d'une recherche de saisie semi-automatique d'un utilisateur dans une session distincte à des fins de facturation. Les jetons de session sont transmis aux 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 code Plus 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

API Explorer vous permet d'envoyer 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 éventuellement définir le paramètre name sur: 
    places/PLACE_ID
  3. Vous pouvez également développer 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 le pop-up, sélectionnez le compte que vous souhaitez utiliser pour effectuer la demande.

  5. Dans le panneau API Explorer, sélectionnez l'icône de développement, Développez APIs Explorer., pour développer la fenêtre API Explorer.