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)

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

パラメータ

名前型説明
eventActionEventAction追加する EventAction。

戻る

Widget - チェーン用の Object。

addItem(gridItem)

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

パラメータ

名前型説明
gridItemGridItem追加するグリッド アイテム。

戻る

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);

パラメータ

名前型説明
actionAuthorizationActionこの要素がクリックされたときに実行する認可アクションを指定するオブジェクト。

戻る

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

setBorderStyle(borderStyle)

各グリッド アイテムに適用される枠線のスタイルを設定します。デフォルトは NO_BORDER です。

パラメータ

名前型説明
borderStyleBorderStyle適用する枠線のスタイル。

戻る

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

setComposeAction(action, composedEmailType)

オブジェクトがクリックされたときに下書きメールを作成するアクションを設定します。UI オブジェクトには、setOpenLink(openLink)、setOnClickAction(action)、setOnClickOpenLinkAction(action)、setAuthorizationAction(action)、setComposeAction(action, composedEmailType) のいずれか 1 つのみを設定できます。

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

// ...

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();
}

パラメータ

名前型説明
actionActionこの要素がクリックされたときに実行するコンポーズ アクションを指定するオブジェクト。
composedEmailTypeComposedEmailType作成された下書きがスタンドアロンの下書きか返信の下書きかを指定する列挙値。

戻る

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

setId(id)

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

パラメータ

名前型説明
idStringウィジェットの ID。64 文字以内で、`[a-zA-Z0-9-]+` の形式で指定します。

戻る

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

setNumColumns(numColumns)

グリッドに表示する列の数。右側のサイドパネルに表示される場合は、1 ～ 2 列を表示できます。デフォルト値は 1 です。ダイアログに表示する場合、2 ～ 3 列を表示できます。デフォルト値は 2 です。

パラメータ

名前型説明
numColumnsInteger列数。

戻る

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();
}

パラメータ

名前型説明
actionActionこの要素がクリックされたときに実行するアクション。

戻る

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();
}

パラメータ

名前型説明
actionActionこの要素がクリックされたときに実行するリンクを開くアクションを指定するオブジェクト。

戻る

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

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

パラメータ

名前型説明
openLinkOpenLink開く URL を記述する OpenLink オブジェクト。

戻る

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

setTitle(title)

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

パラメータ

名前型説明
titleStringタイトルのテキスト。

戻る

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

setVisibility(visibility)

ウィジェットの可視性を設定します。デフォルト値は `VISIBLE` です。

パラメータ

名前型説明
visibilityVisibilityウィジェットの Visibility。

戻る

Widget - チェーン用の Object。