このページは Cloud Translation API によって翻訳されました。

新しい Places SDK クライアントへの移行

このガイドでは、プレイス互換性ライブラリと Places SDK for Android の新しいスタンドアロンバージョンの変更点について説明します。このガイドでは、Places SDK for Android の新しいスタンドアロンバージョンに移行せずにプレイス互換性ライブラリを使用している場合に、Places SDK for Android の新しいバージョンを使用するようにプロジェクトを更新する方法について説明します。

バージョン 2.6.0 以降の Places SDK for Android の機能とバグ修正にアクセスするには、Places SDK for Android を使用する必要があります。できるだけ早く、互換性ライブラリから新しい Places SDK for Android バージョンに更新することをおすすめします。

変更内容

主な変更点は次のとおりです。

新しいバージョンの Places SDK for Android は、静的クライアントライブラリとして配布されています。2019 年 1 月までは、Places SDK for Android は Google Play 開発者サービスを通じて提供されていました。それ以降、新しい Places SDK for Android への移行を容易にするために、プレイス互換性ライブラリが提供されています。
まったく新しいメソッドがあります。
Place Details を返すメソッドでフィールドマスクがサポートされるようになりました。フィールドマスクを使用すると、返す場所データの種類を指定できます。
エラーの報告に使用するステータスコードが改善されました。
オートコンプリートがセッショントークンをサポートするようになりました。
Place Picker はご利用いただけなくなりました。

プレイス互換性ライブラリについて

2019 年 1 月に、スタンドアロンの Places SDK for Android のバージョン 1.0 のリリースに伴い、廃止された Places SDK for Android（com.google.android.gms:play-services-places）の Google Play 開発者サービスバージョンからの移行をサポートする互換性ライブラリを提供しました。

この互換性ライブラリは、デベロッパーがコードを移行してスタンドアロン SDK で新しい名前を使用できるようになるまで、Google Play 開発者サービスのバージョンを対象とする API 呼び出しを新しいスタンドアロンバージョンにリダイレクトして変換するために一時的に提供されたものです。バージョン 1.0 からバージョン 2.6.0 までリリースされた Places SDK for Android の各バージョンには、同等の機能を提供するプレイス互換性ライブラリの対応するバージョンがリリースされています。

プレイス互換性ライブラリの凍結とサポート終了

Places SDK for Android の互換性ライブラリの全バージョンは、2022 年 3 月 31 日をもって非推奨となりました。バージョン 2.6.0 は、Places 互換性ライブラリの最後のバージョンです。バージョン 2.6.0 以降の Places SDK for Android の機能とバグ修正にアクセスするには、Places SDK for Android を使用する必要があります。

バージョン 2.6.0 以降のリリースの新機能と重要なバグの修正を利用するには、Places SDK for Android に移行することをおすすめします。現在、互換性ライブラリを使用している場合は、以下の Places SDK for Android をインストールするの手順に沿って Places SDK for Android に移行してください。

クライアントライブラリをインストールする

新しいバージョンの Places SDK for Android は、静的クライアントライブラリとして配布されています。

Maven を使用して、Places SDK for Android を Android Studio プロジェクトに追加します。

現在プレイス互換性ライブラリを使用している場合:
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.3.0'
```
現在、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.3.0'
```
Gradle プロジェクトを同期します。
アプリケーションプロジェクトの minSdkVersion を 16 以上に設定します。

「Powered by 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 上限エラーのステータスコードが変更されました。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 の結果が 1 つ返されます。

// 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 をリクエストできるようになりました。別のリクエストを行う必要はありません。写真の幅と高さの上限は 1,600 ピクセル。fetchPhoto() は getPhoto() と同様に機能します。

場所の写真を取得する手順は次のとおりです。

fetchPlace() への呼び出しを設定します。リクエストに PHOTO_METADATAS フィールドを含めてください。
```
List<Place.Field> fields = Arrays.asList(Place.Field.PHOTO_METADATAS);
```
プレイスオブジェクトを取得します（この例では 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();
  }

重要:findCurrentPlace() は、Place.Field.ADDRESS_COMPONENTS、Place.Field.OPENING_HOURS、Place.Field.PHONE_NUMBER、Place.Field.WEBSITE_URI フィールドをサポートしていません。

オートコンプリート候補を検索する

ユーザーの検索クエリに対して場所の予測を返すには、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());
   }
});

セッショントークン

セッショントークンは、ユーザー検索のクエリフェーズと選択フェーズを、課金のために個別のセッションにグループ化します。すべてのオートコンプリートセッションでセッショントークンを使用することをおすすめします。セッションは、ユーザーがクエリの入力を開始すると開始され、場所を選択すると終了します。各セッションでは、複数のクエリの後に 1 つの場所を選択できます。セッションが終了すると、トークンは無効になります。アプリはセッションごとに新しいトークンを生成する必要があります。

フィールドマスク

Place Details を返すメソッドでは、各リクエストで返す場所データの種類を指定する必要があります。これにより、実際に使用するデータのみをリクエスト（および支払い）できます。

返すデータ型を指定するには、次の例に示すように Place.Field の配列を FetchPlaceRequest に渡します。

// Include address, ID, and phone number.
List<Place.Field> placeFields = Arrays.asList(Place.Field.ADDRESS,
                                              Place.Field.ID,
                                              Place.Field.PHONE_NUMBER);

次のフィールドを 1 つ以上使用できます。

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 の更新

このセクションでは、Places ウィジェット（Place Picker と Autocomplete）の変更点について説明します。

プログラムによるオートコンプリート

オートコンプリートに次の変更が加えられました。

PlaceAutocomplete の名前が Autocomplete に変更されました。
- PlaceAutocomplete.getPlace の名前が Autocomplete.getPlaceFromIntent に変更されました。
- PlaceAutocomplete.getStatus の名前が Autocomplete.getStatusFromIntent に変更されました。
PlaceAutocomplete.RESULT_ERROR の名前が AutocompleteActivity.RESULT_ERROR に変更されました（オートコンプリートフラグメントのエラー処理は変更されていません）。

Place Picker

Place Picker は 2019 年 1 月 29 日に非推奨となりました。2019 年 7 月 29 日に無効になり、ご利用いただけなくなりました。使用を続けるとエラーメッセージが表示されます。新しい SDK は Place Picker をサポートしていません。

オートコンプリートウィジェット

オートコンプリートウィジェットが更新されました。

Place 接頭辞はすべてのクラスから削除されました。
セッショントークンのサポートが追加されました。ウィジェットは、バックグラウンドでトークンを自動的に管理します。
ユーザーが選択した後に返す場所データの種類を選択できる、フィールドマスクのサポートを追加しました。

以下のセクションでは、プロジェクトにオートコンプリートウィジェットを追加する方法について説明します。

`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 を追加して、結果に対してなんらかの処理を行い、発生する可能性のあるすべてのエラーを処理します。

次の例は、アクティビティにオートコンプリートウィジェットを追加する方法を示しています。

/**
 * 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);
    }
});

インテントを使用してオートコンプリートアクティビティを起動する

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.
            }
        }
    }