テキストラベル付きの TextButton
。必要に応じて、背景色を設定し、ボタンを無効にできます。
var textButton = CardService.newTextButton() .setText("Open Link") .setOpenLink(CardService.newOpenLink() .setUrl("https://www.google.com"));
Methods
方法 | 戻り値の型 | 概要 |
---|---|---|
setAltText(altText) | TextButton | ユーザー補助機能のボタンの代替テキストを設定します。 |
setAuthorizationAction(action) | TextButton | オブジェクトがクリックされたときに承認フローの URL を開く認可アクションを設定します。 |
setBackgroundColor(backgroundColor) | TextButton | TextButtonStyle.FILLED ボタンの背景色を設定します。 |
setComposeAction(action, composedEmailType) | TextButton | オブジェクトがクリックされたときにメールの下書きを作成するアクションを設定します。 |
setDisabled(disabled) | TextButton | ボタンを無効にするかどうかを設定します。 |
setOnClickAction(action) | TextButton | オブジェクトがクリックされたときに実行されるアクションを設定します。 |
setOnClickOpenLinkAction(action) | TextButton | オブジェクトがクリックされたときに、タブで URL を開くアクションを設定します。 |
setOpenLink(openLink) | TextButton | オブジェクトがクリックされたときに開く URL を設定します。 |
setText(text) | TextButton | ボタンに表示するテキストを設定します。 |
setTextButtonStyle(textButtonStyle) | TextButton | ボタンのスタイルを設定します。 |
詳細なドキュメント
setAltText(altText)
ユーザー補助機能のボタンの代替テキストを設定します。設定しない場合、ボタンに表示されるテキストがデフォルトです。
パラメータ
名前 | 型 | 説明 |
---|---|---|
altText | String | このボタンに割り当てる代替テキスト。 |
戻る
TextButton
- チェーン用のオブジェクト。
setAuthorizationAction(action)
オブジェクトがクリックされたときに承認フローの URL を開く認可アクションを設定します。URL が新しいウィンドウで開きます。ユーザーが認証フローを終了してアプリケーションに戻ると、アドオンが再読み込みされます。
UI オブジェクトには、setOpenLink(openLink)
、setOnClickAction(action)
、setOnClickOpenLinkAction(action)
、setAuthorizationAction(action)
、setComposeAction(action, composedEmailType)
のいずれかのみを設定できます。
// ... var action = CardService.newAuthorizationAction().setAuthorizationUrl('url'); CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);
パラメータ
名前 | 型 | 説明 |
---|---|---|
action | AuthorizationAction | この要素がクリックされたときに実行する認証アクションを指定するオブジェクト。 |
戻る
TextButton
- チェーン用のオブジェクト。
setBackgroundColor(backgroundColor)
TextButtonStyle.FILLED
ボタンの背景色を設定します。TextButtonStyle.FILLED
ボタンで設定されていない場合、ボタンはアドオンのマニフェストで定義されているセカンダリ カラーを使用します。
このメソッドは、TextButtonStyle.TEXT
ボタンでは機能しません。
パラメータ
名前 | 型 | 説明 |
---|---|---|
backgroundColor | String | 色は #gcp 形式で指定します。 |
戻る
TextButton
- チェーン用のオブジェクト。
setComposeAction(action, composedEmailType)
オブジェクトがクリックされたときにメールの下書きを作成するアクションを設定します。UI オブジェクトには、setOpenLink(openLink)
、setOnClickAction(action)
、setOnClickOpenLinkAction(action)
、setAuthorizationAction(action)
、setComposeAction(action, composedEmailType)
のいずれかのみを設定できます。
Action
パラメータには、ComposeActionResponseBuilder.setGmailDraft(draft)
を使用して構成された ComposeActionResponse
オブジェクトを返すコールバック関数を指定する必要があります。
// ... var action = CardService.newAction().setFunctionName('composeEmailCallback'); CardService.newTextButton() .setText('Compose Email') .setComposeAction(action, CardService.ComposedEmailType.REPLY_AS_DRAFT); // ... function composeEmailCallback() { var thread = GmailApp.getThreadById(e.threadId); var draft = thread.createDraftReply('This is a reply'); return CardService.newComposeActionResponseBuilder() .setGmailDraft(draft) .build(); }
パラメータ
名前 | 型 | 説明 |
---|---|---|
action | Action | この要素がクリックされたときに実行する作成アクションを指定するオブジェクト。 |
composedEmailType | ComposedEmailType | 作成された下書きがスタンドアロンまたは返信の下書きのどちらであるかを指定する列挙値。 |
戻る
TextButton
- チェーン用のオブジェクト。
setDisabled(disabled)
ボタンを無効にするかどうかを設定します。無効なボタンがグレー表示になり、クリックできません。
パラメータ
名前 | 型 | 説明 |
---|---|---|
disabled | Boolean | 無効状態。 |
戻る
TextButton
- チェーン用のオブジェクト。
setOnClickAction(action)
オブジェクトがクリックされたときに実行されるアクションを設定します。UI オブジェクトには、setOpenLink(openLink)
、setOnClickAction(action)
、setOnClickOpenLinkAction(action)
、setAuthorizationAction(action)
、setComposeAction(action, composedEmailType)
のいずれかのみを設定できます。
Action
パラメータでは、ActionResponse
オブジェクトを返すコールバック関数を指定する必要があります。
// ... var 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 | この要素がクリックされたときに実行するアクション。 |
戻る
TextButton
- チェーン用のオブジェクト。
setOnClickOpenLinkAction(action)
オブジェクトがクリックされたときに、タブで URL を開くアクションを設定します。この関数は、URL を作成する必要がある場合や、OpenLink
オブジェクトを作成するために他のアクションを行う必要がある場合に使用します。UI オブジェクトには、setOpenLink(openLink)
、setOnClickAction(action)
、setOnClickOpenLinkAction(action)
、setAuthorizationAction(action)
、setComposeAction(action, composedEmailType)
のいずれか 1 つのみを設定できます。
Action
パラメータには、ActionResponseBuilder.setOpenLink(openLink)
を使用して構成された ActionResponse
オブジェクトを返すコールバック関数を指定する必要があります。
// ... var 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 | この要素がクリックされたときに実行するオープンリンク アクションを指定するオブジェクト。 |
戻る
TextButton
- チェーン用のオブジェクト。
setOpenLink(openLink)
オブジェクトがクリックされたときに開く URL を設定します。この関数は、URL がすでにわかっているため開く必要がある場合にのみ使用します。UI オブジェクトには、setOpenLink(openLink)
、setOnClickAction(action)
、setOnClickOpenLinkAction(action)
、setAuthorizationAction(action)
、setComposeAction(action, composedEmailType)
のいずれか 1 つのみを設定できます。
パラメータ
名前 | 型 | 説明 |
---|---|---|
openLink | OpenLink | 開く URL を記述する OpenLink オブジェクト。 |
戻る
TextButton
- チェーン用のオブジェクト。
setText(text)
setTextButtonStyle(textButtonStyle)
ボタンのスタイルを設定します。未設定のままにした場合、デフォルトで TextButtonStyle.TEXT
ボタンが使用されます。
パラメータ
名前 | 型 | 説明 |
---|---|---|
textButtonStyle | TextButtonStyle | ボタンのスタイル。 |
戻る
TextButton
- チェーン用のオブジェクト。