本指南說明 Places SDK 相容性程式庫與全新 Places SDK for Android 獨立版本之間的差異。如果您一直使用地點介面集相容性程式庫，而非遷移至新版 Places SDK for Android 獨立版本，本指南說明如何將專案更新為使用新版 Places SDK for Android。
如要存取 Places SDK for Android 2.6.0 以上版本的功能和錯誤修正，就只能使用 Places SDK for Android。Google 建議您盡快從相容性程式庫更新至新版 Places SDK for Android。
異動內容
主要異動如下：
- 新版 Places SDK for Android 是以靜態用戶端程式庫發布。在 2019 年 1 月之前，您可以透過 Google Play 服務取得 Places SDK for Android。之後，我們會提供地點介面集相容性程式庫，協助您轉換至新版 Places SDK for Android。
- 有多種新方法可供選擇，
- 欄位遮罩現在支援傳回 Place Details 的方法。您可以使用欄位遮罩指定要傳回的地點資料類型。
- 用於回報錯誤的狀態碼已經過改善。
- 自動完成功能現在支援工作階段符記。
- 地點挑選器已無法使用。
關於地點介面集相容性程式庫
隨著獨立 Places SDK for Android 1.0 版推出，Google 於 2019 年 1 月提供相容性程式庫，協助您從已停用的 Places SDK for Android (com.google.android.gms:play-services-places) Google Play 服務版本遷出。
這個相容性程式庫暫時提供，將專門用於 Google Play 服務版本的 API 呼叫重新導向並轉譯為新的獨立版本，直到開發人員可以遷移程式碼，使用獨立 SDK 中的新名稱為止。針對從 1.0 版到 2.6.0 版發布的每個 Places SDK for Android 版本，我們都已發布對應的地點介面集相容性程式庫，以提供同等功能。
凍結及淘汰地點介面集相容性程式庫
Places SDK for Android 所有版本的相容性程式庫已於 2022 年 3 月 31 日淘汰。2.6.0 版是地點介面集相容性程式庫的最新版本。如要存取 Places SDK for Android 2.6.0 以上版本的功能和錯誤修正，就只能使用 Places SDK for Android。
Google 建議您遷移至 Places SDK for Android，以便存取 2.6.0 版以上的新功能和重大錯誤修正。如果您目前使用相容性程式庫，請按照「安裝 Places SDK for Android」一節中的步驟操作，遷移至 Places SDK for Android。
安裝用戶端程式庫
新版 Places SDK for Android 是以靜態用戶端程式庫發布。
使用 Maven 將 Places SDK for Android 加進 Android Studio 專案：
如果您目前使用地點介面集相容性程式庫：
在
dependencies區段中，取代下列程式碼：implementation 'com.google.android.libraries.places:places-compat:X.Y.Z'按照這行程式碼切換至 Places SDK for Android：
implementation 'com.google.android.libraries.places:places:3.3.0'
如果你目前使用 Places SDK for Android 的 Play 服務版本：
在
dependencies區段中，取代下列程式碼：implementation 'com.google.android.gms:play-services-places:X.Y.Z'按照這行程式碼切換至 Places SDK for Android：
implementation 'com.google.android.libraries.places:places:3.3.0'
同步處理您的 Gradle 專案。
將應用程式專案的
minSdkVersion設為 16 以上版本。更新「Google 技術提供」素材資源：
@drawable/powered_by_google_light // OLD @drawable/places_powered_by_google_light // NEW @drawable/powered_by_google_dark // OLD @drawable/places_powered_by_google_dark // NEW
建構應用程式。如果您因為轉換至 Places SDK for Android 而看到任何建構錯誤，請參閱以下各節，瞭解如何解決這些錯誤。
初始化新的 Places SDK 用戶端
初始化新的 Places SDK 用戶端，如以下範例所示：
// Add an import statement for the client library.
import com.google.android.libraries.places.api.Places;
...
// Initialize Places.
Places.initialize(getApplicationContext(), apiKey);
// Create a new Places client instance.
PlacesClient placesClient = Places.createClient(this);
狀態碼
QPS 限制錯誤的狀態碼已變更。每秒查詢次數限制錯誤現在會透過 PlaceStatusCodes.OVER_QUERY_LIMIT 傳回。沒有其他 QPD 限制。
已新增下列狀態碼：
REQUEST_DENIED：要求遭拒。可能原因如下：- 未提供 API 金鑰。
- 提供的 API 金鑰無效。
- 尚未啟用 Cloud 控制台的 Places API。
- 提供的 API 金鑰限制有誤，
INVALID_REQUEST：由於缺少引數或引數無效，要求無效。NOT_FOUND：找不到與指定要求相符的結果。
新方法
新版 Places SDK for Android 導入了專為一致性設計的全新方法。所有的新方法都符合下列規定：
- 端點不再使用
get動詞。 - 要求和回應物件的名稱與對應的用戶端方法相同。
- 要求物件現在已有建構工具；必要參數會以要求建構工具參數的形式傳遞。
- 系統已不再使用緩衝區。
本節將介紹新方法，並說明運作方式。
依 ID 擷取地點
使用 fetchPlace() 即可取得特定地點的詳細資料。fetchPlace() 函式與 getPlaceById() 類似。
如要擷取地點，請按照下列步驟操作：
呼叫
fetchPlace()，並傳遞指定地點 ID 的FetchPlaceRequest物件和欄位清單，指定要傳回的地點資料。// Define a Place ID. String placeId = "INSERT_PLACE_ID_HERE"; // Specify the fields to return. List<Place.Field> placeFields = Arrays.asList(Place.Field.ID, Place.Field.NAME); // Construct a request object, passing the place ID and fields array. FetchPlaceRequest request = FetchPlaceRequest.builder(placeId, placeFields) .build();呼叫
addOnSuccessListener()來處理FetchPlaceResponse。系統會傳回單一Place結果。// Add a listener to handle the response. placesClient.fetchPlace(request).addOnSuccessListener((response) -> { Place place = response.getPlace(); Log.i(TAG, "Place found: " + place.getName()); }).addOnFailureListener((exception) -> { if (exception instanceof ApiException) { ApiException apiException = (ApiException) exception; int statusCode = apiException.getStatusCode(); // Handle error with given status code. Log.e(TAG, "Place not found: " + exception.getMessage()); } });
擷取地點相片
使用 fetchPhoto() 取得地點相片。fetchPhoto() 會傳回地點的相片。要求相片的模式已簡化。您現在可以直接透過 Place 物件要求 PhotoMetadata，不再需要個別要求。相片寬度或高度上限為 1600 像素。fetchPhoto() 函式與 getPhoto() 類似。
如要擷取地點相片，請按照下列步驟操作：
設定
fetchPlace()通話。請務必在要求中加入PHOTO_METADATAS欄位：List<Place.Field> fields = Arrays.asList(Place.Field.PHOTO_METADATAS);取得 Place 物件 (本範例使用
fetchPlace()，但您也可以使用findCurrentPlace())：FetchPlaceRequest placeRequest = FetchPlaceRequest.builder(placeId, fields).build();新增
OnSuccessListener，從FetchPlaceResponse中產生的Place取得相片中繼資料，然後使用產生的相片中繼資料取得點陣圖和作者資訊文字：placesClient.fetchPlace(placeRequest).addOnSuccessListener((response) -> { Place place = response.getPlace(); // Get the photo metadata. PhotoMetadata photoMetadata = place.getPhotoMetadatas().get(0); // Get the attribution text. String attributions = photoMetadata.getAttributions(); // Create a FetchPhotoRequest. FetchPhotoRequest photoRequest = FetchPhotoRequest.builder(photoMetadata) .setMaxWidth(500) // Optional. .setMaxHeight(300) // Optional. .build(); placesClient.fetchPhoto(photoRequest).addOnSuccessListener((fetchPhotoResponse) -> { Bitmap bitmap = fetchPhotoResponse.getBitmap(); imageView.setImageBitmap(bitmap); }).addOnFailureListener((exception) -> { if (exception instanceof ApiException) { ApiException apiException = (ApiException) exception; int statusCode = apiException.getStatusCode(); // Handle error with given status code. Log.e(TAG, "Place not found: " + exception.getMessage()); } }); });
根據使用者的位置尋找地點
使用 findCurrentPlace() 找出使用者裝置目前的位置。findCurrentPlace() 會傳回 PlaceLikelihood 清單，指出使用者裝置最可能的所在位置。findCurrentPlace() 函式與 getCurrentPlace() 類似。
請按照下列步驟取得使用者裝置的目前位置：
確認應用程式要求
ACCESS_FINE_LOCATION和ACCESS_WIFI_STATE權限。使用者必須授予權限，才能存取目前裝置的位置資訊。詳情請參閱「要求應用程式權限」。建立
FindCurrentPlaceRequest，包括要傳回的地點資料類型清單。// Use fields to define the data types to return. List<Place.Field> placeFields = Arrays.asList(Place.Field.NAME); // Use the builder to create a FindCurrentPlaceRequest. FindCurrentPlaceRequest request = FindCurrentPlaceRequest.builder(placeFields).build();呼叫 findCurrentPlace 並處理回應，先確認使用者是否已授權使用裝置位置資訊。
// Call findCurrentPlace and handle the response (first check that the user has granted permission). if (ContextCompat.checkSelfPermission(this, ACCESS_FINE_LOCATION) == PackageManager.PERMISSION_GRANTED) { placesClient.findCurrentPlace(request).addOnSuccessListener(((response) -> { for (PlaceLikelihood placeLikelihood : response.getPlaceLikelihoods()) { Log.i(TAG, String.format("Place '%s' has likelihood: %f", placeLikelihood.getPlace().getName(), placeLikelihood.getLikelihood())); textView.append(String.format("Place '%s' has likelihood: %f\n", placeLikelihood.getPlace().getName(), placeLikelihood.getLikelihood())); } })).addOnFailureListener((exception) -> { if (exception instanceof ApiException) { ApiException apiException = (ApiException) exception; Log.e(TAG, "Place not found: " + apiException.getStatusCode()); } }); } else { // A local method to request required permissions; // See https://developer.android.com/training/permissions/requesting getLocationPermission(); }
尋找自動完成預測功能
使用 findAutocompletePredictions() 即可傳回地點預測結果，以回應使用者的搜尋查詢。findAutocompletePredictions() 函式與 getAutocompletePredictions() 類似。
下例示範如何呼叫 findAutocompletePredictions()：
// Create a new token for the autocomplete session. Pass this to FindAutocompletePredictionsRequest,
// and once again when the user makes a selection (for example when calling fetchPlace()).
AutocompleteSessionToken token = AutocompleteSessionToken.newInstance();
// Create a RectangularBounds object.
RectangularBounds bounds = RectangularBounds.newInstance(
new LatLng(-33.880490, 151.184363),
new LatLng(-33.858754, 151.229596));
// Use the builder to create a FindAutocompletePredictionsRequest.
FindAutocompletePredictionsRequest request = FindAutocompletePredictionsRequest.builder()
// Call either setLocationBias() OR setLocationRestriction().
.setLocationBias(bounds)
//.setLocationRestriction(bounds)
.setCountry("au")
.setTypesFilter(Arrays.asList(PlaceTypes.ADDRESS))
.setSessionToken(token)
.setQuery(query)
.build();
placesClient.findAutocompletePredictions(request).addOnSuccessListener((response) -> {
for (AutocompletePrediction prediction : response.getAutocompletePredictions()) {
Log.i(TAG, prediction.getPlaceId());
Log.i(TAG, prediction.getPrimaryText(null).toString());
}
}).addOnFailureListener((exception) -> {
if (exception instanceof ApiException) {
ApiException apiException = (ApiException) exception;
Log.e(TAG, "Place not found: " + apiException.getStatusCode());
}
});
工作階段符記
工作階段符記會將使用者搜尋的查詢和選取階段歸入單獨的工作階段，以用於計費。建議您在所有自動完成工作階段使用工作階段符記。工作階段是從使用者輸入查詢時開始，到使用者選取地點時結束。在每個工作階段中，使用者可以執行多項查詢，隨後選擇一個地點。工作階段結束後，憑證就會失效；應用程式必須為每個工作階段產生新的符記。
欄位遮罩
在傳回 Place Details 的方法中，您必須指定每個要求要傳回的地點資料類型。這有助於確保您只要求 (並支付) 實際使用的資料費用。
如要指定要傳回的資料類型，請在 FetchPlaceRequest 中傳遞 Place.Field 陣列，如以下範例所示：
// Include address, ID, and phone number.
List<Place.Field> placeFields = Arrays.asList(Place.Field.ADDRESS,
Place.Field.ID,
Place.Field.PHONE_NUMBER);
您可以使用下列一或多個欄位：
Place.Field.ADDRESSPlace.Field.IDPlace.Field.LAT_LNGPlace.Field.NAMEPlace.Field.OPENING_HOURSPlace.Field.PHONE_NUMBERPlace.Field.PHOTO_METADATASPlace.Field.PLUS_CODEPlace.Field.PRICE_LEVELPlace.Field.RATINGPlace.Field.TYPESPlace.Field.USER_RATINGS_TOTALPlace.Field.VIEWPORTPlace.Field.WEBSITE_URI
進一步瞭解地點資料 SKU。
Place Picker 和 Autocomplete 更新
本節說明地點介面集小工具的異動內容 (地點挑選器和自動完成)。
程式輔助自動完成
自動完成功能進行了下列變更：
PlaceAutocomplete已重新命名為Autocomplete。PlaceAutocomplete.getPlace已重新命名為Autocomplete.getPlaceFromIntent。PlaceAutocomplete.getStatus已重新命名為Autocomplete.getStatusFromIntent。
PlaceAutocomplete.RESULT_ERROR已重新命名為AutocompleteActivity.RESULT_ERROR(自動完成片段的錯誤處理方式「未」變更)。
地點挑選器
「地點挑選程式」已於 2019 年 1 月 29 日淘汰。這項功能已於 2019 年 7 月 29 日停用，不再提供使用。如果繼續使用，則會收到錯誤訊息。新版 SDK 不支援 Place Picker。
自動完成小工具
自動完成小工具已更新：
Place前置字串已從所有類別中移除。- 開始支援工作階段權杖。小工具會自動在背景管理權杖。
- 新增欄位遮罩支援功能，讓您選擇要在使用者選取項目後，傳回的地點資料類型。
以下各節說明如何在專案中新增 Autocomplete 小工具。
嵌入 AutocompleteFragment
如要新增自動完成片段，請按照下列步驟操作：
將片段新增至活動的 XML 版面配置，如以下範例所示。
<fragment android:id="@+id/autocomplete_fragment" android:layout_width="match_parent" android:layout_height="wrap_content" android:name= "com.google.android.libraries.places.widget.AutocompleteSupportFragment" />如要在活動中新增 Autocomplete 小工具，請按照下列步驟操作：
- 初始化
Places，傳遞應用程式結構定義和您的 API 金鑰。 - 初始化
AutocompleteSupportFragment。 - 呼叫
setPlaceFields()來表示您想取得的地點資料類型。 - 新增
PlaceSelectionListener以對結果執行某些操作，並處理可能發生的任何錯誤。
以下範例說明如何將 Autocomplete 小工具新增至活動：
/** * Initialize Places. For simplicity, the API key is hard-coded. In a production * environment we recommend using a secure mechanism to manage API keys. */ if (!Places.isInitialized()) { Places.initialize(getApplicationContext(), "YOUR_API_KEY"); } // Initialize the AutocompleteSupportFragment. AutocompleteSupportFragment autocompleteFragment = (AutocompleteSupportFragment) getSupportFragmentManager().findFragmentById(R.id.autocomplete_fragment); autocompleteFragment.setPlaceFields(Arrays.asList(Place.Field.ID, Place.Field.NAME)); autocompleteFragment.setOnPlaceSelectedListener(new PlaceSelectionListener() { @Override public void onPlaceSelected(Place place) { // TODO: Get info about the selected place. Log.i(TAG, "Place: " + place.getName() + ", " + place.getId()); } @Override public void onError(Status status) { // TODO: Handle the error. Log.i(TAG, "An error occurred: " + status); } });- 初始化
使用意圖啟動 Autocomplete 活動
- 初始化
Places，並傳遞應用程式結構定義和 API 金鑰 - 使用
Autocomplete.IntentBuilder建立意圖，並傳遞所需的PlaceAutocomplete模式 (全螢幕或重疊)。意圖必須呼叫startActivityForResult，並傳入可識別意圖的要求代碼。 - 覆寫
onActivityResult回呼以接收所選地點。
以下範例說明如何使用意圖啟動自動完成功能，然後處理結果：
/**
* Initialize Places. For simplicity, the API key is hard-coded. In a production
* environment we recommend using a secure mechanism to manage API keys.
*/
if (!Places.isInitialized()) {
Places.initialize(getApplicationContext(), "YOUR_API_KEY");
}
...
// Set the fields to specify which types of place data to return.
List<Place.Field> fields = Arrays.asList(Place.Field.ID, Place.Field.NAME);
// Start the autocomplete intent.
Intent intent = new Autocomplete.IntentBuilder(
AutocompleteActivityMode.FULLSCREEN, fields)
.build(this);
startActivityForResult(intent, AUTOCOMPLETE_REQUEST_CODE);
...
/**
* Override the activity's onActivityResult(), check the request code, and
* do something with the returned place data (in this example its place name and place ID).
*/
@Override
protected void onActivityResult(int requestCode, int resultCode, Intent data) {
if (requestCode == AUTOCOMPLETE_REQUEST_CODE) {
if (resultCode == RESULT_OK) {
Place place = Autocomplete.getPlaceFromIntent(data);
Log.i(TAG, "Place: " + place.getName() + ", " + place.getId());
} else if (resultCode == AutocompleteActivity.RESULT_ERROR) {
// TODO: Handle the error.
Status status = Autocomplete.getStatusFromIntent(data);
Log.i(TAG, status.getStatusMessage());
} else if (resultCode == RESULT_CANCELED) {
// The user canceled the operation.
}
}
}
地點挑選器已無法使用
「地點挑選程式」已於 2019 年 1 月 29 日淘汰。這項功能已於 2019 年 7 月 29 日停用，不再提供使用。如果繼續使用，則會收到錯誤訊息。新版 SDK 不支援 Place Picker。