Une requête Find Place (ancienne version) prend une entrée de texte et renvoie un lieu. Il peut s'agir de n'importe quel type de données textuelles Places, comme un nom, une adresse ou un numéro de téléphone. La requête doit être une chaîne. Une requête Find Place (Legacy) utilisant des données autres que des chaînes, comme des coordonnées de latitude/longitude ou un Plus Code, génère une erreur.
Requêtes Find Place (ancienne version)
Une requête Find Place (ancienne version) est une URL HTTP au format suivant :
https://maps.googleapis.com/maps/api/place/findplacefromtext/output?parameters
où output peut correspondre à l'une des valeurs suivantes :
json(recommandé) indique une sortie au format JSON (JavaScript Object Notation).xmlindique une sortie au format XML.
Certains paramètres sont obligatoires pour lancer une requête Find Place (ancienne version). Comme c'est la norme pour les URL, les différents paramètres sont séparés par une esperluette (&).
Paramètres obligatoires
-
entrée
Chaîne de texte sur laquelle effectuer la recherche. Il doit s'agir d'un nom de lieu, d'une adresse ou d'un numéro de téléphone (par exemple, "123 Main Street" ou "Hôtel de ville").
-
inputtype
Type d'entrée. Il peut s'agir de
textqueryou dephonenumber. Les numéros de téléphone doivent être au format international, c'est-à-dire précédés du signe plus ("+"), suivi du code pays, puis du numéro de téléphone. Pour en savoir plus, consultez la Recommandation UIT-T E.164.
Paramètres facultatifs
-
champs
Attention : Les requêtes Place Search (ancienne version) et Place Details (ancienne version) ne renvoient pas les mêmes champs. Les requêtes Place Search (ancienne version) renvoient un sous-ensemble des champs renvoyés par les requêtes Place Details (ancienne version). Si le champ souhaité n'est pas renvoyé par Place Search (ancienne version), vous pouvez l'utiliser pour obtenir unplace_id, puis utiliser l'ID de lieu pour effectuer une requête Place Details (ancienne version). Pour en savoir plus sur les champs non disponibles dans une requête Place Search (ancienne version), consultez Compatibilité des champs de l'API Places.Utilisez le paramètre "fields" pour spécifier une liste de types de données de lieu à renvoyer, séparés par une virgule. Par exemple :
fields=formatted_address,name,geometry. Utilisez une barre oblique lorsque vous spécifiez des valeurs composées. Par exemple :opening_hours/open_now.Les champs sont divisés en trois catégories de facturation : Basic, Contact et Atmosphere. Les champs Basic sont facturés au tarif de base, tandis que les champs Contact et Atmosphere sont facturés à un tarif plus élevé. Les SKU Basic, Contact et Atmosphere sont facturés en plus du SKU de base (Places Details, Find Place, Nearby Search ou Text Search) pour la requête qui les a déclenchés. Pour en savoir plus, consultez la grille tarifaire.
Basic
La catégorie "Basic" comprend les champs suivants :
address_components,adr_address,business_status,formatted_address,geometry,icon,icon_mask_base_uri,icon_background_color,name,permanently_closed(obsolète),photo,place_id,plus_code,type,url,utc_offset,vicinity,wheelchair_accessible_entrance.Contact
La catégorie "Contact" comprend les champs suivants :
current_opening_hours,formatted_phone_number,international_phone_number,opening_hours,secondary_opening_hours,websiteAmbiance
La catégorie "Ambiance" comprend les champs suivants :
curbside_pickup,delivery,dine_in,editorial_summary,price_level,rating,reservable,reviews,serves_beer,serves_breakfast,serves_brunch,serves_dinner,serves_lunch,serves_vegetarian_food,serves_wine,takeout,user_ratings_total.Remarque : Les attributions (html_attributions) sont toujours renvoyées avec chaque appel, que le champ ait été demandé ou non. -
language
Langue dans laquelle les résultats doivent être renvoyés.
- Consultez la liste des langues acceptées. Google met souvent à jour les langues acceptées. Cette liste n'est donc pas exhaustive.
-
Si
languagen'est pas fourni, l'API tente d'utiliser la langue préférée spécifiée dans l'en-têteAccept-Language. - L'API s'efforce de fournir une adresse postale lisible à la fois pour l'utilisateur et pour les habitants. Pour atteindre cet objectif, elle renvoie les adresses postales dans la langue locale, translitté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 d'adresse sont tous renvoyés dans la même langue, qui est choisie à partir du premier composant.
- Si aucun nom n'est disponible dans la langue préférée, l'API utilise la correspondance la plus proche.
- La langue préférée a une légère 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, par exemple les abréviations des types de rues ou les synonymes qui peuvent être valides dans une langue, mais pas dans une autre. Par exemple, utca et tér sont des synonymes de "rue" en hongrois.
-
locationbias
Privilégiez les résultats dans une zone spécifiée, en indiquant un rayon et une latitude/longitude, ou deux paires de latitude/longitude représentant les points d'un rectangle. Si ce paramètre n'est pas spécifié, l'API utilise par défaut la pondération par adresse IP.
-
Biais d'adresse IP : indique à l'API d'utiliser le biais d'adresse IP. Transmettez la chaîne
ipbias(cette option ne comporte aucun paramètre supplémentaire). -
Circulaire : chaîne spécifiant le rayon en mètres, ainsi que la latitude/longitude en degrés décimaux. Utilisez le format suivant :
circle:radius@lat,lng. -
Rectangulaire : chaîne spécifiant deux paires de coordonnées de latitude/longitude en degrés décimaux, représentant les points sud/ouest et nord/est d'un rectangle. Utilisez le format suivant :
rectangle:south,west|north,east. Notez que les valeurs est/ouest sont comprises entre -180 et 180, et que les valeurs nord/sud sont comprises entre -90 et 90.
-
Biais d'adresse IP : indique à l'API d'utiliser le biais d'adresse IP. Transmettez la chaîne
Exemples Find Place (ancienne version)
L'exemple suivant montre une requête Find Place (ancienne version) pour "Musée d'art contemporain Australie", incluant les champs photos, formatted_address, name, rating, opening_hours et geometry :
curl
curl -L -X GET 'https://maps.googleapis.com/maps/api/place/findplacefromtext/json?input=Museum%20of%20Contemporary%20Art%20Australia&inputtype=textquery&fields=formatted_address%2Cname%2Crating%2Copening_hours%2Cgeometry&key=YOUR_API_KEY'HTTP
https://maps.googleapis.com/maps/api/place/findplacefromtext/json ?fields=formatted_address%2Cname%2Crating%2Copening_hours%2Cgeometry &input=Museum%20of%20Contemporary%20Art%20Australia &inputtype=textquery &key=YOUR_API_KEY
L'exemple suivant montre une requête Find Place (ancienne version) pour "Mongolian Grill", qui utilise le paramètre locationbias pour privilégier les résultats situés dans un rayon de 2 000 mètres autour des coordonnées spécifiées :
curl
curl -L -X GET 'https://maps.googleapis.com/maps/api/place/findplacefromtext/json?input=Mongolian%20Grill&inputtype=textquery&fields=formatted_address%2Cname%2Crating%2Copening_hours%2Cgeometry&locationbias=circle:2000@−33.866,151.216&key=YOUR_API_KEY'HTTP
https://maps.googleapis.com/maps/api/place/findplacefromtext/json ?fields=formatted_address%2Cname%2Crating%2Copening_hours%2Cgeometry &input=Mongolian%20Grill &inputtype=textquery &locationbias=circle:2000@−33.866,151.216 &key=YOUR_API_KEY
L'exemple suivant montre une requête Find Place (ancienne version) pour un numéro de téléphone. Notez que le préfixe d'appel international "+" a été encodé en %2B afin que cette requête soit une URL conforme. S'il n'est pas encodé, le préfixe + est décodé en tant qu'espace sur le serveur, ce qui entraîne une recherche de numéro de téléphone non valide.
curl
curl -L -X GET 'https://maps.googleapis.com/maps/api/place/findplacefromtext/json?input=%2B16502530000&inputtype=phonenumber&fields=formatted_address%2Cname%2Crating%2Copening_hours%2Cgeometry&key=YOUR_API_KEY'HTTP
https://maps.googleapis.com/maps/api/place/findplacefromtext/json ?fields=formatted_address%2Cname%2Crating%2Copening_hours%2Cgeometry &input=%2B16502530000 &inputtype=phonenumber &key=YOUR_API_KEY
Réponses Find Place (ancienne version)
Une réponse Find Place (ancienne version) ne contient que les types de données spécifiés à l'aide du paramètre fields, plus html_attributions. L'exemple suivant montre la réponse à une requête Find Place (ancienne version) pour "Musée d'art contemporain Australie", y compris les champs formatted_address, geometry, name, opening_hours, photos et rating.
JSON
{ "candidates": [ { "formatted_address": "140 George St, The Rocks NSW 2000, Australia", "geometry": { "location": { "lat": -33.8599358, "lng": 151.2090295 }, "viewport": { "northeast": { "lat": -33.85824377010728, "lng": 151.2104386798927 }, "southwest": { "lat": -33.86094342989272, "lng": 151.2077390201073 }, }, }, "name": "Museum of Contemporary Art Australia", "opening_hours": { "open_now": false }, "rating": 4.4, }, ], "status": "OK", }
XML
<?xml version="1.0" encoding="UTF-8"?> <FindPlaceFromTextResponse> <candidates> <name>Museum of Contemporary Art Australia</name> <formatted_address>140 George St, The Rocks NSW 2000, Australia</formatted_address> <geometry> <location> <lat>-33.8599358</lat> <lng>151.2090295</lng> </location> <viewport> <southwest> <lat>-33.8609434</lat> <lng>151.2077390</lng> </southwest> <northeast> <lat>-33.8582438</lat> <lng>151.2104387</lng> </northeast> </viewport> </geometry> <rating>4.4</rating> <opening_hours> <open_now>false</open_now> </opening_hours> </candidates> <status>OK</status> </FindPlaceFromTextResponse>
PlacesFindPlaceFromTextResponse
| Champ | Obligatoire | Type | Description |
|---|---|---|---|
|
required | Array<Place> |
Contient un tableau de candidats Place.
Les requêtes Place Search (ancienne version) renvoient un sous-ensemble des champs renvoyés par les requêtes Place Details (ancienne version). Si le champ souhaité n'est pas renvoyé par Place Search (ancienne version), vous pouvez l'utiliser pour obtenir un place_id, puis utiliser l'ID de lieu pour effectuer une requête Place Details (ancienne version).
Pour en savoir plus, consultez Place. |
|
required | PlacesSearchStatus |
Contient l'état de la requête et éventuellement des informations de débogage qui vous aident à savoir pourquoi la requête a échoué. Pour en savoir plus, consultez PlacesSearchStatus. |
|
facultatif | chaîne |
Lorsque le service renvoie un code d'état autre que |
|
facultatif | Array<string> |
Lorsque le service renvoie des informations supplémentaires sur la spécification de la requête, un champ |
PlacesSearchStatus
Codes d'état renvoyés par le service.
OK, qui indique que la requête API a abouti ;-
ZERO_RESULTSindiquant que la recherche a abouti, mais n'a renvoyé aucun résultat. Cela peut se produire si la recherche a reçu unlatlngdans un emplacement distant. -
INVALID_REQUEST, qui indique que la requête API était incorrecte, généralement en raison d'un paramètre de requête obligatoire manquant (locationouradius) ; -
OVER_QUERY_LIMITindiquant l'un des éléments suivants :- Vous avez dépassé la limite de RPS.
- La facturation n'a pas été activée sur votre compte.
- Le crédit mensuel de 200 $ ou la limite d'utilisation que vous avez définie vous-même a été dépassé.
- Le mode de facturation fourni n'est plus valide (une carte de crédit est arrivée à expiration, par exemple).
-
REQUEST_DENIED, qui indique que votre requête a été rejetée, généralement pour les raisons suivantes :- La requête ne contient pas de clé API.
- Le paramètre
keyn'est pas valide.
UNKNOWN_ERROR, qui indique une erreur inconnue.
Lieu
Les réponses Place Search renvoient le sous-ensemble suivant des champs Place. Tous les attributs ne sont pas disponibles pour tous les types de lieux. Pour récupérer les champs que Place Search ne renvoie pas, tels que address_components, formatted_phone_number, reviews ou website, transmettez le place_id renvoyé dans une requête Place Details (Ancienne version). Pour connaître la disponibilité des champs et les niveaux de tarification des points de terminaison, consultez Champs de données de lieu (anciens).
| Champ | Type | Description |
|---|---|---|
business_status |
string |
Indique l'état opérationnel du lieu (s'il s'agit d'une entreprise) : OPERATIONAL, CLOSED_TEMPORARILY ou CLOSED_PERMANENTLY. Cette option est omise si aucune donnée d'état n'existe.
|
formatted_address |
string |
Adresse lisible par l'humain de ce lieu. Renvoyé par Text Search (ancienne version) et Find Place (ancienne version). N'analysez pas l'adresse formatée de manière programmatique. Demandez plutôt address_components dans Place Details (ancienne version).
|
geometry |
Geometry
|
Contient l'élément location géocodé avec les coordonnées lat et lng, ainsi que l'élément viewport préféré avec les limites northeast et southwest.
|
icon |
string |
URL d'une icône suggérée que vous pouvez afficher lorsque vous indiquez ce résultat sur une carte. |
icon_background_color
|
string |
Code couleur hexadécimal par défaut pour la catégorie du lieu. |
icon_mask_base_uri |
string |
URL de base d'une icône recommandée, sans l'extension de type de fichier SVG ou PNG. |
name |
string |
Nom lisible par l'humain du résultat renvoyé. Pour les résultats establishment, cette valeur correspond généralement au nom canonique de l'établissement.
|
opening_hours |
PlaceOpeningHours
|
Informations sur les horaires d'ouverture. Les points de terminaison Place Search ne renvoient que le sous-champ booléen open_now. Demandez opening_hours dans Place Details (ancienne version) pour periods et weekday_text.
|
permanently_closed |
boolean |
Obsolète : utilisez business_status pour vérifier l'état opérationnel d'un établissement.
|
photos |
Array<PlacePhoto>
|
Tableau d'objets PlacePhoto, chacun contenant un photo_reference, un height, un width et un html_attributions. Pour en savoir plus sur l'utilisation, consultez Place Photos (ancien).
|
place_id |
string |
Identifiant textuel qui identifie un lieu de manière unique. Transmettez cet ID dans le paramètre place_id d'une requête Place Details (ancienne version). Consultez la présentation des ID de lieu.
|
plus_code |
PlusCode
|
Référence de lieu encodée dérivée des coordonnées de latitude et de longitude, contenant un global_code et un compound_code facultatif.
|
price_level |
integer |
Niveau de prix du lieu sur une échelle de 0 à 4, du moins cher au plus cher. Consultez price_level.
|
rating |
number |
Note du lieu, sur une échelle de 1.0 à 5.0, basée sur l'ensemble des avis des utilisateurs.
|
reference |
string |
Obsolète : utilisez plutôt place_id.
|
scope |
string |
Obsolète : indique le champ d'application de place_id, qui est toujours GOOGLE. Renvoyé par Nearby Search (ancienne version).
|
types |
Array<string> |
Tableau de types de caractéristiques décrivant le résultat donné. Consultez Types de lieux (anciens). |
user_ratings_total |
integer |
Nombre total de notes, avec ou sans texte d'avis, pour ce lieu. |
vicinity |
string |
Adresse simplifiée du lieu, comprenant la rue, le numéro et la ville, mais sans le département/la province, le code postal ou le pays. Renvoyé par Nearby Search (ancienne version). |