自動入力を IME および自動入力サービスと統合する

Android 11 以降では、キーボードなどのインプット メソッド エディタ(IME)を使用して、メニューに候補を表示する代わりに、自動入力候補をインラインや候補領域内に表示できるようになりました。これらの自動入力候補には、パスワードやクレジット カード情報などの個人データが含まれることがあるため、ユーザーが選択するまで候補は IME に表示されません。この機能を利用するには、IME と自動入力サービス(パスワード マネージャーなど)を更新してください。IME または自動入力サービスがインライン自動入力をサポートしていない場合は、Android 11 より前のバージョンのように、候補がメニューに表示されます。

ワークフロー

このフローで、IME は現在のキーボードまたはその他の入力エディタを意味し、候補プロバイダは自動入力候補の適切なプロバイダを意味します。入力フィールドとユーザーの設定に応じて、候補のプロバイダはプラットフォームまたは自動入力サービスです。

  1. ユーザーが、自動入力をトリガーする入力フィールド(パスワードやクレジット カードの入力フィールドなど)にフォーカスします。

  2. プラットフォームは、現在の IME と適切な候補プロバイダをクエリして、インライン自動入力をサポートしているかどうかを確認します。IME または候補プロバイダのいずれかがインライン自動入力をサポートしていない場合、Android 10 以前と同様に、候補がメニューに表示されます。

  3. プラットフォームが IME に対し、「候補リクエスト」を提供するよう求めます。この提案リクエストでは、表示する提案の最大数と、各提案のプレゼンテーション仕様を指定します。表示仕様では、最大サイズ、テキストサイズ、色、フォントデータなどを指定し、候補のプロバイダを IME のデザインに合わせます。

  4. プラットフォームが候補プロバイダに対し、リクエストされた候補数まで候補を提供するよう求めます。各候補には、候補の UI を含む View をインフレートするためのコールバックが含まれます。

  5. プラットフォームは候補の準備ができたことを IME に通知します。IME は、コールバック メソッドを呼び出して各候補の View をインフレートすることで候補を表示します。ユーザーの個人情報を保護するため、この段階で IME は提案の内容を確認しません

  6. ユーザーが候補のいずれかを選択すると、ユーザーがシステム メニューから候補を選択した場合と同じ方法で IME に通知されます。

以下のセクションでは、インライン自動入力をサポートするように IME または自動入力サービスを構成する方法について説明します。

インライン自動入力をサポートするように IME を構成する

このセクションでは、インライン自動入力をサポートするように IME を構成する方法について説明します。IME がインライン自動入力をサポートしていない場合、プラットフォームはデフォルトでメニューに自動入力候補を表示します。

IME は supportsInlinedSuggestions 属性を true に設定する必要があります。

<input-method
    xmlns:android="http://schemas.android.com/apk/res/android"
    android:supportsInlineSuggestions="true"/>

プラットフォームで自動入力候補が必要になると、IME の InputMethodService.onCreateInlineSuggestionsRequest() メソッドが呼び出されます。このメソッドを実装する必要があります。次のものを指定して、InlineSuggestionsRequest を返します。

  • IME が求める候補の数。
  • 各提案の InlinePresentationSpec。提案の表示方法を定義します。

候補がある場合、プラットフォームは IME の onInlineSuggestionsResponse() メソッドを呼び出し、候補を含む InlineSuggestionsResponse を渡します。このメソッドを実装する必要があります。実装では、InlineSuggestionsResponse.getInlineSuggestions() を呼び出して候補のリストを取得し、InlineSuggestion.inflate() メソッドを呼び出して各候補をインフレートします。

インライン自動入力をサポートするように自動入力サービスを構成する

このセクションでは、インライン自動入力をサポートするように自動入力サービスを構成する方法について説明します。アプリがインライン自動入力をサポートしていない場合、プラットフォームはデフォルトで自動入力候補をメニューに表示します。

自動入力サービスで supportsInlinedSuggestions 属性を true に設定する必要があります。

<autofill-service
    xmlns:android="http://schemas.android.com/apk/res/android"
    android:supportsInlineSuggestions="true"/>

IME が自動入力候補を必要とする場合、Android 11 以前のバージョンの場合と同様に、プラットフォームは自動入力サービスの onFillRequest() メソッドを呼び出します。ただし、IME によって作成された InlineSuggestionsRequest を取得するには、サービスは渡された FillRequest オブジェクトの getInlineSuggestionsRequest() メソッドを呼び出す必要があります。InlineSuggestionsRequest は、必要なインライン候補の数と、それぞれの候補を表示する方法を指定します。IME がインライン提案をサポートしていない場合、メソッドは null を返します。

自動入力サービスは、InlineSuggestionsRequest でリクエストされた最大数まで InlinePresentation オブジェクトを作成します。表示は、InlineSuggestionsRequest で指定されたサイズの制約に従う必要があります。候補を IME に返すには、候補ごとに 1 回 Dataset.Builder.setValue() を呼び出します。Android 11 には、インライン候補をサポートする Dataset.Builder.setValue() のバージョンが用意されています。