テキストラベル付きの 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)
のいずれか 1 つのみを設定できます。
// ... 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 | #RGB 形式の色。 |
リターン
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)
のいずれか 1 つのみを設定できます。
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)
のいずれかのみを設定できます。
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)
のいずれかのみを設定できます。
パラメータ
名前 | 型 | 説明 |
---|---|---|
openLink | OpenLink | 開く URL を記述する OpenLink オブジェクト。 |
リターン
TextButton
- このオブジェクト(チェーン用)。
setText(text)
setTextButtonStyle(textButtonStyle)
ボタンのスタイルを設定します。設定しない場合、デフォルトの TextButtonStyle.TEXT
ボタンになります。
パラメータ
名前 | 型 | 説明 |
---|---|---|
textButtonStyle | TextButtonStyle | ボタンのスタイル。 |
リターン
TextButton
- このオブジェクト(チェーン用)。