Classe PlacesService
Classe google.maps.places.PlacesService
Contient des méthodes liées à la recherche de lieux et à la récupération d'informations sur un lieu.
Accédez-y en appelant le const {PlacesService} = await google.maps.importLibrary("places")
.
Consultez Bibliothèques de l'API Maps JavaScript.
Constructeur | |
---|---|
PlacesService |
PlacesService(attrContainer) Paramètres :
Crée une instance de PlacesService qui affiche les attributions dans le conteneur spécifié. |
Méthodes | |
---|---|
findPlaceFromPhoneNumber |
findPlaceFromPhoneNumber(request, callback) Paramètres :
Valeur renvoyée : aucune
Récupère une liste de lieux à partir d'un numéro de téléphone. Dans la plupart des cas, la liste de résultats ne doit contenir qu'un seul élément. Toutefois, si la demande est ambiguë, plusieurs résultats peuvent être renvoyés. Les PlaceResult transmis au rappel sont des sous-ensembles d'un PlaceResult complet. Votre application peut obtenir un PlaceResult plus détaillé pour chaque lieu en appelant PlacesService.getDetails et en transmettant le PlaceResult.place_id du lieu souhaité. |
findPlaceFromQuery |
findPlaceFromQuery(request, callback) Paramètres :
Valeur renvoyée : aucune
Récupère une liste de lieux en fonction d'une chaîne de requête. Dans la plupart des cas, la liste de résultats ne doit contenir qu'un seul élément. Toutefois, si la demande est ambiguë, plusieurs résultats peuvent être renvoyés. Les PlaceResult transmis au rappel sont des sous-ensembles d'un PlaceResult complet. Votre application peut obtenir un PlaceResult plus détaillé pour chaque lieu en appelant PlacesService.getDetails et en transmettant le PlaceResult.place_id du lieu souhaité. |
getDetails |
getDetails(request, callback) Paramètres :
Valeur renvoyée : aucune
Récupère des informations sur le lieu identifié par le placeId donné. |
nearbySearch |
nearbySearch(request, callback) Paramètres :
Valeur renvoyée : aucune
Récupère une liste de lieux à proximité d'un emplacement spécifique, en fonction d'un mot clé ou d'un type. L'emplacement doit toujours être spécifié, soit en transmettant un paramètre LatLngBounds , soit en transmettant les paramètres location et radius . Les PlaceResult transmis au rappel sont des sous-ensembles du PlaceResult complet. Votre application peut obtenir un PlaceResult plus détaillé pour chaque lieu en envoyant une requête Place Details et en transmettant le PlaceResult.place_id du lieu souhaité. L'objet PlaceSearchPagination peut être utilisé pour récupérer des pages de résultats supplémentaires (la valeur est "null" s'il s'agit de la dernière page de résultats ou s'il n'y a qu'une seule page de résultats). |
textSearch |
textSearch(request, callback) Paramètres :
Valeur renvoyée : aucune
Récupère une liste de lieux en fonction d'une chaîne de requête (par exemple, "pizza à New York" ou "magasins de chaussures près d'Ottawa"). Les paramètres de localisation sont facultatifs. Lorsque la localisation est spécifiée, les résultats sont uniquement orientés vers les résultats à proximité, et non limités aux lieux situés dans la zone. Utilisez textSearch lorsque vous souhaitez rechercher des lieux à l'aide d'une chaîne arbitraire et dans les cas où vous ne souhaitez pas limiter les résultats de recherche à un lieu spécifique. L'objet PlaceSearchPagination peut être utilisé pour récupérer des pages de résultats supplémentaires (la valeur est "null" s'il s'agit de la dernière page de résultats ou s'il n'y a qu'une seule page de résultats). |
Interface PlaceDetailsRequest
Interface google.maps.places.PlaceDetailsRequest
Requête Place Details à envoyer à PlacesService
.
Propriétés | |
---|---|
placeId |
Type :
string ID du lieu pour lequel des détails sont demandés. |
fields optional |
Type :
Array<string> optional Champs à inclure dans la réponse détaillée, qui seront facturés. Si aucun champ n'est spécifié ou si ['ALL'] est transmis, tous les champs disponibles sont renvoyés et facturés (non recommandé pour les déploiements de production). Pour obtenir la liste des champs, consultez PlaceResult . Les champs imbriqués peuvent être spécifiés avec des chemins d'accès (par exemple, "geometry.location" ). |
language optional |
Type :
string optional Identifiant de la langue dans laquelle les détails doivent être renvoyés. Consultez la liste des langues disponibles. |
region optional |
Type :
string optional Code de région de l'utilisateur. Cela peut avoir une incidence sur les photos qui peuvent être renvoyées, et peut-être sur d'autres éléments. Le code régional accepte une valeur ccTLD ("domaine de premier niveau") à deux caractères. La plupart des codes ccTLD 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"). |
sessionToken optional |
Type :
AutocompleteSessionToken optional Référence unique utilisée pour regrouper la requête de détails avec une session Autocomplete. |
Interface FindPlaceFromPhoneNumberRequest
Interface google.maps.places.FindPlaceFromPhoneNumberRequest
Requête Find Place à partir d'une recherche textuelle à envoyer à PlacesService.findPlaceFromPhoneNumber
.
Propriétés | |
---|---|
fields |
Type :
Array<string> Champs à inclure dans la réponse, qui seront facturés. Si ['ALL'] est transmis, tous les champs disponibles seront renvoyés et facturés (non recommandé pour les déploiements de production). Pour obtenir la liste des champs, consultez PlaceResult . Les champs imbriqués peuvent être spécifiés avec des chemins d'accès (par exemple, "geometry.location" ). |
phoneNumber |
Type :
string Numéro de téléphone du lieu à rechercher. Le format doit être E.164. |
language optional |
Type :
string optional Identifiant de langue pour la langue dans laquelle les noms et adresses doivent être renvoyés, si possible. Consultez la liste des langues disponibles. |
locationBias optional |
Type :
LocationBias optional Biais utilisé lors de la recherche d'un lieu. Le résultat sera pondéré en faveur du LocationBias donné, mais n'y sera pas restreint. |
Interface FindPlaceFromQueryRequest
Interface google.maps.places.FindPlaceFromQueryRequest
Requête Find Place à partir d'une recherche textuelle à envoyer à PlacesService.findPlaceFromQuery
.
Propriétés | |
---|---|
fields |
Type :
Array<string> Champs à inclure dans la réponse, qui seront facturés. Si ['ALL'] est transmis, tous les champs disponibles seront renvoyés et facturés (non recommandé pour les déploiements de production). Pour obtenir la liste des champs, consultez PlaceResult . Les champs imbriqués peuvent être spécifiés avec des chemins d'accès (par exemple, "geometry.location" ). |
query |
Type :
string Requête de la demande. Par exemple, le nom ou l'adresse d'un lieu. |
language optional |
Type :
string optional Identifiant de langue pour la langue dans laquelle les noms et adresses doivent être renvoyés, si possible. Consultez la liste des langues disponibles. |
locationBias optional |
Type :
LocationBias optional Biais utilisé lors de la recherche d'un lieu. Le résultat sera pondéré en faveur du LocationBias donné, mais n'y sera pas restreint. |
Interface PlaceSearchRequest
Interface google.maps.places.PlaceSearchRequest
Requête Place Search à envoyer à PlacesService
.
Propriétés | |
---|---|
bounds optional |
Type :
LatLngBounds|LatLngBoundsLiteral optional Limites dans lesquelles rechercher des lieux. location et radius seront ignorés si bounds est défini. |
keyword optional |
Type :
string optional Terme à mettre en correspondance avec tous les champs disponibles, y compris, mais sans s'y limiter, le nom, le type et l'adresse, ainsi que les avis des clients et d'autres contenus tiers. |
language optional |
Type :
string optional Identifiant de langue pour la langue dans laquelle les noms et adresses doivent être renvoyés, si possible. Consultez la liste des langues disponibles. |
location optional |
Type :
LatLng|LatLngLiteral optional Zone géographique autour de laquelle les lieux sont recherchés. |
maxPriceLevel optional |
Type :
number optional Restreint les résultats aux seuls lieux compris dans la fourchette de prix spécifiée ou inférieure. Les valeurs valides sont comprises entre 0 (le moins cher) et 4 (le plus cher), inclus. Si elle est spécifiée, la valeur doit être supérieure ou égale à minPrice . |
minPriceLevel optional |
Type :
number optional Restreint les résultats aux seuls lieux compris dans la fourchette de prix spécifiée ou supérieure. Les valeurs valides sont comprises entre 0 (le moins cher) et 4 (le plus cher), inclus. Si elle est spécifiée, elle doit être inférieure ou égale à maxPrice . |
|
Type :
string optional Équivaut à keyword . Les valeurs de ce champ sont combinées à celles du champ keyword et transmises dans la même chaîne de recherche. |
openNow optional |
Type :
boolean optional Limite les résultats aux seuls lieux ouverts en ce moment. |
radius optional |
Type :
number optional Distance (en mètres) à partir de la position indiquée dans laquelle rechercher des lieux. La valeur maximale autorisée est de 50 000. |
rankBy optional |
Type :
RankBy optional Par défaut :
RankBy.PROMINENCE Spécifie la méthode de classement à utiliser lors du renvoi des résultats. Notez que lorsque rankBy est défini sur DISTANCE , vous devez spécifier location . Toutefois, vous ne pouvez définir ni radius , ni bounds . |
type optional |
Type :
string optional Recherche des lieux du type spécifié. Le type est traduit dans la langue locale de la zone géographique cible de la demande et utilisé comme chaîne de requête. Si une requête est également fournie, elle est concaténée à la chaîne de type localisée. Les résultats d'un autre type sont supprimés de la réponse. Utilisez ce champ pour effectuer des recherches par catégorie indépendantes de la langue et de la région. Les types valides sont indiqués ici. |
Interface TextSearchRequest
Interface google.maps.places.TextSearchRequest
Requête de recherche textuelle à envoyer à PlacesService
.
Propriétés | |
---|---|
bounds optional |
Type :
LatLngBounds|LatLngBoundsLiteral optional Limites utilisées pour orienter les résultats lors de la recherche de lieux (facultatif). location et radius seront ignorés si bounds est défini. Les résultats ne seront pas limités à ceux situés dans ces limites, mais ceux qui s'y trouvent seront mieux classés. |
language optional |
Type :
string optional Identifiant de langue pour la langue dans laquelle les noms et adresses doivent être renvoyés, si possible. Consultez la liste des langues disponibles. |
location optional |
Type :
LatLng|LatLngLiteral optional Centre de la zone utilisée pour orienter les résultats lors de la recherche de lieux. |
query optional |
Type :
string optional Terme de requête de la demande. Par exemple, le nom d'un lieu ("Tour Eiffel"), une catégorie suivie du nom d'un lieu ("pizza à New York") ou le nom d'un lieu suivi d'un qualificatif de lieu ("Starbucks à Sydney"). |
radius optional |
Type :
number optional Rayon de la zone utilisée pour pondérer les résultats lors de la recherche de lieux (en mètres). |
region optional |
Type :
string optional Code de région pour orienter les résultats. Le code régional accepte une valeur ccTLD ("domaine de premier niveau") à deux caractères. La plupart des codes ccTLD 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"). |
type optional |
Type :
string optional Recherche des lieux du type spécifié. Le type est traduit dans la langue locale de la zone géographique cible de la demande et utilisé comme chaîne de requête. Si une requête est également fournie, elle est concaténée à la chaîne de type localisée. Les résultats d'un autre type sont supprimés de la réponse. Utilisez ce champ pour effectuer des recherches par catégorie indépendantes de la langue et de la région. Les types valides sont indiqués ici. |
Constantes RankBy
google.maps.places.RankBy
constantes
Options de classement pour une PlaceSearchRequest.
Accédez-y en appelant le const {RankBy} = await google.maps.importLibrary("places")
.
Consultez Bibliothèques de l'API Maps JavaScript.
Constantes | |
---|---|
DISTANCE |
Les résultats de recherche de lieux sont classés par distance par rapport à l'emplacement. |
PROMINENCE |
Classe les résultats de lieux en fonction de leur importance. |
LocationBias typedef
google.maps.places.LocationBias
typedef
Un LocationBias représente une limite souple ou un indice à utiliser lors de la recherche de lieux. Les résultats peuvent provenir d'en dehors de la zone spécifiée. Pour utiliser l'adresse IP de l'utilisateur actuel comme biais, vous pouvez spécifier la chaîne "IP_BIAS"
. Remarque : Si vous utilisez un Circle
, le centre et le rayon doivent être définis.
LatLng|LatLngLiteral|LatLngBounds|LatLngBoundsLiteral|Circle|CircleLiteral|string
LocationRestriction typedef
google.maps.places.LocationRestriction
typedef
Une LocationRestriction représente une limite stricte à utiliser lors de la recherche de lieux.
Constantes PlacesServiceStatus
google.maps.places.PlacesServiceStatus
constantes
État renvoyé par PlacesService
à la fin de ses recherches. Spécifiez-les par valeur ou en utilisant le nom de la constante. Par exemple, 'OK'
ou google.maps.places.PlacesServiceStatus.OK
.
Accédez-y en appelant le const {PlacesServiceStatus} = await google.maps.importLibrary("places")
.
Consultez Bibliothèques de l'API Maps JavaScript.
Constantes | |
---|---|
INVALID_REQUEST |
Cette requête n'est pas valide. |
NOT_FOUND |
Le lieu référencé est introuvable. |
OK |
La réponse contient un résultat valide. |
|