Places SDK for Android 向您的应用提供关于地点的丰富信息,包括地点的名称和地址、指定为纬度/经度坐标的地理位置、地点类型(如夜总会、宠物店、博物馆等)。若要访问特定地点的此类信息,您可以使用地点 ID(一个唯一标识地点的稳定标识符)。
地点详情
Place
对象可提供有关特定地点的信息。您可以通过以下方式持有 Place
对象:
- 调用
PlacesClient.findCurrentPlace()
- 参阅获取当前地点指南。 - 调用
PlacesClient.fetchPlace()
- 参阅按 ID 获取地点指南。
请求地点时,您必须指定要返回的地点数据。为此,请传递 Place.Field 值的列表,指定要返回的数据。此列表是一个重要考虑因素,因为它会影响每个请求的费用。
由于地点数据结果不得为空,因此系统只会返回包含数据的地点结果(例如,如果请求的地点没有照片,photos
字段将不会显示在结果中)。
以下示例会传递包含三个 Place.Field 值的列表,以指定请求返回的数据:
Java
// Specify the fields to return. final ListplaceFields = 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)
获取 Place
对象后,请使用该对象的方法访问请求中指定的数据字段。如果 Place
对象中缺少该字段,相关方法会返回 null。下面列举了几种可用方法。
如需查看所有方法的完整列表,请参阅 Place
API 参考文档。
getAddress()
- 地点的地址,采用人类可读懂的格式。getAddressComponents()
- 此地点的地址组成部分的List
。提供这些组件的目的是提取地点地址的结构化信息,例如查找地点所在的城市。请勿使用这些组件设置地址格式,而应调用getAddress()
,它可提供本地化格式的地址。getId()
- 地点的文本标识符。您可以在本页面的其余部分详细了解地点 ID。getLatLng()
- 地点的地理位置,以纬度和经度坐标形式指定。getName()
- 地点的名称。getOpeningHours()
- 地点的OpeningHours
。调用OpeningHours.getWeekdayText()
可返回一个字符串列表,该字符串表示一周中各天的营业时段和结束营业时间。调用OpeningHours.getPeriods()
会返回period
对象列表,其中的详细信息相当于getWeekdayText()
提供的数据。Place
对象还包含getCurrentOpeningHours()
方法(用于返回地点未来 7 天的营业时间),以及getSecondaryOpeningHours()
(用于返回地点未来 7 天的次要营业时间)。isOpen()
- 表示地点当前是否营业的布尔值。如果未指定时间,则默认为当前时间。仅当Place.Field.UTC_OFFSET
和Place.Field.OPENING_HOURS
都可用时,系统才会返回isOpen
。为确保结果准确,请在原始地点请求中请求Place.Field.BUSINESS_STATUS
和Place.Field.UTC_OFFSET
字段。 如果未请求,则假定商家开展业务。请观看此视频,了解如何将isOpen
与“地点详情”搭配使用。
以下是一些简单示例:
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
按 ID 获取地点
地点 ID 是唯一标识地点的文本标识符。在 Places SDK for Android 中,您可以通过调用 Place.getId()
来检索地点的 ID。地点自动补全服务还会为每个与返回的搜索查询和过滤条件匹配的地点返回地点 ID。您可以存储地点 ID,以便日后再次检索 Place
对象。
如需按 ID 获取地点,请调用 PlacesClient.fetchPlace()
并传递 FetchPlaceRequest
。
此 API 会在 Task
中返回 FetchPlaceResponse
。FetchPlaceResponse
包含与所提供的地点 ID 匹配的 Place
对象。
以下代码示例展示了如何调用 fetchPlace()
以获取指定地点的详细信息。
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") } }
获取打开状态
PlacesClient.isOpen(IsOpenRequest request)
方法会返回一个 IsOpenResponse
对象,该对象会根据调用中指定的时间指明该地点目前是否营业。
此方法接受类型为 IsOpenRequest
的单个参数,其中包含:
Place
对象或用于指定地点 ID 的字符串。- 可选的时间值,用于指定 1970-01-01T00:00:00Z 中的时间(以毫秒为单位)。如果未指定时间,则默认为当前时间。
此方法要求 Place
对象中包含以下字段:
Place.Field.BUSINESS_STATUS
Place.Field.CURRENT_OPENING_HOURS
Place.Field.OPENING_HOURS
Place.Field.UTC_OFFSET
如果 Place
对象中未提供这些字段,或者如果您传递了地点 ID,该方法会使用 PlacesClient.fetchPlace()
提取这些字段。如需详细了解如何创建包含所需字段的 Place 对象,请参阅地点详情。
以下示例用于确定某个地点目前是否营业。在此示例中,您只需将地点 ID 传递给 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 } // ...
下一个示例展示了如何调用 isOpen()
,并在其中传递 Place
对象。Place
对象必须包含有效的地点 ID:
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 } // ... } // ...
在应用中显示提供方说明
当您的应用显示地点信息时,还必须显示提供方说明。请参阅有关归因的文档。
更多关于地点 ID 的内容
Places SDK for Android 中使用的地点 ID 与 Places API 中使用的地点 ID 相同。每个地点 ID 只能引用一个地点,但单个地点可以有多个地点 ID。还有其他情况可能会导致地点获得新的地点 ID。例如,如果商家迁移到了新的营业地点,就可能发生这种情况。
通过指定地点 ID 来请求地点时,您可以确信自己在响应中始终会收到同一地点(如果该地点仍然存在)。但请注意,响应中包含的地点 ID 可能与请求中的地点 ID 不同。
如需了解详情,请参阅地点 ID 概览。