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

メソッド

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

詳細なドキュメント

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

パラメータ

名前型説明
cardWithIdCardWithId使用する 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();

パラメータ

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

戻る

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

setText(text)

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

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

パラメータ

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

戻る

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