テキスト入力に対するオートコンプリートの候補

Text Input ウィジェットを使用すると、アドオンはユーザーが入力したテキストを読み取り、反応できます。これらのウィジェットは、入力テキストの自動提案を行うように構成できます。

表示される候補は、指定した文字列の静的なリストから取得されます。または、ユーザーがウィジェットにすでに入力したテキストなどのコンテキストから候補を作成することもできます。

候補の構成

テキスト入力の候補を構成する場合は、次のことのみを行います。

  • 次の方法で候補のリストを作成します。
    • 静的リストを作成する
    • コンテキストからリストを動的に作成するコールバック関数を使用して、アクションを定義する。
  • 候補リストとアクションをテキスト入力ウィジェットに追加します。

候補の静的リストとアクションの両方を提供すると、ユーザーが文字の入力を開始するまで、アプリ UI は静的リストを使用します。その後、コールバック関数が使用され、静的リストは無視されます。

静的候補

候補の静的リストを表示するには、次の操作のみを行います。

  1. Suggestions オブジェクトを作成します。
  2. addSuggestion() または addSuggestions() を使用して、各静的な提案を追加します。
  3. TextInput.setSuggestions() を使用して、Suggestions オブジェクトをウィジェットにアタッチします。

UI には、静的な候補が追加された順序で表示されます。また、UI では、大文字と小文字を区別しない接頭辞のマッチングが自動的に実行され、ユーザーがウィジェットに文字を入力すると、候補リストがフィルタリングされます。

候補の操作

静的な候補リストを使用していない場合は、動的に候補を作成するアクションを定義する必要があります。手順は次のとおりです。

  1. Action オブジェクトを作成し、定義したコールバック関数に関連付けます。
  2. ウィジェットの TextInput.setSuggestionsAction() 関数を呼び出し、Action オブジェクトを指定します。
  3. 候補リストを作成し、ビルドされた SuggestionsResponse オブジェクトを返すコールバック関数を実装します。

UI では、ユーザーがテキスト入力に文字を入力するたびにコールバック関数が呼び出されます。ただし、ユーザーが入力をやめた後に限られます。このコールバック関数は、開いているカードのウィジェットに関する情報を含むイベント オブジェクトを受け取ります。詳しくは、アクション イベント オブジェクトをご覧ください。

このコールバック関数は、表示する候補のリストを含む有効な SuggestionsResponse オブジェクトを返す必要があります。UI には、候補を追加の順に表示します。静的リストとは異なり、UI はユーザー入力に基づいてコールバックの候補の自動フィルタリングを行いません。このようなフィルタリングを行うには、イベント オブジェクトからテキスト入力値を読み取り、リストを作成する際に候補をフィルタリングする必要があります。

例

次の Google Workspace アドオンのコード スニペットは、2 つの異なるテキスト入力ウィジェットで候補を構成する方法を示しています。1 つ目は静的リスト、2 つ目はコールバック関数を使用しています。

// Create an input with a static suggestion list.
var textInput1 = CardService.newTextInput()
    .setFieldName('colorInput')
    .setTitle('Color choice')
    .setSuggestions(CardService.newSuggestions()
        .addSuggestion('Red')
        .addSuggestion('Yellow')
        .addSuggestions(['Blue', 'Black', 'Green']));

// Create an input with a dynamic suggestion list.
var action = CardService.newAction()
    .setFunctionName('refreshSuggestions');
var textInput2 = CardService.newTextInput()
    .setFieldName('emailInput')
    .setTitle('Email')
    .setSuggestionsAction(action);

// ...

/**
 *  Build and return a suggestion response. In this case, the suggestions
 *  are a list of emails taken from the To: and CC: lists of the open
 *  message in Gmail, filtered by the text that the user has already
 *  entered. This method assumes the Google Workspace
 *  add-on extends Gmail; the add-on only calls this method for cards
 *  displayed when the user has entered a message context.
 *
 *  @param {Object} e the event object containing data associated with
 *      this text input widget.
 *  @return {SuggestionsResponse}
 */
 function refreshSuggestions(e) {
   // Activate temporary Gmail scopes, in this case so that the
   // open message metadata can be read.
   var accessToken = e.gmail.accessToken;
   GmailApp.setCurrentMessageAccessToken(accessToken);

   var userInput = e && e.formInput['emailInput'].toLowerCase();
   var messageId = e.gmail.messageId;
   var message = GmailApp.getMessageById(messageId);

   // Combine the comma-separated returned by these methods.
   var addresses = message.getTo() + ',' + message.getCc();

   // Filter the address list to those containing the text the user
   // has already entered.
   var suggestionList = [];
   addresses.split(',').forEach(function(email) {
     if (email.toLowerCase().indexOf(userInput) !== -1) {
       suggestionList.push(email);
     }
   });
   suggestionList.sort();

   return CardService.newSuggestionsResponseBuilder()
       .setSuggestions(CardService.newSuggestions()
           .addSuggestions(suggestionList))
       .build();  // Don't forget to build the response!
 }

候補と OnChangeAction()

テキスト入力ウィジェットには、ウィジェットがフォーカスを失うたびに実行される setOnChangeAction() ハンドラ関数を定義できます。同じテキスト入力に対してこのハンドラと提案の両方が有効になっている場合、次のルールによってテキスト入力インタラクションの動作が定義されます。

  1. setOnChangeAction() ハンドラは、候補が選択されると実行されます。
  2. 選択した候補を変更せずにユーザーが Enter キーを押しても（または、テキスト入力がフォーカスを失った）、setOnChangeAction() は再度トリガーされません。
  3. ユーザーが候補を選択した後に、リスト内のどの候補とも一致しないように編集した場合、setOnChangeAction() は再度トリガーされます。
  4. ユーザーが候補を選択しない場合、テキスト入力がフォーカスを失ったときに setOnChangeAction() がトリガーされます。