Class ChatResponseBuilder

ChatResponseBuilder

ChatResponse オブジェクトのビルダー。

Google Chat アプリでのみ使用できます。Google Workspace アドオンでは利用できません。

const cardSection = CardService.newCardSection();
cardSection.addWidget(
    CardService.newTextParagraph().setText('This is a text paragraph widget.'));

const card = CardService.newCardBuilder()
    .setName('Card name')
    .setHeader(CardService.newCardHeader().setTitle('Card title'))
    .addSection(cardSection)
    .build();

const cardWithId = CardService.newCardWithId()
    .setCardId('card_id')
    .setCard(card);

const chatResponse = CardService.newChatResponseBuilder()
       .addCardsV2(cardWithId)
       .setText('Example text')
    .build();

Methods

メソッド	戻り値の型	概要
addCardsV2(cardWithId)	ChatResponseBuilder	メッセージのカード フィールドを設定します。
build()	ChatResponse	現在のアクション レスポンスを作成して検証します。
setActionResponse(actionResponse)	ChatResponseBuilder	メッセージのアクション レスポンス フィールドを設定します。
setText(text)	ChatResponseBuilder	Chat メッセージのテキストを設定します。

詳細なドキュメント

addCardsV2(cardWithId)

メッセージのカード フィールドを設定します。Google Chat のメッセージでカードを送信するために使用されます。各カードは一意の ID に関連付けられています。CardWithId オブジェクトを作成して、このメソッドで使用する必要があります。

const cardSection = CardService.newCardSection();
cardSection.addWidget(
    CardService.newTextParagraph().setText('This is a text paragraph widget.'));

const card = CardService.newCardBuilder()
    .setHeader(CardService.newCardHeader().setTitle('Card title'))
    .addSection(cardSection)
    .build();

const cardWithId = CardService.newCardWithId()
    .setCardId('card_id')
    .setCard(card);

const chatResponse = CardService.newChatResponseBuilder()
    .addCardsV2(cardWithId)
    .build();

パラメータ

名前	型	説明
cardWithId	CardWithId	使用する CardWithId。

リターン

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

---

build()

現在のアクション レスポンスを作成して検証します。

リターン

ChatResponse - 検証済みの ChatResponse。

---

setActionResponse(actionResponse)

メッセージのアクション レスポンス フィールドを設定します。

// Build the card.
const card = CardService.newCardBuilder()
    .setHeader(CardService.newCardHeader().setTitle('card title')).build();

// Creates the dialog.
const dialog = CardService.newDialog()
    .setBody(card);

// Creates the dialog action.
const dialogAction = CardService.newDialogAction()
   .setDialog(dialog)

// Creates the action response and sets the type to DIALOG.
const actionResponse = CardService.newChatActionResponse()
       .setDialogAction(dialogAction).setResponseType(CardService.Type.DIALOG);

// Creates the Chat response and sets the action response.
const chatResponse = CardService.newChatResponseBuilder()
       .setActionResponse(actionResponse)
    .build();

パラメータ

名前	型	説明
actionResponse	ChatActionResponse	使用する ChatActionResponse。

リターン

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

---

setText(text)

Chat メッセージのテキストを設定します。

const chatResponse = CardService.newChatResponseBuilder()
       .setText('Example text')
    .build();

パラメータ

名前	型	説明
text	String	使用するテキスト。

リターン

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