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

テキスト入力 ウィジェットを使用すると、ユーザーが入力したテキストをアドオンが読み取って処理できます。これらのウィジェットを構成して、入力テキストの候補を自動的にユーザーに提示できます。

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

候補の設定

テキスト入力の候補を構成するには、次の操作のみが必要です。

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

候補の静的リストとアクションの両方を指定した場合、ユーザーが文字の入力を開始するまで、アプリケーション 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 つは静的リストを使用、もう 1 つはコールバック関数を使用しています。

// 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 
 *  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() がトリガーされます。