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

ブロックストア

新しい Android デバイスを設定する際に、多くのユーザーは依然として自分の認証情報を管理しています。この手動プロセスは困難になることが多く、ユーザーエクスペリエンスの低下につながることがよくあります。Google Play 開発者サービスによるライブラリである Block Store API は、ユーザーパスワードの保存に伴う複雑さやセキュリティリスクを回避しながら、アプリがユーザーの認証情報を保存する方法を提供することで、この問題を解決しようとしています。

Block Store API を使用すると、アプリはデータを保存し、後でそのデータを取得して新しいデバイスでユーザーを再認証できます。これにより、ユーザーが新しいデバイスで初めてアプリを起動したときに、ログイン画面が表示されなくなるため、よりシームレスなエクスペリエンスを提供できます。

Block Store を使用するメリットは次のとおりです。

デベロッパー向けの暗号化された認証情報ストレージソリューション。認証情報は、可能な限りエンドツーエンドで暗号化されます。
ユーザー名とパスワードではなくトークンを保存します。
ログインフローの摩擦を解消します。
複雑なパスワードの管理という負担からユーザーを解放します。
Google がユーザーの身元を確認します。

始める前に

アプリを準備するには、以下のセクションに示す手順を完了します。

アプリを構成する

プロジェクトレベルの build.gradle ファイルで、buildscript セクションと allprojects セクションの両方に Google の Maven リポジトリを含めます。

buildscript {
  repositories {
    google()
    mavenCentral()
  }
}

allprojects {
  repositories {
    google()
    mavenCentral()
  }
}

Block Store API の Google Play 開発者サービスの依存関係をモジュールの Gradle ビルドファイル（通常は app/build.gradle）に追加します。

dependencies {
  implementation 'com.google.android.gms:play-services-auth-blockstore:16.4.0'
}

仕組み

Block Store を使用すると、デベロッパーは最大 16 個のバイト配列を保存して復元できます。これにより、現在のユーザーセッションに関する重要な情報を保存し、この情報を自由に保存できます。このデータはエンドツーエンドで暗号化でき、Block Store をサポートするインフラストラクチャはバックアップと復元のインフラストラクチャ上に構築されます。

このガイドでは、ユーザーのトークンを Block Store に保存するユースケースについて説明します。Block Store を利用するアプリの仕組みは次のとおりです。

アプリの認証フロー中、またはその後いつでも、ユーザーの認証トークンを Block Store に保存して、後で取得できます。
トークンはローカルに保存され、可能な場合はエンドツーエンドで暗号化されてクラウドにバックアップすることもできます。
データは、ユーザーが新しいデバイスで復元フローを開始したときに転送されます。
ユーザーが復元フローでアプリを復元すると、アプリは新しいデバイスの Block Store から保存されたトークンを取得できます。

トークンを保存する

ユーザーがアプリにログインしたときに、そのユーザー用に生成した認証トークンを Block Store に保存できます。このトークンは、エントリあたり最大 4 KB の一意のキーペア値を使用して保存できます。トークンを保存するには、StoreBytesData.Builder のインスタンスで setBytes() と setKey() を呼び出して、ユーザーの認証情報を移行元デバイスに保存します。Block Store でトークンを保存すると、トークンは暗号化され、デバイスにローカルに保存されます。

次のサンプルは、認証トークンをローカルデバイスに保存する方法を示しています。

Java

  BlockstoreClient client = Blockstore.getClient(this);
  byte[] bytes1 = new byte[] { 1, 2, 3, 4 };  // Store one data block.
  String key1 = "com.example.app.key1";
  StoreBytesData storeRequest1 = StoreBytesData.Builder()
          .setBytes(bytes1)
          // Call this method to set the key value pair the data should be associated with.
          .setKeys(Arrays.asList(key1))
          .build();
  client.storeBytes(storeRequest1)
    .addOnSuccessListener(result -> Log.d(TAG, "stored " + result + " bytes"))
    .addOnFailureListener(e -> Log.e(TAG, "Failed to store bytes", e));

Kotlin

  val client = Blockstore.getClient(this)

  val bytes1 = byteArrayOf(1, 2, 3, 4) // Store one data block.
  val key1 = "com.example.app.key1"
  val storeRequest1 = StoreBytesData.Builder()
    .setBytes(bytes1) // Call this method to set the key value with which the data should be associated with.
    .setKeys(Arrays.asList(key1))
    .build()
  client.storeBytes(storeRequest1)
    .addOnSuccessListener { result: Int ->
      Log.d(TAG,
            "Stored $result bytes")
    }
    .addOnFailureListener { e ->
      Log.e(TAG, "Failed to store bytes", e)
    }

デフォルトトークンを使用する

キーなしで StoreBytes を使用して保存されたデータは、デフォルトのキー BlockstoreClient.DEFAULT_BYTES_DATA_KEY を使用します。

Java

  BlockstoreClient client = Blockstore.getClient(this);
  // The default key BlockstoreClient.DEFAULT_BYTES_DATA_KEY.
  byte[] bytes = new byte[] { 9, 10 };
  StoreBytesData storeRequest = StoreBytesData.Builder()
          .setBytes(bytes)
          .build();
  client.storeBytes(storeRequest)
    .addOnSuccessListener(result -> Log.d(TAG, "stored " + result + " bytes"))
    .addOnFailureListener(e -> Log.e(TAG, "Failed to store bytes", e));

Kotlin

  val client = Blockstore.getClient(this);
  // the default key BlockstoreClient.DEFAULT_BYTES_DATA_KEY.
  val bytes = byteArrayOf(1, 2, 3, 4)
  val storeRequest = StoreBytesData.Builder()
    .setBytes(bytes)
    .build();
  client.storeBytes(storeRequest)
    .addOnSuccessListener { result: Int ->
      Log.d(TAG,
            "stored $result bytes")
    }
    .addOnFailureListener { e ->
      Log.e(TAG, "Failed to store bytes", e)
    }

トークンを取得する

その後、ユーザーが新しいデバイスで復元フローを実行すると、Google Play 開発者サービスがまずユーザーを検証し、次に Block Store データを取得します。ユーザーは復元フローの一環としてアプリデータの復元にすでに同意しているため、追加の同意は必要ありません。ユーザーがアプリを開いたときに、retrieveBytes() を呼び出して Block Store からトークンをリクエストできます。取得したトークンを使用して、新しいデバイスでユーザーのログイン状態を維持できます。

次のサンプルは、特定のキーに基づいて複数のトークンを取得する方法を示しています。

Java

BlockstoreClient client = Blockstore.getClient(this);

// Retrieve data associated with certain keys.
String key1 = "com.example.app.key1";
String key2 = "com.example.app.key2";
String key3 = BlockstoreClient.DEFAULT_BYTES_DATA_KEY; // Used to retrieve data stored without a key

List requestedKeys = Arrays.asList(key1, key2, key3); // Add keys to array
RetrieveBytesRequest retrieveRequest = new RetrieveBytesRequest.Builder()
    .setKeys(requestedKeys)
    .build();

client.retrieveBytes(retrieveRequest)
    .addOnSuccessListener(
        result -> {
          Map<String, BlockstoreData> blockstoreDataMap = result.getBlockstoreDataMap();
          for (Map.Entry<String, BlockstoreData> entry : blockstoreDataMap.entrySet()) {
            Log.d(TAG, String.format(
                "Retrieved bytes %s associated with key %s.",
                new String(entry.getValue().getBytes()), entry.getKey()));
          }
        })
    .addOnFailureListener(e -> Log.e(TAG, "Failed to store bytes", e));

Kotlin

val client = Blockstore.getClient(this)

// Retrieve data associated with certain keys.
val key1 = "com.example.app.key1"
val key2 = "com.example.app.key2"
val key3 = BlockstoreClient.DEFAULT_BYTES_DATA_KEY // Used to retrieve data stored without a key

val requestedKeys = Arrays.asList(key1, key2, key3) // Add keys to array

val retrieveRequest = RetrieveBytesRequest.Builder()
  .setKeys(requestedKeys)
  .build()

client.retrieveBytes(retrieveRequest)
  .addOnSuccessListener { result: RetrieveBytesResponse ->
    val blockstoreDataMap =
      result.blockstoreDataMap
    for ((key, value) in blockstoreDataMap) {
      Log.d(ContentValues.TAG, String.format(
        "Retrieved bytes %s associated with key %s.",
        String(value.bytes), key))
    }
  }
  .addOnFailureListener { e: Exception? ->
    Log.e(ContentValues.TAG,
          "Failed to store bytes",
          e)
  }

すべてのトークンを取得します。

以下は、BlockStore に保存されているすべてのトークンを取得する方法の例です。

Java

BlockstoreClient client = Blockstore.getClient(this)

// Retrieve all data.
RetrieveBytesRequest retrieveRequest = new RetrieveBytesRequest.Builder()
    .setRetrieveAll(true)
    .build();

client.retrieveBytes(retrieveRequest)
    .addOnSuccessListener(
        result -> {
          Map<String, BlockstoreData> blockstoreDataMap = result.getBlockstoreDataMap();
          for (Map.Entry<String, BlockstoreData> entry : blockstoreDataMap.entrySet()) {
            Log.d(TAG, String.format(
                "Retrieved bytes %s associated with key %s.",
                new String(entry.getValue().getBytes()), entry.getKey()));
          }
        })
    .addOnFailureListener(e -> Log.e(TAG, "Failed to store bytes", e));

Kotlin

val client = Blockstore.getClient(this)

val retrieveRequest = RetrieveBytesRequest.Builder()
  .setRetrieveAll(true)
  .build()

client.retrieveBytes(retrieveRequest)
  .addOnSuccessListener { result: RetrieveBytesResponse ->
    val blockstoreDataMap =
      result.blockstoreDataMap
    for ((key, value) in blockstoreDataMap) {
      Log.d(ContentValues.TAG, String.format(
        "Retrieved bytes %s associated with key %s.",
        String(value.bytes), key))
    }
  }
  .addOnFailureListener { e: Exception? ->
    Log.e(ContentValues.TAG,
          "Failed to store bytes",
          e)
  }

デフォルトの鍵を取得する方法の例を次に示します。

Java

BlockStoreClient client = Blockstore.getClient(this);
RetrieveBytesRequest retrieveRequest = new RetrieveBytesRequest.Builder()
    .setKeys(Arrays.asList(BlockstoreClient.DEFAULT_BYTES_DATA_KEY))
    .build();
client.retrieveBytes(retrieveRequest);

Kotlin

val client = Blockstore.getClient(this)

val retrieveRequest = RetrieveBytesRequest.Builder()
  .setKeys(Arrays.asList(BlockstoreClient.DEFAULT_BYTES_DATA_KEY))
  .build()
client.retrieveBytes(retrieveRequest)

トークンの削除

BlockStore からトークンを削除する必要があるのは、次のような理由が考えられます。

ユーザーがログアウトユーザーフローを完了します。
トークンが取り消されたか、無効です。

トークンの取得と同様に、削除が必要なキーの配列を設定することで、削除が必要なトークンを指定できます。

次の例は、特定の鍵を削除する方法を示しています。

Java

BlockstoreClient client = Blockstore.getClient(this);

// Delete data associated with certain keys.
String key1 = "com.example.app.key1";
String key2 = "com.example.app.key2";
String key3 = BlockstoreClient.DEFAULT_BYTES_DATA_KEY; // Used to delete data stored without key

List requestedKeys = Arrays.asList(key1, key2, key3) // Add keys to array
DeleteBytesRequest deleteRequest = new DeleteBytesRequest.Builder()
      .setKeys(requestedKeys)
      .build();
client.deleteBytes(deleteRequest)

Kotlin

val client = Blockstore.getClient(this)

// Retrieve data associated with certain keys.
val key1 = "com.example.app.key1"
val key2 = "com.example.app.key2"
val key3 = BlockstoreClient.DEFAULT_BYTES_DATA_KEY // Used to retrieve data stored without a key

val requestedKeys = Arrays.asList(key1, key2, key3) // Add keys to array

val retrieveRequest = DeleteBytesRequest.Builder()
      .setKeys(requestedKeys)
      .build()

client.deleteBytes(retrieveRequest)

すべてのトークンを削除

次の例は、BlockStore に現在保存されているすべてのトークンを削除する方法を示しています。

Java

// Delete all data.
DeleteBytesRequest deleteAllRequest = new DeleteBytesRequest.Builder()
      .setDeleteAll(true)
      .build();
client.deleteBytes(deleteAllRequest)
.addOnSuccessListener(result -> Log.d(TAG, "Any data found and deleted? " + result));

Kotlin

  val deleteAllRequest = DeleteBytesRequest.Builder()
  .setDeleteAll(true)
  .build()
retrieve bytes, the key BlockstoreClient.DEFAULT_BYTES_DATA_KEY can be used
in the RetrieveBytesRequest instance in order to get your saved data

The following example shows how to retrieve the default key.

Java

End-to-end encryption

In order for end-to-end encryption to be made available, the device must be running Android 9 or higher, and the user must have set a screen lock (PIN, pattern, or password) for their device. You can verify if encryption will be available on the device by calling isEndToEndEncryptionAvailable().

The following sample shows how to verify if encryption will be available during cloud backup:

client.isEndToEndEncryptionAvailable()
        .addOnSuccessListener { result ->
          Log.d(TAG, "Will Block Store cloud backup be end-to-end encrypted? $result")
        }

クラウドバックアップを有効にする

クラウドバックアップを有効にするには、StoreBytesData オブジェクトに setShouldBackupToCloud() メソッドを追加します。setShouldBackupToCloud() が true に設定されている場合、Block Store は定期的にクラウドにバックアップします。

次のサンプルは、クラウドバックアップがエンドツーエンドで暗号化されている場合にのみクラウドバックアップを有効にする方法を示しています。

val client = Blockstore.getClient(this)
val storeBytesDataBuilder = StoreBytesData.Builder()
        .setBytes(/* BYTE_ARRAY */)

client.isEndToEndEncryptionAvailable()
        .addOnSuccessListener { isE2EEAvailable ->
          if (isE2EEAvailable) {
            storeBytesDataBuilder.setShouldBackupToCloud(true)
            Log.d(TAG, "E2EE is available, enable backing up bytes to the cloud.")

            client.storeBytes(storeBytesDataBuilder.build())
                .addOnSuccessListener { result ->
                  Log.d(TAG, "stored: ${result.getBytesStored()}")
                }.addOnFailureListener { e ->
                  Log.e(TAG, “Failed to store bytes”, e)
                }
          } else {
            Log.d(TAG, "E2EE is not available, only store bytes for D2D restore.")
          }
        }

テスト方法

復元フローをテストするには、開発中に次の方法を使用します。

同じデバイスでのアンインストールと再インストール

ユーザーがバックアップサービスを有効にしている場合（[設定] > [Google] > [バックアップ] で確認できます）、Block Store のデータはアプリのアンインストール/再インストール後も保持されます。

テストの手順は次のとおりです。

Block Store API をテストアプリに統合します。
テストアプリを使用して Block Store API を呼び出し、データを保存します。
テストアプリをアンインストールしてから、同じデバイスにアプリを再インストールします。
テストアプリを使用して Block Store API を呼び出し、データを取得します。
取得したバイトが、アンインストール前に保存されたバイトと同じであることを確認します。

デバイス間

ほとんどの場合、対象のデバイスを出荷時の設定にリセットする必要があります。その後、Android ワイヤレス復元フローまたは Google ケーブル復元（対応デバイスの場合）を開始できます。

クラウドによる復元

Block Store API をテストアプリに統合します。テストアプリは Play ストアに送信する必要があります。
ソースデバイスで、テストアプリを使用して Block Store API を呼び出し、データを保存します。このとき、shouldBackUpToCloud は true に設定します。
O 以上のデバイスでは、Block Store クラウドバックアップを手動でトリガーできます。[設定] > [Google] > [バックアップ] に移動し、[今すぐバックアップ] ボタンをクリックします。
1. Block Store クラウドバックアップが成功したことを確認するには、次の操作を行います。
  1. バックアップが完了したら、「CloudSyncBpTkSvc」タグのログ行を検索します。
  2. 「......, CloudSyncBpTkSvc: sync result: SUCCESS, ..., uploaded size: XXX bytes ...」のような行が表示されます。
2. Block Store クラウドバックアップの後には、5 分間の「クールダウン」期間があります。この 5 分以内に [今すぐバックアップ] ボタンをクリックしても、別の Block Store クラウドバックアップはトリガーされません。
対象のデバイスを出荷時の設定にリセットし、クラウド復元フローを実行します。復元フロー中にテストアプリを復元する場合は、選択します。クラウド復元フローの詳細については、サポートされているクラウド復元フローをご覧ください。
ターゲットデバイスで、テストアプリを使用して Block ストア API を呼び出し、データを取得します。
取得したバイト数がソースデバイスに保存されたバイト数と同じであることを確認します。

端末の要件

エンドツーエンドの暗号化

エンドツーエンドの暗号化は、Android 9（API 29）以上を搭載しているデバイスでサポートされています。
エンドツーエンドの暗号化を有効にしてユーザーのデータを正しく暗号化するには、デバイスに PIN、パターン、パスワードのいずれかによる画面ロックが設定されている必要があります。

デバイスからデバイスへの復元フロー

デバイス間の復元には、ソースデバイスとターゲットデバイスが必要です。これらは、データを転送する 2 つのデバイスになります。

ソースデバイスは、バックアップを行うために Android 6（API 23）以上を実行している必要があります。

Android 9（API 29）以上を搭載した対象デバイスで復元できるようにします。

デバイス間の復元フローについて詳しくは、こちらをご覧ください。

クラウドのバックアップと復元のフロー

クラウドバックアップと復元には、ソースデバイスとターゲットデバイスが必要です。

ソースデバイスは、バックアップを行うために Android 6（API 23）以上を実行している必要があります。

ターゲット デバイスは、ベンダーに基づいてサポートされます。Google Pixel では Android 9（API 29）からこの機能を使用できます。その他のすべてのデバイスでは Android 12（API 31）以上を搭載している必要があります。

ブロック ストア

始める前に

アプリを構成する

仕組み

トークンを保存する

Java

Kotlin

デフォルト トークンを使用する

Java

Kotlin

トークンを取得する

Java

Kotlin

すべてのトークンを取得します。

Java

Kotlin

Java

Kotlin

トークンの削除

Java

Kotlin

すべてのトークンを削除

Java

Kotlin

Java

End-to-end encryption

クラウド バックアップを有効にする

テスト方法

同じデバイスでのアンインストールと再インストール

デバイス間

クラウドによる復元

端末の要件

エンドツーエンドの暗号化

デバイスからデバイスへの復元フロー

クラウドのバックアップと復元のフロー

ブロックストア

デフォルトトークンを使用する

クラウドバックアップを有効にする