このページは Cloud Translation API によって翻訳されました。

Class Grid

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

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

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

メソッド

メソッド	戻り値の型	概要
`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)`

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

パラメータ

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

戻る

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

`setAuthorizationAction(action)`

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

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

// ...

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) のいずれかのみ設定できます。

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

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

// ...

const action = CardService.newAction().setFunctionName('composeEmailCallback');
CardService.newTextButton()
    .setText('Compose Email')
    .setComposeAction(action, CardService.ComposedEmailType.REPLY_AS_DRAFT);

// ...

function composeEmailCallback() {
  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 - チェーン用のこのオブジェクト。

`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) のいずれかしか設定できません。

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