Class Grid

グリッド

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

Google Workspace アドオンと Google Chat アプリでご利用いただけます。

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)

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

パラメータ

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

リターン

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


setAuthorizationAction(action)

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

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

// ...

var action = CardService.newAuthorizationAction().setAuthorizationUrl('url');
CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);

パラメータ

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

リターン

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


setBorderStyle(borderStyle)

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

パラメータ

Name説明
borderStyleBorderStyle適用する枠線のスタイル。

リターン

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

パラメータ

Name説明
actionActionこの要素がクリックされたときに行う作成アクションを指定するオブジェクト。
composedEmailTypeComposedEmailType作成された下書きが単独の下書きか返信の下書きかを指定する列挙値。

リターン

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


setNumColumns(numColumns)

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

パラメータ

Name説明
numColumnsInteger列の数。

リターン

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


setOnClickAction(action)

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

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

パラメータ

Name説明
actionActionこの要素がクリックされたときに行うアクション。

リターン

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

パラメータ

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

リターン

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


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

パラメータ

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

リターン

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


setTitle(title)

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

パラメータ

Name説明
titleStringタイトルのテキスト。

リターン

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