非推奨。このクラスは非推奨のため、新しいスクリプトでは使用しないでください。
このクラスは非推奨です。代わりに、Decorated を使用してください。
メソッド
| メソッド | 戻り値の型 | 概要 |
|---|---|---|
add | Widget | ウィジェットで実行できるイベント アクションを追加します。 |
set | | オブジェクトがクリックされたときに、URL を開いて認証フローに移動する認証アクションを設定します。 |
set | | オブジェクトがクリックされたときに下書きメールを作成するアクションを設定します。 |
set | Widget | 変更するウィジェットの識別に使用される一意の ID を設定します。 |
set | | オブジェクトがクリックされたときに実行されるアクションを設定します。 |
set | | オブジェクトがクリックされたときにタブで URL を開くアクションを設定します。 |
set | | オブジェクトがクリックされたときに開く URL を設定します。 |
set | Widget | ウィジェットの可視性を設定します。 |
詳細なドキュメント
add Event Action(eventAction)
ウィジェットで実行できるイベント アクションを追加します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
event | Event | 追加する Event。 |
戻る
Widget - チェーン用の Object。
set Authorization Action(action)
オブジェクトがクリックされたときに、URL を開いて認証フローに移動する認証アクションを設定します。新しいウィンドウで URL が開きます。ユーザーが承認フローを完了してアプリに戻ると、アドオンが再読み込みされます。
UI オブジェクトに設定できるのは、set、set、set、set、set のいずれか 1 つのみです。
// ... const action = CardService.newAuthorizationAction().setAuthorizationUrl('url'); CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
action | Authorization | この要素がクリックされたときに実行する認可アクションを指定するオブジェクト。 |
戻る
- チェーン用のこのオブジェクト。Key
set Compose Action(action, composedEmailType)
オブジェクトがクリックされたときに下書きメールを作成するアクションを設定します。UI オブジェクトには、set、set、set、set、set のいずれか 1 つのみを設定できます。
Action パラメータでは、Compose を使用して構成された Compose オブジェクトを返すコールバック関数を指定する必要があります。
// ... const action = CardService.newAction().setFunctionName('composeEmailCallback'); CardService.newTextButton() .setText('Compose Email') .setComposeAction(action, CardService.ComposedEmailType.REPLY_AS_DRAFT); // ... function composeEmailCallback(e) { const thread = GmailApp.getThreadById(e.threadId); const draft = thread.createDraftReply('This is a reply'); return CardService.newComposeActionResponseBuilder() .setGmailDraft(draft) .build(); }
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
action | Action | この要素がクリックされたときに実行するコンポーズ アクションを指定するオブジェクト。 |
composed | Composed | 作成された下書きがスタンドアロンの下書きか返信の下書きかを指定する列挙値。 |
戻る
- チェーン用のこのオブジェクト。Key
set Id(id)
変更するウィジェットの識別に使用される一意の ID を設定します。ウィジェットの変更はアドオンでのみサポートされています。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
id | String | ウィジェットの ID。64 文字以内で、`[a-zA-Z0-9-]+` の形式で指定します。 |
戻る
Widget - チェーン用のこのオブジェクト。
set On Click Action(action)
オブジェクトがクリックされたときに実行されるアクションを設定します。UI オブジェクトに設定できるのは、set、set、set、set、set のいずれか 1 つのみです。
Action パラメータは、Action オブジェクトを返すコールバック関数を指定する必要があります。
// ... const action = CardService.newAction().setFunctionName('notificationCallback'); CardService.newTextButton() .setText('Create notification') .setOnClickAction(action); // ... function notificationCallback() { return CardService.newActionResponseBuilder() .setNotification( CardService.newNotification().setText('Some info to display to user'), ) .build(); }
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
action | Action | この要素がクリックされたときに実行するアクション。 |
戻る
- チェーン用のこのオブジェクト。Key
set On Click Open Link Action(action)
オブジェクトがクリックされたときにタブで URL を開くアクションを設定します。この関数は、URL を作成する必要がある場合や、Open オブジェクトの作成に加えて他のアクションを実行する必要がある場合に使用します。UI オブジェクトに設定できるのは、set、set、set、set、set のいずれか 1 つのみです。
Action パラメータでは、Action を使用して構成された Action オブジェクトを返すコールバック関数を指定する必要があります。
// ... const action = CardService.newAction().setFunctionName('openLinkCallback'); CardService.newTextButton() .setText('Open Link') .setOnClickOpenLinkAction(action); // ... function openLinkCallback() { return CardService.newActionResponseBuilder() .setOpenLink(CardService.newOpenLink().setUrl('https://www.google.com')) .build(); }
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
action | Action | この要素がクリックされたときに実行するリンクを開くアクションを指定するオブジェクト。 |
戻る
- チェーン用のこのオブジェクト。Key
set Open Link(openLink)
オブジェクトがクリックされたときに開く URL を設定します。この関数は、URL がすでにわかっていて、開くだけでよい場合に使用します。UI オブジェクトに設定できるのは、set、set、set、set、set のいずれか 1 つのみです。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
open | Open | 開く URL を記述する Open オブジェクト。 |
戻る
- チェーン用のこのオブジェクト。Key
set Visibility(visibility)
ウィジェットの可視性を設定します。デフォルト値は `VISIBLE` です。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
visibility | Visibility | ウィジェットの Visibility。 |
戻る
Widget - チェーン用の Object。