Place Details

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

Le SDK Places pour Android fournit à votre application des informations détaillées sur les lieux, y compris leur nom et leur adresse, l'emplacement géographique spécifié en tant que coordonnées de latitude/longitude, le type de lieu (boîte de nuit, animalerie, musée, etc.). Pour accéder à ces informations sur un lieu spécifique, vous pouvez utiliser l'identifiant de lieu, un identifiant stable qui identifie un lieu de manière unique.

Détails sur le lieu

L'objet Place fournit des informations sur un lieu spécifique. Vous pouvez obtenir un objet Place de différentes manières:

• Appeler PlacesClient.findCurrentPlace() : consultez le guide pour obtenir le lieu actuel.
• Appeler PlacesClient.fetchPlace() : consultez le guide pour obtenir un lieu par ID.

Lorsque vous demandez un lieu, vous devez spécifier les données de lieu à renvoyer. Pour ce faire, transmettez une liste de valeurs Place.Field spécifiant les données à renvoyer. Cette liste est importante, car elle affecte le coût de chaque requête.

Étant donné que les résultats de données de lieu ne peuvent pas être vides, seuls les résultats de ce type sont renvoyés (par exemple, si un lieu demandé n'a pas de photos, le champ photos n'est pas présent dans le résultat).

L'exemple suivant transmet une liste de trois valeurs Place.Field pour spécifier les données renvoyées par une requête:

Java

// Specify the fields to return.
final List placeFields = Arrays.asList(Place.Field.NAME, Place.Field.RATING, Place.Field.OPENING_HOURS);

Kotlin

// Specify the fields to return.
val placeFields = listOf(Place.Field.NAME, Place.Field.RATING, Place.Field.OPENING_HOURS)

Remarque:Bien que PlacesClient.fetchPlace() soit compatible avec tous les détails de lieu, PlacesClient.findCurrentPlace() n'est compatible qu'avec un sous-ensemble de détails sur un lieu. Pour obtenir la liste des champs NON compatibles avec findCurrentPlace(), consultez Compatibilité des champs du SDK Places pour Android.

Après avoir obtenu l'objet Place, utilisez ses méthodes pour accéder aux champs de données spécifiés dans la requête. Si le champ ne figure pas dans l'objet Place, la méthode associée renvoie la valeur "null". Voici quelques exemples de méthodes disponibles. Pour obtenir la liste complète de toutes les méthodes, consultez la documentation de référence de l'API Place.

• getAddress() : adresse du lieu, dans un format lisible.
• getAddressComponents() : List de composants d'adresse de ce lieu. Ces composants sont fournis dans le but d'extraire des informations structurées sur l'adresse d'un lieu, par exemple en recherchant la ville dans laquelle se trouve le lieu. N'utilisez pas ces composants pour le formatage des adresses. Appelez plutôt getAddress(), qui fournit une adresse formatée localisée.
• getId() : identifiant textuel du lieu. Pour en savoir plus sur les ID de lieu, consultez le reste de cette page.
• getLatLng() : emplacement géographique du lieu, spécifié sous la forme de coordonnées de latitude et de longitude.
• getName() : nom du lieu.

• getOpeningHours() : OpeningHours du lieu. Appelez OpeningHours.getWeekdayText() pour renvoyer une liste de chaînes représentant les heures d'ouverture et de fermeture pour chaque jour de la semaine. Appelez OpeningHours.getPeriods() pour renvoyer une liste d'objets period avec des informations plus détaillées équivalentes aux données fournies par getWeekdayText().

  Remarque : Si un lieu est toujours ouvert, la période est représentée par le dimanche à minuit et la valeur closeEvent est nulle.

  L'objet Place contient également la méthode getCurrentOpeningHours(), qui renvoie les horaires d'ouverture d'un lieu au cours des sept prochains jours, et la méthode getSecondaryOpeningHours(), qui renvoie les horaires d'ouverture secondaires d'un lieu au cours des sept prochains jours.

• isOpen() : valeur booléenne indiquant si l'établissement est actuellement ouvert. Si aucune heure n'est spécifiée, la valeur par défaut est maintenant. isOpen n'est renvoyé que si Place.Field.UTC_OFFSET et Place.Field.OPENING_HOURS sont disponibles. Pour garantir l'exactitude des résultats, demandez les champs Place.Field.BUSINESS_STATUS et Place.Field.UTC_OFFSET dans votre requête de lieu d'origine. Sinon, nous supposons que l'établissement est opérationnel. Regardez cette vidéo pour découvrir comment utiliser isOpen avec Place Details.

  Remarque : Cette méthode est obsolète. Utilisez plutôt PlacesClient.isOpen(IsOpenRequest request). Pour en savoir plus, consultez Obtenir l'état d'ouverture.

Voici quelques exemples simples :

Java

final CharSequence name = place.getName();
final CharSequence address = place.getAddress();
final LatLng location = place.getLatLng();

      

Kotlin

val name = place.name
val address = place.address
val location = place.latLng

      

Obtenir un lieu par identifiant

Un ID de lieu est un identifiant texte qui identifie un lieu de façon unique. Dans le SDK Places pour Android, vous pouvez récupérer l'ID d'un lieu en appelant Place.getId(). Le service Place Autocomplete renvoie également un ID de lieu correspondant à la requête et au filtre fournis. Vous pouvez stocker l'ID de lieu et l'utiliser pour récupérer à nouveau l'objet Place.

Pour obtenir un lieu par ID, appelez PlacesClient.fetchPlace() en transmettant une FetchPlaceRequest.

L'API renvoie un FetchPlaceResponse dans un Task. FetchPlaceResponse contient un objet Place correspondant à l'ID de lieu fourni.

L'exemple de code suivant montre comment appeler fetchPlace() pour obtenir des détails sur le lieu spécifié.

Java

// Define a Place ID.
final String placeId = "INSERT_PLACE_ID_HERE";

// Specify the fields to return.
final List<Place.Field> placeFields = Arrays.asList(Place.Field.ID, Place.Field.NAME);

// Construct a request object, passing the place ID and fields array.
final FetchPlaceRequest request = FetchPlaceRequest.newInstance(placeId, placeFields);

placesClient.fetchPlace(request).addOnSuccessListener((response) -> {
    Place place = response.getPlace();
    Log.i(TAG, "Place found: " + place.getName());
}).addOnFailureListener((exception) -> {
    if (exception instanceof ApiException) {
        final ApiException apiException = (ApiException) exception;
        Log.e(TAG, "Place not found: " + exception.getMessage());
        final int statusCode = apiException.getStatusCode();
        // TODO: Handle error with given status code.
    }
});

      

Kotlin

// Define a Place ID.
val placeId = "INSERT_PLACE_ID_HERE"

// Specify the fields to return.
val placeFields = listOf(Place.Field.ID, Place.Field.NAME)

// Construct a request object, passing the place ID and fields array.
val request = FetchPlaceRequest.newInstance(placeId, placeFields)

placesClient.fetchPlace(request)
    .addOnSuccessListener { response: FetchPlaceResponse ->
        val place = response.place
        Log.i(PlaceDetailsActivity.TAG, "Place found: ${place.name}")
    }.addOnFailureListener { exception: Exception ->
        if (exception is ApiException) {
            Log.e(TAG, "Place not found: ${exception.message}")
            val statusCode = exception.statusCode
            TODO("Handle error with given status code")
        }
    }

      

Vous pouvez utiliser un CancellationToken pour essayer d'annuler une requête envoyée à l'une des classes de requête (par exemple, FetchPlaceRequest). L'annulation est effectuée du mieux possible. Une fois la demande d'annulation envoyée, aucune réponse ne sera renvoyée. L'émission d'un jeton d'annulation ne garantit PAS l'annulation d'une requête particulière, et elle peut vous être facturée même si aucune réponse n'est renvoyée.

Afficher l'état d'ouverture

La méthode PlacesClient.isOpen(IsOpenRequest request) renvoie un objet IsOpenResponse indiquant si le lieu est actuellement ouvert en fonction de l'heure spécifiée dans l'appel.

Cette méthode utilise un seul argument de type IsOpenRequest qui contient:

• Un objet Place ou une chaîne spécifiant un ID de lieu
  Remarque : L'objet Place doit contenir un ID de lieu valide.
• Valeur de temps facultative spécifiant l'heure en millisecondes à partir de 1970-01-01T00:00:00Z. Si aucune heure n'est spécifiée, la valeur par défaut est maintenant.

Cette méthode nécessite que les champs suivants existent dans l'objet Place:

• Place.Field.BUSINESS_STATUS
• Place.Field.CURRENT_OPENING_HOURS
• Place.Field.OPENING_HOURS
• Place.Field.UTC_OFFSET

Si ces champs ne sont pas fournis dans l'objet Place ou si vous transmettez un ID de lieu, la méthode les récupère à l'aide de PlacesClient.fetchPlace(). Pour en savoir plus sur la création de l'objet Place avec les champs nécessaires, consultez Détails du lieu.

Remarque : Le SKU Basic Data de Places est facturé pour les appels faits à fetchPlace() pour Place.Field.UTC_OFFSET et Place.Field.BUSINESS_STATUS. Le SKU Contact Data de Places est facturé pour les appels faits à fetchPlace() dans Place.Field.CURRENT_OPENING_HOURS et Place.Field.OPENING_HOURS.

L'exemple suivant détermine si un lieu est actuellement ouvert. Dans cet exemple, vous transmettez l'ID de lieu uniquement à isOpen():

Java

@NonNull
Calendar isOpenCalendar = Calendar.getInstance();
String placeId = "ChIJD3uTd9hx5kcR1IQvGfr8dbk";
IsOpenRequest isOpenRequest;

try {
    isOpenRequest = IsOpenRequest.newInstance(placeId, isOpenCalendar.getTimeInMillis());
} catch (IllegalArgumentException e) {
    e.printStackTrace();
    return;
}

Task<IsOpenResponse> placeTask = placesClient.isOpen(isOpenRequest);

placeTask.addOnSuccessListener(
        (response) ->
                isOpen = response.isOpen());
// ...

      

Kotlin

val isOpenCalendar: Calendar = Calendar.getInstance()
val placeId = "ChIJD3uTd9hx5kcR1IQvGfr8dbk"

val request: IsOpenRequest = try {
    IsOpenRequest.newInstance(placeId, isOpenCalendar.timeInMillis)
} catch (e: IllegalArgumentException) {
    e.printStackTrace()
    return
}
val isOpenTask: Task<IsOpenResponse> = placesClient.isOpen(request)
isOpenTask.addOnSuccessListener { response ->
    val isOpen = response.isOpen
}
// ...

      

L'exemple suivant montre comment appeler isOpen() où vous transmettez un objet Place. L'objet Place doit contenir un ID de lieu valide:

Java

@NonNull
Calendar isOpenCalendar = Calendar.getInstance();
String placeId = "ChIJD3uTd9hx5kcR1IQvGfr8dbk";
// Specify the required fields for an isOpen request.
List<Place.Field> placeFields = new ArrayList<>(Arrays.asList(
        Place.Field.BUSINESS_STATUS,
        Place.Field.CURRENT_OPENING_HOURS,
        Place.Field.ID,
        Place.Field.OPENING_HOURS,
        Place.Field.UTC_OFFSET
));

FetchPlaceRequest request = FetchPlaceRequest.newInstance(placeId, placeFields);
Task<FetchPlaceResponse> placeTask = placesClient.fetchPlace(request);

placeTask.addOnSuccessListener(
        (placeResponse) -> {
            Place place = placeResponse.getPlace();
            IsOpenRequest isOpenRequest;

            try {
                isOpenRequest = IsOpenRequest.newInstance(place, isOpenCalendar.getTimeInMillis());
            } catch (IllegalArgumentException e) {
                e.printStackTrace();
                return;
            }
            Task<IsOpenResponse> isOpenTask = placesClient.isOpen(isOpenRequest);

            isOpenTask.addOnSuccessListener(
                    (isOpenResponse) -> isOpen = isOpenResponse.isOpen());
            // ...
        });
// ...

      

Kotlin

val isOpenCalendar: Calendar = Calendar.getInstance()
var place: Place
val placeId = "ChIJD3uTd9hx5kcR1IQvGfr8dbk"
// Specify the required fields for an isOpen request.
val placeFields: List<Place.Field> = listOf(
    Place.Field.BUSINESS_STATUS,
    Place.Field.CURRENT_OPENING_HOURS,
    Place.Field.ID,
    Place.Field.OPENING_HOURS,
    Place.Field.UTC_OFFSET
)

val placeRequest: FetchPlaceRequest =
    FetchPlaceRequest.newInstance(placeId, placeFields)
val placeTask: Task<FetchPlaceResponse> = placesClient.fetchPlace(placeRequest)
placeTask.addOnSuccessListener { placeResponse ->
    place = placeResponse.place

    val isOpenRequest: IsOpenRequest = try {
        IsOpenRequest.newInstance(place, isOpenCalendar.timeInMillis)
    } catch (e: IllegalArgumentException) {
        e.printStackTrace()
        return@addOnSuccessListener
    }
    val isOpenTask: Task<IsOpenResponse> = placesClient.isOpen(isOpenRequest)
    isOpenTask.addOnSuccessListener { isOpenResponse ->
        val isOpen = isOpenResponse.isOpen
    }
    // ...
}
// ...

      

Afficher les mentions dans votre application

Lorsque votre application affiche des informations sur un lieu, elle doit également afficher les attributions. Consultez la documentation sur les attributions.

Informations supplémentaires sur les identifiants de lieu

L'identifiant de lieu utilisé dans le SDK Places pour Android est le même que celui utilisé dans l'API Places. Chaque ID de lieu ne peut faire référence qu'à un seul lieu, mais un même lieu peut avoir plusieurs ID. Dans d'autres circonstances, un lieu peut obtenir un nouvel ID de lieu. Cela peut se produire, par exemple, si un établissement déménage.

Lorsque vous demandez un lieu en spécifiant un ID de lieu, vous pouvez être sûr de toujours recevoir le même lieu dans la réponse (si le lieu existe toujours). Notez toutefois que la réponse peut contenir un ID de lieu différent de celui de votre requête.

Pour en savoir plus, consultez la présentation des ID de lieu.