画像が表示されている ImageButton
。
var imageButton = CardService.newImageButton() .setAltText("An image button with an airplane icon.") .setIcon(CardService.Icon.AIRPLANE) .setOpenLink(CardService.newOpenLink() .setUrl("https://airplane.com"));
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
setAltText(altText) | ImageButton | ユーザー補助機能用のボタンの代替テキストを設定します。 |
setAuthorizationAction(action) | ImageButton | オブジェクトがクリックされたときに認可フローへの URL を開く承認アクションを設定します。 |
setComposeAction(action, composedEmailType) | ImageButton | オブジェクトがクリックされたときにメールの下書きを作成するアクションを設定します。 |
setIcon(icon) | ImageButton | ボタンに表示する事前定義された Icon を設定します。 |
setIconUrl(url) | ImageButton | このボタンのアイコンとして使用する画像の URL を設定します。 |
setOnClickAction(action) | ImageButton | オブジェクトがクリックされたときに実行されるアクションを設定します。 |
setOnClickOpenLinkAction(action) | ImageButton | オブジェクトをクリックしたときにタブで URL を開くアクションを設定します。 |
setOpenLink(openLink) | ImageButton | オブジェクトがクリックされたときに開く URL を設定します。 |
詳細なドキュメント
setAltText(altText)
ユーザー補助機能用のボタンの代替テキストを設定します。必須。
パラメータ
名前 | 型 | 説明 |
---|---|---|
altText | String | このボタンに割り当てる代替テキスト。 |
リターン
ImageButton
- このオブジェクト(チェーン用)。
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 | この要素がクリックされたときに行う認可アクションを指定するオブジェクト。 |
リターン
ImageButton
- このオブジェクト(チェーン用)。
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 | 作成された下書きがスタンドアロンか返信の下書きかを指定する列挙値。 |
リターン
ImageButton
- このオブジェクト(チェーン用)。
setIcon(icon)
ボタンに表示する事前定義された Icon
を設定します。ボタン画像を定義するには、これまたは setIconUrl(url)
を使用する必要があります。
パラメータ
名前 | 型 | 説明 |
---|---|---|
icon | Icon | 事前定義された Icon 値のいずれか。 |
リターン
ImageButton
- このオブジェクト(チェーン用)。
setIconUrl(url)
このボタンのアイコンとして使用する画像の URL を設定します。ボタン画像を定義するには、これまたは setIcon(icon)
を使用する必要があります。
パラメータ
名前 | 型 | 説明 |
---|---|---|
url | String | このボタンのアイコンとして使用する、ホストされている画像の URL アドレス。 |
リターン
ImageButton
- このオブジェクト(チェーン用)。
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 | この要素がクリックされたときに行うアクション。 |
リターン
ImageButton
- このオブジェクト(チェーン用)。
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 | この要素がクリックされたときにリンクを開くアクションを指定するオブジェクト。 |
リターン
ImageButton
- このオブジェクト(チェーン用)。
setOpenLink(openLink)
オブジェクトがクリックされたときに開く URL を設定します。URL がすでにわかっていて、開くだけでよい場合は、この関数を使用します。UI オブジェクトには、setOpenLink(openLink)
、setOnClickAction(action)
、setOnClickOpenLinkAction(action)
、setAuthorizationAction(action)
、setComposeAction(action, composedEmailType)
のいずれかのみを設定できます。
パラメータ
名前 | 型 | 説明 |
---|---|---|
openLink | OpenLink | 開く URL を記述する OpenLink オブジェクト。 |
リターン
ImageButton
- このオブジェクト(チェーン用)。