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

Class Chip

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

Google Chat アプリで利用できます。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) のいずれかしか設定できません。

// ...

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

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

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

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

パラメータ

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

戻る

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