Class ChatResponse
Stay organized with collections
Save and categorize content based on your preferences.
ChatResponse
The response object for a card message in Google Chat.
Only available for Google Chat apps. Not available for Google Workspace add-ons.
// Creates a card message in Chat.
const cardHeader = CardService.newCardHeader()
.setTitle('Card Header Title')
.setSubtitle('Card Header Subtitle');
const card = CardService.newCardBuilder().setHeader(cardHeader).build();
const chatResponse =
CardService.newChatResponseBuilder()
.setText('Example text')
.addCardsV2(
CardService.newCardWithId().setCardId('card_id').setCard(card))
.build();
console.log(chatResponse.printJson());
Methods
| Method | Return type | Brief description |
printJson() | String | Prints the JSON representation of this object. |
Detailed documentation
printJson()
Prints the JSON representation of this object. This is for debugging only.
Return
String
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-01-30 UTC.
[null,null,["Last updated 2025-01-30 UTC."],[[["\u003cp\u003e\u003ccode\u003eChatResponse\u003c/code\u003e is an object used for card messages specifically within Google Chat apps, not add-ons.\u003c/p\u003e\n"],["\u003cp\u003eIt facilitates building responses containing text and cards with customizable headers and content using methods like \u003ccode\u003eaddCardsV2()\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can utilize the \u003ccode\u003eprintJson()\u003c/code\u003e method to debug and view the JSON structure of the constructed response for verification.\u003c/p\u003e\n"]]],["The `ChatResponse` object, exclusive to Google Chat apps, facilitates the creation of card messages. It is not for Google Workspace add-ons. You can build card messages using methods like `newCardHeader()` and `newCardBuilder()`. `newChatResponseBuilder()` builds the ChatResponse by adding text and cards. `printJson()` outputs the JSON representation of the constructed `ChatResponse` object, for debugging purposes.\n"],null,["# Class ChatResponse\n\nChatResponse\n\nThe response object for a card message in Google Chat.\n\nOnly available for Google Chat apps. Not available for Google Workspace add-ons.\n\n```javascript\n// Creates a card message in Chat.\nconst cardHeader = CardService.newCardHeader()\n .setTitle('Card Header Title')\n .setSubtitle('Card Header Subtitle');\n\nconst card = CardService.newCardBuilder().setHeader(cardHeader).build();\n\nconst chatResponse =\n CardService.newChatResponseBuilder()\n .setText('Example text')\n .addCardsV2(\n CardService.newCardWithId().setCardId('card_id').setCard(card))\n .build();\n\nconsole.log(chatResponse.printJson());\n``` \n\n### Methods\n\n| Method | Return type | Brief description |\n|-----------------------------|-------------|------------------------------------------------|\n| [printJson()](#printJson()) | `String` | Prints the JSON representation of this object. |\n\nDetailed documentation\n----------------------\n\n### `print``Json()`\n\nPrints the JSON representation of this object. This is for debugging only.\n\n#### Return\n\n\n`String`"]]
