Class Grid

グリッド

グリッド アイテムのコレクションを表示する整理されたグリッド。

Google Workspace アドオンと Google Chat アプリで利用できます。

const grid = CardService.newGrid().setTitle('My Grid').setNumColumns(2).addItem(
    CardService.newGridItem().setTitle('My item'));

メソッド

メソッド	戻り値の型	概要
addEventAction(eventAction)	Widget	ウィジェットで実行できるイベント アクションを追加します。
addItem(gridItem)	Grid	グリッドに新しいグリッド アイテムを追加します。
setAuthorizationAction(action)	Grid	オブジェクトがクリックされたときに認証フローの URL を開く認証アクションを設定します。
setBorderStyle(borderStyle)	Grid	各グリッド アイテムに適用する枠線のスタイルを設定します。
setComposeAction(action, composedEmailType)	Grid	オブジェクトがクリックされたときに下書きメールを作成するアクションを設定します。
setId(id)	Widget	変更するウィジェットの識別に使用される一意の ID を設定します。
setNumColumns(numColumns)	Grid	グリッドに表示する列数。
setOnClickAction(action)	Grid	オブジェクトがクリックされたときに実行されるアクションを設定します。
setOnClickOpenLinkAction(action)	Grid	オブジェクトがクリックされたときにタブで URL を開くアクションを設定します。
setOpenLink(openLink)	Grid	オブジェクトがクリックされたときに開く URL を設定します。
setTitle(title)	Grid	グリッドのタイトル テキストを設定します。
setVisibility(visibility)	Widget	ウィジェットの表示 / 非表示を設定します。

詳細なドキュメント

addEventAction(eventAction)

ウィジェットで実行できるイベント アクションを追加します。

パラメータ

名前	タイプ	説明
eventAction	EventAction	追加する EventAction。

戻る

Widget \- チェーン用の オブジェクト。

---

addItem(gridItem)

グリッドに新しいグリッド アイテムを追加します。

パラメータ

名前	タイプ	説明
gridItem	GridItem	追加するグリッド アイテム。

戻る

Grid \- チェーン用のこのオブジェクト。

---

setAuthorizationAction(action)

オブジェクトがクリックされたときに認証フローの URL を開く認証アクションを設定します。これにより、URL が新しいウィンドウで開きます。ユーザーが認証フローを完了してアプリケーションに戻ると、アドオンが再読み込みされます。

UI オブジェクトに設定できるのは、setOpenLink(openLink)、setOnClickAction(action)、setOnClickOpenLinkAction(action)、setAuthorizationAction(action)、setComposeAction(action, composedEmailType) のいずれか 1 つのみです。

// ...

const 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) のいずれか 1 つのみです。

Action パラメータでは、ComposeActionResponse オブジェクトを返すコールバック関数を、ComposeActionResponseBuilder.setGmailDraft(draft) を使用して構成する必要があります。

注: このメソッドでは、作成アクション は設定されません。これは、 作成 UI を拡張するために使用されます。 このメソッドは、この UI 要素を、アクションが完了したときに Gmail で 開かれる Apps Script の下書きメッセージを作成する Actionに接続します。

// ...

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	この要素が クリックされたときに実行する作成アクションを指定するオブジェクト。
composedEmailType	ComposedEmailType	作成された下書きが スタンドアロンの下書きか返信の下書きかを指定する列挙値。

戻る

Grid \- チェーン用のこのオブジェクト。

---

setId(id)

変更するウィジェットの識別に使用される一意の ID を設定します。ウィジェットの変更はアドオンでのみサポートされています。

パラメータ

名前	タイプ	説明
id	String	ウィジェットの ID。64 文字以内で、形式は `[a-zA-Z0-9-]+` です。

戻る

Widget \- チェーン用のこのオブジェクト。

---

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 オブジェクトを返すコールバック関数を指定する必要があります。

// ...

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	この要素がクリックされたときに実行するアクション。

戻る

Grid \- チェーン用のこのオブジェクト。

---

setOnClickOpenLinkAction(action)

オブジェクトがクリックされたときにタブで URL を開くアクションを設定します。URL を作成する必要がある場合や、OpenLink オブジェクトの作成に加えて他のアクションを実行する必要がある場合は、この関数を使用します。UI オブジェクトに設定できるのは、setOpenLink(openLink)、setOnClickAction(action)、setOnClickOpenLinkAction(action)、setAuthorizationAction(action)、setComposeAction(action, composedEmailType) のいずれか 1 つのみです。

Action パラメータでは、ActionResponseBuilder.setOpenLink(openLink) を使用して構成された ActionResponse オブジェクトを返すコールバック関数を指定する必要があります。

// ...

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	この要素が クリックされたときに実行するリンクを開くアクションを指定するオブジェクト。

戻る

Grid \- チェーン用のこのオブジェクト。

---

setOpenLink(openLink)

オブジェクトがクリックされたときに開く URL を設定します。URL がすでにわかっていて、開くだけでよい場合は、この関数を使用します。UI オブジェクトに設定できるのは、setOpenLink(openLink)、setOnClickAction(action)、setOnClickOpenLinkAction(action)、setAuthorizationAction(action)、setComposeAction(action, composedEmailType) のいずれか 1 つのみです。

パラメータ

名前	タイプ	説明
openLink	OpenLink	開く URL を記述する OpenLink オブジェクト。

戻る

Grid \- チェーン用のこのオブジェクト。

---

setTitle(title)

グリッドのタイトル テキストを設定します。テキストは書式設定なしのプレーン文字列にする必要があります。

パラメータ

名前	タイプ	説明
title	String	タイトル テキスト。

戻る

Grid \- チェーン用のこのオブジェクト。

---

setVisibility(visibility)

ウィジェットの表示 / 非表示を設定します。デフォルト値は `VISIBLE` です。

パラメータ

名前	タイプ	説明
visibility	Visibility	ウィジェットの Visibility。

戻る

Widget \- チェーン用の オブジェクト。