遷移至新的 Places SDK 用戶端

本指南說明地點介面集程式庫程式庫與 Places SDK for Android 新的獨立版本之間的變更。如果您目前使用地點介面集相容性程式庫，而不是遷移至新版 Places SDK for Android，本指南會說明如何將專案更新為使用新版 Places SDK for Android。

接下來只能使用 Places SDK for Android 存取 Places SDK for Android 2.6.0 以上版本的功能和錯誤修正檔。Google 建議盡快從相容性程式庫更新至新的 Places SDK for Android 版本。

異動內容

主要變更項目如下：

• 新版 Places SDK for Android 以靜態用戶端程式庫的形式發布。2019 年 1 月之前，可透過 Google Play 服務使用 Places SDK for Android。其後，便提供地點介面集相容性程式庫，以便輕鬆轉換至新的 Places SDK for Android。
• 有全新的方法。
• 欄位遮罩現在支援傳回地點詳細資料的方法。您可以使用欄位遮罩指定要傳回的地點類型類型。
• 我們改善用來回報錯誤的狀態碼。
• 自動完成功能現已支援工作階段符記。
• 地點挑選器已無法使用。

關於地點介面集相容性程式庫

2019 年 1 月推出獨立的 Places SDK for Android 1.0 版後，Google 提供了相容性程式庫，可協助您從已停用的 Places SDK for Android (com.google.android.gms:play-services-places) 遷移。

我們暫時提供這個相容性程式庫，將針對 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 存取 Places SDK for Android 2.6.0 以上版本的功能和錯誤修正檔。

建議您改用 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 專案：

1. 如果你使用地點介面集相容性程式庫：

   1. 在 dependencies 區段中替換下列程式碼：

          implementation 'com.google.android.libraries.places:places-compat:X.Y.Z'

      進行上述操作後，即可改用 Places SDK for Android：

          implementation 'com.google.android.libraries.places:places:3.1.0'

2. 如果您目前使用 Places SDK for Android 的 Play 服務版本：

   1. 在 dependencies 區段中替換下列程式碼：

          implementation 'com.google.android.gms:play-services-places:X.Y.Z'

      進行上述操作後，即可改用 Places SDK for Android：

          implementation 'com.google.android.libraries.places:places:3.1.0'

3. 同步處理您的 Gradle 專案。

4. 將應用程式專案的 minSdkVersion 設為 16 以上版本。

5. 更新「由 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
   

6. 建構應用程式。如果您因為轉換為 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() 類似，

請按照下列步驟擷取地點：

1. 呼叫 fetchPlace() 並傳遞 FetchPlaceRequest 物件，指定 Place ID 和一個欄位，用於指定要傳回的地點資料。

   // 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();
   
   

2. 呼叫 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() 類似，

請按照下列步驟擷取地點相片：

1. 設定呼叫 fetchPlace()。請務必在要求中加入 PHOTO_METADATAS 欄位：

   List<Place.Field> fields = Arrays.asList(Place.Field.PHOTO_METADATAS);
   

2. 取得 Place 物件 (這個範例使用 fetchPlace()，但您也可以使用 findCurrentPlace())：

   FetchPlaceRequest placeRequest = FetchPlaceRequest.builder(placeId, fields).build();
   

3. 新增 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() 類似，

請按照下列步驟取得使用者裝置目前的位置資訊：

1. 請確認您的應用程式要求 ACCESS_FINE_LOCATION 和 ACCESS_WIFI_STATE 權限。使用者必須授予權限，才能存取目前的裝置位置資訊。詳情請參閱「要求應用程式權限」。

2. 建立 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();
   

3. 呼叫 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());
   }
});

工作階段符記

工作階段符記會將使用者搜尋的查詢和選取階段歸入不同的工作階段，以用於計費。建議您在所有自動完成工作階段使用工作階段符記。工作階段是從使用者輸入查詢時開始，到使用者選取地點時結束。在每個工作階段中，使用者可以輸入多筆查詢，最終選擇一個地點。工作階段結束後，符記就會失效；應用程式必須為每個工作階段產生新的符記。

欄位遮罩

在傳回地點詳細資料的方法中，您必須指定要與每個要求一併傳回的地點資料類型。這麼做可確保您只要求實際使用 (及付費) 的資料。

如要指定要傳回的資料類型，請在 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.ADDRESS
• Place.Field.ID
• Place.Field.LAT_LNG
• Place.Field.NAME
• Place.Field.OPENING_HOURS
• Place.Field.PHONE_NUMBER
• Place.Field.PHOTO_METADATAS
• Place.Field.PLUS_CODE
• Place.Field.PRICE_LEVEL
• Place.Field.RATING
• Place.Field.TYPES
• Place.Field.USER_RATINGS_TOTAL
• Place.Field.VIEWPORT
• Place.Field.WEBSITE_URI

進一步瞭解 Places Data 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 前置字串。
• 新增工作階段符記支援功能。小工具會在背景自動管理權杖。
• 新增欄位遮罩支援功能，讓您讓使用者在做出選擇後選擇傳回的地點資料類型。

以下各節說明如何在專案中新增自動完成小工具。

嵌入AutocompleteFragment

如要新增自動完成片段，請按照下列步驟操作：

1. 在活動的 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"
     />
   

2. 如要在活動中新增自動完成小工具，請按照下列步驟操作：

   • 初始化 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);
       }
   });
   

使用意圖啟動自動完成活動

1. 初始化 Places，傳遞應用程式結構定義和 API 金鑰
2. 使用 Autocomplete.IntentBuilder 建立意圖，並傳遞所需的 PlaceAutocomplete 模式 (全螢幕或重疊)。意圖必須呼叫 startActivityForResult，並傳入可識別意圖的要求代碼。
3. 覆寫 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 不支援「地點挑選器」。