画像が表示された Image。
Google Workspace アドオンと Google Chat アプリで利用できます。
const imageButton = CardService.newImageButton() .setAltText('An image button with an airplane icon.') .setIcon(CardService.Icon.AIRPLANE) .setOpenLink(CardService.newOpenLink().setUrl('https://airplane.com'));
メソッド
| メソッド | 戻り値の型 | 概要 |
|---|---|---|
set | Image | ユーザー補助機能用にボタンの代替テキストを設定します。 |
set | Image | オブジェクトがクリックされたときに、認可フローの URL を開く認可アクションを設定します。 |
set | Image | オブジェクトがクリックされたときにメールの下書きを作成するアクションを設定します。 |
set | Image | ボタンに表示する定義済みの Icon を設定します。 |
set | Image | このボタンのアイコンとして使用する画像の URL を設定します。 |
set | Image | ボタンのスタイルを設定します。 |
set | Image | マテリアル デザインのアイコンを設定します。 |
set | Image | オブジェクトがクリックされたときに実行されるアクションを設定します。 |
set | Image | オブジェクトがクリックされたときにタブで URL を開くアクションを設定します。 |
set | Image | オブジェクトがクリックされたときに開く URL を設定します。 |
set | Image | オブジェクトがクリックされたときに開くポップアップ メニューを設定します。 |
詳細なドキュメント
set
ユーザー補助機能用にボタンの代替テキストを設定します。必須。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
alt | String | このボタンに割り当てる代替テキスト。 |
戻る
Image - チェーン用のこのオブジェクト。
set
オブジェクトがクリックされたときに、認可フローの URL を開く認可アクションを設定します。新しいウィンドウで URL が開きます。ユーザーが認可フローを完了してアプリに戻ると、アドオンが再読み込みされます。
UI オブジェクトには、set、set、set、set、set のいずれかのみ設定できます。
// ... const action = CardService.newAuthorizationAction().setAuthorizationUrl('url'); CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
action | Authorization | この要素がクリックされたときに実行する認可アクションを指定するオブジェクト。 |
戻る
Image - チェーン用のこのオブジェクト。
set
オブジェクトがクリックされたときにメールの下書きを作成するアクションを設定します。UI オブジェクトには、set、set、set、set、set のいずれかのみ設定できます。
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 | 作成された下書きがスタンドアロンか返信の下書きかを指定する列挙型値。 |
戻る
Image - チェーン用のこのオブジェクト。
set
ボタンに表示する定義済みの Icon を設定します。ボタン画像を定義するには、この値または set のいずれかを使用する必要があります。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
icon | Icon | 事前定義された Icon 値のいずれか。 |
戻る
Image - チェーン用のこのオブジェクト。
set
このボタンのアイコンとして使用する画像の URL を設定します。ボタン画像を定義するには、この値または set のいずれかを使用する必要があります。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
url | String | このボタンのアイコンとして使用するホストされている画像の URL アドレス。 |
戻る
Image - チェーン用のこのオブジェクト。
set
ボタンのスタイルを設定します。設定しない場合、デフォルトは Image ボタンになります。
Google Chat アプリで利用できます。Google Workspace アドオンのデベロッパー プレビュー版。
const imageButton = CardService.newImageButton().setImageButtonStyle( CardService.ImageButtonStyle.BORDERLESS, );
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
image | Image | ボタンのスタイル。 |
戻る
Image - チェーン用のこのオブジェクト。
set
マテリアル デザインのアイコンを設定します。
const imageButton = CardService.newImageButton().setMaterialIcon( CardService.newMaterialIcon().setName('search'), );
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
icon | Material | マテリアル デザインのアイコン。 |
戻る
Image - チェーン用のこのオブジェクト。
set
オブジェクトがクリックされたときに実行されるアクションを設定します。UI オブジェクトには、set、set、set、set、set のいずれかのみ設定できます。
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 | この要素がクリックされたときに実行するアクション。 |
戻る
Image - チェーン用のこのオブジェクト。
set
オブジェクトがクリックされたときにタブで URL を開くアクションを設定します。この関数は、URL をビルドする必要がある場合や、Open オブジェクトの作成に加えて他のアクションを実行する必要がある場合に使用します。UI オブジェクトには、set、set、set、set、set のいずれかのみ設定できます。
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 | この要素がクリックされたときに実行するリンクを開くアクションを指定するオブジェクト。 |
戻る
Image - チェーン用のこのオブジェクト。
set
オブジェクトがクリックされたときに開く URL を設定します。この関数は、URL がすでにわかっていて、開くだけでよい場合に使用します。UI オブジェクトには、set、set、set、set、set のいずれかのみ設定できます。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
open | Open | 開く URL を記述する Open オブジェクト。 |
戻る
Image - チェーン用のこのオブジェクト。
set
オブジェクトがクリックされたときに開くポップアップ メニューを設定します。メニューの各アイテムには、クリック時にトリガーされるアクションを指定できます。ネストされたメニューはサポートされていません。メニュー項目のアクションでオーバーフロー メニューを指定しないでください。
Google Chat アプリで利用できます。Google Workspace アドオンのデベロッパー プレビュー版。
const overflowMenuItem = CardService.newOverflowMenuItem() .setStartIcon( CardService.newIconImage().setIconUrl( 'https://www.google.com/images/branding/googleg/1x/googleg_standard_color_64dp.png', ), ) .setText('Open Link') .setOpenLink( CardService.newOpenLink().setUrl('https://www.google.com')); const overflowMenu = CardService.newOverflowMenu().addMenuItem(overflowMenuItem).build();
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
menu | Overflow | この要素がクリックされたときに表示するオーバーフロー メニューを指定するオブジェクト。 |
戻る
Image - チェーン用のこのオブジェクト。