Class Grid

コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。
グリッド

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

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)

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

パラメータ

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

戻る

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


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

パラメータ

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

// ...

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

パラメータ

名前説明
actionActionこの要素がクリックされたときに実行する作成アクションを指定するオブジェクト。
composedEmailTypeComposedEmailType作成した下書きがスタンドアロンまたは返信の下書きのどちらであるかを指定する列挙値。

戻る

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


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

// ...

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

パラメータ

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

// ...

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

パラメータ

氏名説明
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 - チェーン用のオブジェクト。