[Text Input] ウィジェットを使用すると、アドオンがユーザーから提供されたテキストを読み取って、それに反応できます。これらのウィジェットを構成して、ユーザーに入力テキストを自動的に提案することができます。
表示される文字列は、指定した文字列の静的リストから取得できます。 または、ユーザーがすでにウィジェットに入力したテキストなど、コンテキストから提案を作成することもできます。
提案の構成
テキスト入力の提案を構成するには、次の操作を行います。
- 次の方法で候補のリストを作成する。
- 静的リストの作成
- コンテキストから動的にリストを作成するコールバック関数でアクションを定義する。
- 候補リストやアクションをテキスト入力ウィジェットに添付します。
提案の静的リストとアクションの両方を指定すると、ユーザーが文字の入力を開始するまでアプリ UI は静的リストを使用します。その後、コールバック関数が使用され、静的リストは無視されます。
静的な提案
候補の静的リストを提供する手順は、次のとおりです。
Suggestionsオブジェクトを作成します。addSuggestion()またはaddSuggestions()を使用して、各静的提案を追加します。TextInput.setSuggestions()を使用して、Suggestionsオブジェクトをウィジェットにアタッチします。
静的候補が追加順に表示されます。UI では、大文字と小文字が区別されないプレフィックス マッチングが自動的に実行され、ユーザーがウィジェットに文字を入力すると、候補リストがフィルタされます。
操作の候補
静的候補リストを使用していない場合は、候補を動的に構築するアクションを定義する必要があります。手順は次のとおりです。
Actionオブジェクトを作成し、定義したコールバック関数に関連付けます。- ウィジェットの
TextInput.setSuggestionsAction()関数を呼び出して、Actionオブジェクトを指定します。 - コールバック関数を実装して候補リストを作成し、ビルドされた
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() ハンドラ関数を定義できます。このハンドラと候補の両方が同じテキスト入力に対して有効になっている場合、次のルールでテキスト入力操作の動作を定義します。
setOnChangeAction()ハンドラは、候補が選択された後に実行されます。- 選択した候補を変更せずに、ユーザーが Enter キーを押すと（またはテキスト入力がフォーカスされなかった場合）、
setOnChangeAction()はトリガーされなくなります。 - ユーザーが候補を選択した後、リストの候補のいずれにも一致しないように編集を行うと、
setOnChangeAction()は再びトリガーされます。 - ユーザーが候補を選択しなかった場合、テキスト入力がフォーカスを失うと
setOnChangeAction()がトリガーされます。