グリッド アイテムのコレクションを表示する整理されたグリッド。
var grid = CardService.newGrid() .setTitle("My Grid") .setNumColumns(2) .addItem(CardService.newGridItem() .setTitle("My item"));
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
addItem(gridItem) | Grid | 新しいグリッド アイテムをグリッドに追加します。 |
setAuthorizationAction(action) | Grid | オブジェクトがクリックされたときに認可フローへの URL を開く承認アクションを設定します。 |
setBorderStyle(borderStyle) | Grid | 各グリッド アイテムに適用する枠線のスタイルを設定します。 |
setComposeAction(action, composedEmailType) | Grid | オブジェクトがクリックされたときにメールの下書きを作成するアクションを設定します。 |
setNumColumns(numColumns) | Grid | グリッドに表示する列数。 |
setOnClickAction(action) | Grid | オブジェクトがクリックされたときに実行されるアクションを設定します。 |
setOnClickOpenLinkAction(action) | Grid | オブジェクトをクリックしたときにタブで URL を開くアクションを設定します。 |
setOpenLink(openLink) | Grid | オブジェクトがクリックされたときに開く URL を設定します。 |
setTitle(title) | Grid | グリッドのタイトル テキストを設定します。 |
詳細なドキュメント
addItem(gridItem)
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 | この要素がクリックされたときに行う認可アクションを指定するオブジェクト。 |
リターン
Grid
- このオブジェクト(チェーン用)。
setBorderStyle(borderStyle)
各グリッド アイテムに適用する枠線のスタイルを設定します。デフォルトは NO_BORDER です。
パラメータ
名前 | 型 | 説明 |
---|---|---|
borderStyle | BorderStyle | 適用する枠線のスタイル。 |
リターン
Grid
- このオブジェクト(チェーン用)。
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 | 作成された下書きがスタンドアロンか返信の下書きかを指定する列挙値。 |
リターン
Grid
- このオブジェクト(チェーン用)。
setNumColumns(numColumns)
グリッドに表示する列数。右側のパネルに表示されている場合は 1 ~ 2 列を表示できます。デフォルト値は 1 です。ダイアログに表示する場合は、2 ~ 3 列を表示できます。デフォルト値は 2 です。
パラメータ
名前 | 型 | 説明 |
---|---|---|
numColumns | Integer | 列の数。 |
リターン
Grid
- このオブジェクト(チェーン用)。
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 | この要素がクリックされたときに行うアクション。 |
リターン
Grid
- このオブジェクト(チェーン用)。
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 | この要素がクリックされたときにリンクを開くアクションを指定するオブジェクト。 |
リターン
Grid
- このオブジェクト(チェーン用)。
setOpenLink(openLink)
オブジェクトがクリックされたときに開く URL を設定します。URL がすでにわかっていて、開くだけでよい場合は、この関数を使用します。UI オブジェクトには、setOpenLink(openLink)
、setOnClickAction(action)
、setOnClickOpenLinkAction(action)
、setAuthorizationAction(action)
、setComposeAction(action, composedEmailType)
のいずれかのみを設定できます。
パラメータ
名前 | 型 | 説明 |
---|---|---|
openLink | OpenLink | 開く URL を記述する OpenLink オブジェクト。 |
リターン
Grid
- このオブジェクト(チェーン用)。
setTitle(title)
グリッドのタイトル テキストを設定します。テキストは、書式設定されていない書式なし文字列にする必要があります。
パラメータ
名前 | 型 | 説明 |
---|---|---|
title | String | タイトルのテキスト。 |
リターン
Grid
- このオブジェクト(チェーン用)。