Class Chip

チップ

アイコンとテキストラベルを含む Chip。必要に応じてチップを無効にできます。

Google Chat アプリで利用できます。Google Workspace アドオンのデベロッパー プレビュー版です。

デベロッパー プレビュー: Google Workspace デベロッパー プレビュー プログラムの一部として利用できます。このプログラムでは、特定の機能に早期アクセスできます。

const chip = CardService.newChip()
                 .setLabel('Open Link')
                 .setOpenLink(CardService.newOpenLink().setUrl(
                     'https://www.google.com'));

メソッド

メソッド	戻り値の型	概要
setAltText(altText)	Chip	ユーザー補助機能用のチップの代替テキストを設定します。
setAuthorizationAction(action)	Chip	オブジェクトがクリックされたときに、URL を開いて認証フローを開始する認証アクションを設定します。
setComposeAction(action, composedEmailType)	Chip	オブジェクトがクリックされたときに下書きメールを作成するアクションを設定します。
setDisabled(disabled)	Chip	チップを無効にするかどうかを設定します。
setIcon(icon)	Chip	チップとして使用するアイコンを設定します。
setLabel(label)	Chip	チップのタイトルを設定します。
setOnClickAction(action)	Chip	オブジェクトがクリックされたときに実行されるアクションを設定します。
setOnClickOpenLinkAction(action)	Chip	オブジェクトがクリックされたときにタブで URL を開くアクションを設定します。
setOpenLink(openLink)	Chip	オブジェクトがクリックされたときに開く URL を設定します。

詳細なドキュメント

setAltText(altText)

ユーザー補助機能用のチップの代替テキストを設定します。設定しない場合、デフォルトでチップに表示されるテキストになります。

パラメータ

名前	タイプ	説明
altText	String	このチップに割り当てる代替テキスト。

戻る

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

---

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

戻る

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

---

setComposeAction(action, composedEmailType)

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

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

注: このメソッドは、作成 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	作成された下書きがスタンドアロンの下書きか返信の下書きかを指定する列挙値。

戻る

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

---

setDisabled(disabled)

チップを無効にするかどうかを設定します。無効なチップはグレー表示になり、クリックできません。

const chip = CardService.newChip().setLabel('bug Report').setDisabled(true);

パラメータ

名前	タイプ	説明
disabled	Boolean	無効状態。

戻る

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

---

setIcon(icon)

チップとして使用するアイコンを設定します。

const chip = CardService.newChip().setIcon(
    CardService.newIconImage().setMaterialIcon(
        CardService.newMaterialIcon().setName('bug_report'),
        ),
);

パラメータ

名前	タイプ	説明
icon	IconImage	事前定義された IconImage 値のいずれか。

戻る

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

---

setLabel(label)

チップのタイトルを設定します。必須。

const chip = CardService.newChip().setLabel('bug Report');

パラメータ

名前	タイプ	説明
label	String	表示するテキスト。

戻る

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

---

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

戻る

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

---

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

戻る

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

---

setOpenLink(openLink)

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

パラメータ

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

戻る

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