「アプリの自動バックアップ」を使用すると、Android 6.0（API レベル 23）以降をターゲットとして実行するアプリから、ユーザーのデータを自動的にバックアップできます。Android はアプリを保持 ユーザーの Google ドライブにアップロードします。Google ドライブでは、 ユーザーの Google アカウントの認証情報です。Android 9 以降を搭載したデバイスでのバックアップは、デバイスの PIN、パターン、またはパスワードを使用してエンドツーエンドで暗号化されます。すべてのアプリは、アプリのユーザーごとに最大 25 MB のバックアップ データを割り当てることができます。 バックアップ データは無料で保存できます。アプリは、 バックアップを無効にすることもできます。
Android のバックアップ オプションの概要とバックアップ対象のデータに関するガイダンスについては、 バックアップと復元について詳しくは、データのバックアップの概要をご覧ください。
バックアップ対象のファイル
デフォルトでは、自動バックアップの対象には、システムによってアプリに割り当てられているほとんどのディレクトリ内のファイルが含まれています。
共有の環境設定ファイル
アプリの内部ストレージに保存され、アクセスされるファイル
getFilesDir()またはgetDir(String, int)getDatabasePath(String)から返されるディレクトリ内のファイル（SQLiteOpenHelperクラスで作成されたファイルも含まれます外部ストレージ上の、
getExternalFilesDir(String)から返されるディレクトリ内のファイル
自動バックアップでは、getCacheDir()、getCodeCacheDir()、getNoBackupFilesDir() から返されるディレクトリ内のファイルは除外されます。保存されたファイルは
これらのロケーションは一時的に必要であり、
バックアップオペレーションを実行できます
アプリを設定して、特定のファイルを追加、除外できます。詳細情報 詳しくは、ファイルを追加または除外するをご覧ください。
バックアップの場所
バックアップ データは、ユーザーの Google ドライブ アカウントのプライベート フォルダに保存されます。容量はアプリ 1 つあたり 25 MB に制限されています。保存されたデータは、ユーザー個人の Google ドライブの容量にカウントされません。保存されるのは最新のバックアップのみです。バックアップが作成されると、以前のバックアップはすべて削除されます。次のデバイスでバックアップ データを読み取ることができません デバイス上の他のアプリでも 管理できます
ユーザーは、Google ドライブにバックアップされたアプリのリストを確認できます Android アプリAndroid 搭載デバイスでは、このリストがドライブに表示されます。 アプリのナビゲーション ドロワー（[Settings] >バックアップとリセットをご覧ください。
以下の例に示すように、バックアップは、デバイス、設定、有効期間ごとに別々のデータセットに保存されます。
ユーザーが 2 台のデバイスを所有している場合は、各デバイス用のバックアップ データセットが存在します。
ユーザーがデバイスを出荷時設定にリセットし、同じアカウントでデバイスを設定すると、バックアップは新しいデータセットに保存されます。古いデータセットは、アクセスされない状態が一定期間続くと自動的に削除されます。
バックアップ スケジュール
以下の条件をすべて満たしている場合、バックアップが自動的に行われます。
- ユーザーによってデバイスでバックアップが有効化されている。Android 9 では、この設定は [設定] > [システム] > [バックアップ] にあります。
- 前回のバックアップから少なくとも 24 時間経過している。
- デバイスがアイドル状態である。
- デバイスが Wi-Fi ネットワークに接続されている（デバイスのユーザーがモバイルデータのバックアップを有効にしていない場合）。
実際には、これらの条件はほぼ毎晩満たされますが、デバイスでバックアップが行われない可能性もあります（デバイスがネットワークにまったく接続されない場合など）。また、ネットワーク帯域幅を節約するために、アップロードはアプリデータが変更された場合にのみ行われます。
自動バックアップ中はアプリが自動でシャットダウンされ、
自動的に作成されます。デフォルトでは、バックアップ システムは
ユーザーエクスペリエンスの低下を回避しますデフォルトの
デフォルトの動作（android:backupInForeground 属性を
あります。
テストを簡単にするため、Android には、手動でテストを開始できるツールが アプリのバックアップを作成します詳細については、バックアップと復元のテストをご覧ください。
復元スケジュール
データの復元は、アプリのインストール時に毎回行われます。アプリのインストールは Play ストアから行うか、デバイスのセットアップ時に行うか（以前にインストールしたアプリをシステムがインストールする場合）、または adb install の実行により行います。復元処理は APK のインストール後に行われます。
ユーザーがアプリを起動できるようになる前に
最初のデバイス設定ウィザードで、利用可能なバックアップ データセットのリストがユーザーに表示され、どのデータセットからデータを復元するかを尋ねられます。選択したバックアップ データセットがデバイスの祖先データセットになります。デバイスは 自身のバックアップまたは祖先データセットから復元できます。バックアップから 両方のソースが使用可能な場合、デバイスは自身のバックアップを優先します。ユーザーが デバイス設定ウィザードを実行しなかった場合、デバイスは 独自のバックアップを作成します
簡単に復元をテストできるように、Android にはアプリの復元を手動で開始するためのツールが用意されています。詳しくは、バックアップと復元のテストをご覧ください。
バックアップを有効または無効にする
Android 6.0（API レベル 23）以上をターゲットとするアプリでは、自動的に自動バックアップが有効になります。バックアップを有効または無効にするには、アプリのマニフェスト ファイルでブール値 android:allowBackup を設定します。デフォルト値は true ですが、次の例に示すように、マニフェストで属性を明示的に設定することをおすすめします。
<manifest ... >
...
<application android:allowBackup="true" ... >
...
</application>
</manifest>
バックアップを無効にするには、android:allowBackup を false に設定します。アプリがその状態を他のなんらかのメカニズムによって再現できる場合や、機密情報をアプリで扱っている場合は、このように設定することをおすすめします。
ファイルを追加または除外する
デフォルトでは、ほぼすべてのアプリデータがシステムによってバックアップされます。詳しくは、バックアップ対象のファイルのセクションをご覧ください。
このセクションでは、バックアップ対象のファイルを制御するカスタム XML ルールの定義方法について説明します。Android 12（API レベル 31）以降をターゲットとするアプリの場合は、 XML バックアップ ルールの追加セットを追加できます（このセクションで説明）。 デバイスに導入されたバックアップの復元に関する変更をサポート ダウンロードします
Android 11 以下でバックアップを管理する
Android 11（API レベル 30）以下を搭載したデバイスでバックアップ対象のファイルを制御するには、このセクションの手順を行います。
次の例に示すように、
AndroidManifest.xmlファイルで、android:fullBackupContent属性を<application>要素に追加します。この属性で、バックアップ ルールを格納する XML ファイルを指定します。<application ... android:fullBackupContent="@xml/backup_rules"> </application>
@xml/backup_rulesという XML ファイルをres/xml/ディレクトリ内に作成します。このファイルで、<include>要素と<exclude>要素を使用したルールを追加します。次のサンプルでは、device.xmlを除くすべての共有の環境設定がバックアップされます。<?xml version="1.0" encoding="utf-8"?> <full-backup-content> <include domain="sharedpref" path="."/> <exclude domain="sharedpref" path="device.xml"/> </full-backup-content>
バックアップに必要なデバイスの条件を定義する
アプリが機密情報をデバイスに保存する場合は、アプリのデータがユーザーのバックアップに含まれる条件を指定できます。Android 9（API レベル 28）以降では、以下の条件を追加できます。
clientSideEncryption: ユーザーのバックアップがクライアント側のシークレットで暗号化される。この形式の暗号化は、Android 9 以降を搭載したデバイスで有効になっています ユーザーが Android 9 以降でバックアップを有効にしていれば、バックアップの上限は に画面ロックを設定している（PIN、パターン、またはパスワード） できます。deviceToDeviceTransfer: ユーザーがバックアップを別のものに移行しています デバイス間のローカル転送をサポートするデバイス（ Google Pixel）。
開発デバイスを Android 9 にアップグレードした場合、アップグレード後にデータのバックアップを無効にしてから再度有効にする必要があります。なぜならば、Android がクライアント側のシークレットを使用してバックアップを暗号化するには、事前に [設定] または設定ウィザードでユーザーに通知する必要があるからです。
バックアップ対象の条件を宣言するには、一連のバックアップ ルール内の <include> 要素で requireFlags 属性を選択した値に設定します。
backup_rules.xml
<?xml version="1.0" encoding="utf-8"?> <full-backup-content> <!-- App data isn't included in user's backup unless client-side encryption is enabled. --> <include domain="file" path="." requireFlags="clientSideEncryption" /> </full-backup-content>
アプリに Key-Value バックアップ システムを実装している場合、または
BackupAgent、これらの条件付き要件を適用することもできます
バックアップ ロジックに取り込まれるため、
BackupDataOutput オブジェクトのトランスポート フラグのセットとカスタム バックアップ
エージェントの FLAG_CLIENT_SIDE_ENCRYPTION_ENABLED または
FLAG_DEVICE_TO_DEVICE_TRANSFER フラグを使用できます。
次のコード スニペットは、この方法の使用例を示しています。
Kotlin
class CustomBackupAgent : BackupAgent() { override fun onBackup(oldState: ParcelFileDescriptor?, data: BackupDataOutput?, newState: ParcelFileDescriptor?) { if (data != null) { if ((data.transportFlags and FLAG_CLIENT_SIDE_ENCRYPTION_ENABLED) != 0) { // Client-side backup encryption is enabled. } if ((data.transportFlags and FLAG_DEVICE_TO_DEVICE_TRANSFER) != 0) { // Local device-to-device transfer is enabled. } } } // Implementation of onRestore() here. }
Java
public class CustomBackupAgent extends BackupAgent { @Override public void onBackup(ParcelFileDescriptor oldState, BackupDataOutput data, ParcelFileDescriptor newState) throws IOException { if ((data.getTransportFlags() & FLAG_CLIENT_SIDE_ENCRYPTION_ENABLED) != 0) { // Client-side backup encryption is enabled. } if ((data.getTransportFlags() & FLAG_DEVICE_TO_DEVICE_TRANSFER) != 0) { // Local device-to-device transfer is enabled. } } // Implementation of onRestore() here. }
Android 12 以上でバックアップを管理する
Android 12（API レベル 31）以降をターゲットとするアプリの場合は、 このセクションでは、実行中のデバイスでバックアップするファイルを管理します Android 12 以降。
AndroidManifest.xmlファイルに次の行を追加します。<application>に対するandroid:dataExtractionRules属性 要素を追加します。この属性で、バックアップ ルールを格納する XML ファイルを指定します。<application ... android:dataExtractionRules="backup_rules.xml"> </application>
backup_rules.xmlという XML ファイルをres/xml/ディレクトリ内に作成します。このファイルで、<include>要素と<exclude>要素を使用したルールを追加します。次のサンプルでは、device.xmlを除くすべての共有の環境設定がバックアップされます。<?xml version="1.0" encoding="utf-8"?> <data-extraction-rules> <cloud-backup [disableIfNoEncryptionCapabilities="true|false"]> <include domain="sharedpref" path="."/> <exclude domain="sharedpref" path="device.xml"/> </cloud-backup> </data-extraction-rules>
構成ファイルの XML 構文
構成ファイルの XML 構文は、アプリがターゲットとし実行される Android のバージョンによって異なります。
Android 11 以下
Android 11 以下を搭載したデバイスのバックアップを制御する構成ファイルには、次の XML 構文を使用します。
<full-backup-content> <include domain=["file" | "database" | "sharedpref" | "external" | "root" | "device_file" | "device_database" | "device_sharedpref" | "device_root" ] path="string" requireFlags=["clientSideEncryption" | "deviceToDeviceTransfer"] /> <exclude domain=["file" | "database" | "sharedpref" | "external" | "root" | "device_file" | "device_database" | "device_sharedpref" | "device_root" ] path="string" /> </full-backup-content>
Android 12 以上
アプリが Android 12（API レベル 31）以上をターゲットにしている場合、Android 12 以上を搭載したデバイスのバックアップを制御する構成ファイルには次の XML 構文を使用します。
<data-extraction-rules> <cloud-backup [disableIfNoEncryptionCapabilities="true|false"]> ... <include domain=["file" | "database" | "sharedpref" | "external" | "root" | "device_file" | "device_database" | "device_sharedpref" | "device_root" ] path="string"/> ... <exclude domain=["file" | "database" | "sharedpref" | "external" | "root" | "device_file" | "device_database" | "device_sharedpref" | "device_root" ] path="string"/> ... </cloud-backup> <device-transfer> ... <include domain=["file" | "database" | "sharedpref" | "external" | "root" | "device_file" | "device_database" | "device_sharedpref" | "device_root" ] path="string"/> ... <exclude domain=["file" | "database" | "sharedpref" | "external" | "root" | "device_file" | "device_database" | "device_sharedpref" | "device_root" ] path="string"/> ... </device-transfer> </data-extraction-rules>
構成の各セクション（<cloud-backup>、<device-transfer>）には、そのタイプの転送にしか適用されないルールが含まれます。この分離により
たとえば、特定のファイルまたはディレクトリを Google ドライブのバックアップから除外し、
デバイス間（D2D）転送中も転送できます。これは、次の場合に有用です。
クラウドにバックアップするには大きすぎるが転送はできるファイルがある
デバイス間でも問題なく機能します。
<device-transfer> セクションがないなど、特定のバックアップ モードに関するルールがない場合、バックアップ対象のファイル セクションに記載されているように、no-backup ディレクトリと cache ディレクトリを除くすべてのコンテンツに対して、そのモードが完全に有効になります。
アプリでは、<cloud-backup> セクションに disableIfNoEncryptionCapabilities フラグを設定することで、ユーザーがロック画面を表示した場合など、暗号化可能な場合にのみバックアップが行われるようにできます。この制約を設定すると、
ユーザーのデバイスがサポートできない場合に、バックアップがクラウドに送信されなくなります。
暗号化されますが、D2D 転送はサーバーに送信されないため、
暗号化に対応していないデバイスでも動作させることができます。
要素の追加と除外の構文
<full-backup-content> タグ、<cloud-backup> タグ、<device-transfer> タグ（デバイスの Android バージョンとアプリの targetSDKVersion によって異なります）内で、<include> 要素と <exclude> 要素を次のように定義します。
<include>バックアップするファイルまたはフォルダを指定します。デフォルトでは、ほぼすべてのアプリファイルが自動バックアップの対象に含まれています。
<include>要素を指定した場合、 デフォルトでファイルが含まれなくなり、ファイルのみが あります。複数のファイルを含めるには、複数の<include>要素を使用します。Android 11 以前では、この要素に
requireFlags属性を定義します。このセクションでは、 バックアップの条件付き要件で詳しく説明しています。getCacheDir()、getCodeCacheDir()、または 「getNoBackupFilesDir()」は追加しようとしても常に除外されます。<exclude>バックアップ時に除外するファイルまたはフォルダを指定します。以下に例を示します。 次のようなファイルがバックアップから除外されます。
デバイス固有の ID（サーバーにより発行された ID またはデバイスで生成された ID）が指定されているファイル。たとえば、Firebase Cloud Messaging は （FCM）では、ユーザーが登録を行うたびに登録トークンを生成する必要があります。 新しいデバイスにアプリをインストールする。古い登録トークンが復元されると、アプリが予想外の動作をすることがあります。
アプリのデバッグに関連するファイル。
アプリの 25 MB のバックアップ容量を超えるサイズの大きいファイル。
<include> 要素と <exclude> 要素にはそれぞれ、以下の 2 つの属性を含める必要があります。
domainリソースの場所を指定します。この属性の有効な値 次の内容が含まれます。
root: すべての非公開ファイルが存在するファイル システム上のディレクトリ 保存されます。file:getFilesDir()が返すディレクトリ。database:getDatabasePath()が返すディレクトリ。データベースSQLiteOpenHelperで作成されたデータはここに保存されます。sharedpref:SharedPreferencesが格納されるディレクトリ。external:getExternalFilesDir()が返すディレクトリ。device_root:rootに似ていますが、デバイス保護ストレージに使用します。device_file:fileに似ていますが、デバイス保護ストレージに使用します。device_database:databaseに似ていますが、デバイス保護ストレージに使用します。device_sharedpref:sharedprefに似ていますが、デバイス保護ストレージに使用します。
pathバックアップの対象に含める、または対象から除外するファイルまたはフォルダを指定します。次の点に注意してください。
- この属性は、ワイルドカードや正規表現の構文をサポートしていません。
./を使用して現在のディレクトリを参照することはできますが、 セキュリティのため、..を使用するなどして親ディレクトリを参照する できます。- ディレクトリを指定すると、そのディレクトリ内のすべてのファイルと再帰的サブディレクトリにルールが適用されます。
BackupAgent を実装する
自動バックアップを実装するアプリでは、BackupAgent を実装する必要はありません。ただし、必要に応じてカスタムの BackupAgent を実装できます。通常、以下のような場合に BackupAgent を実装します。
バックアップ イベントの通知を受け取るには、
onRestoreFinished()、onQuotaExceeded(long, long)。これらのコールバック メソッドは、アプリが実行されていない場合でも実行されます。バックアップするファイルセットを XML で簡単に表現できない できます。このようなレアケースでは、
onFullBackup(FullBackupDataOutput)をオーバーライドするBackupAgentを実装し、目的のファイルを保存します。システムのデフォルトの実装を保持するには、スーパークラスでsuper.onFullBackup()を使用して対応するメソッドを呼び出します。
デフォルトでは、BackupAgent を実装すると、アプリが Key-Value ペアのバックアップと復元を行うものと想定されます。代わりにファイルベースの自動バックアップを使用するには、アプリのマニフェストで android:fullBackupOnly 属性を true に設定します。
自動バックアップおよび復元処理が行われている間、システムはアプリを制限付きモードで起動して、競合を引き起こす可能性があるファイルにアプリがアクセスしないようにするとともに、アプリが BackupAgent でコールバック メソッドを実行できるようにします。この制限付きモードでは、アプリのメイン アクティビティは自動的に開始されず、コンテンツ プロバイダは初期化されません。また、アプリのマニフェストで宣言されたサブクラスではなく、基本クラス Application がインスタンス化されます。
BackupAgent には、Key-Value バックアップで使用される抽象メソッド onBackup() および onRestore() を実装する必要があります。Key-Value バックアップを実行しない場合は、これらのメソッドの実装を空のままにしておくことができます。
詳細については、BackupAgent を拡張するをご覧ください。