Class HostAppDataSource
Stay organized with collections
Save and categorize content based on your preferences.
HostAppDataSource
For a SelectionInput widget that uses a multiselect menu, a data source from a Google
Workspace application. The data source populates selection items for the multiselect menu.
const chatSpaceDataSource =
CardService.newChatSpaceDataSource().setDefaultToCurrentSpace(true);
const chatClientDataSource =
CardService.newChatClientDataSource().setSpaceDataSource(
chatSpaceDataSource);
const hostAppDataSource =
CardService.newHostAppDataSource().setChatDataSource(chatClientDataSource);
Only available for Google Chat apps. Not available for Google Workspace add-ons.
Detailed documentation
setChatDataSource(chatClientDataSource)
Sets the data source from Google Chat.
const chatSpaceDataSource =
CardService.newChatSpaceDataSource().setDefaultToCurrentSpace(true);
const chatClientDataSource =
CardService.newChatClientDataSource().setSpaceDataSource(
chatSpaceDataSource);
const hostAppDataSource =
CardService.newHostAppDataSource().setChatDataSource(chatClientDataSource);
Only available for Google Chat apps. Not available for Google Workspace add-ons.
Parameters
Return
HostAppDataSource — This object, for chaining.
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\u003eHostAppDataSource\u003c/code\u003e is used for populating selection items in a multiselect menu within a Google Chat app.\u003c/p\u003e\n"],["\u003cp\u003eIt leverages a data source from Google Chat, configured using \u003ccode\u003eChatClientDataSource\u003c/code\u003e and \u003ccode\u003eChatSpaceDataSource\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThis functionality is exclusive to Google Chat apps and is not available for Google Workspace Add-ons.\u003c/p\u003e\n"],["\u003cp\u003eThe key method is \u003ccode\u003esetChatDataSource()\u003c/code\u003e, used for setting the Google Chat data source.\u003c/p\u003e\n"]]],["`HostAppDataSource` provides a data source for multiselect menus in Google Chat apps, using `SelectionInput`. It's created via `CardService.newHostAppDataSource()`. `setChatDataSource()` is used to specify the data source, which must be a `ChatClientDataSource`. In turn, `ChatClientDataSource` is configured with a `ChatSpaceDataSource`. Only available for Chat apps, it sets the data source for populating selection items within the menu, and returns the current `HostAppDataSource` object.\n"],null,["# Class HostAppDataSource\n\nHostAppDataSource\n\nFor a [SelectionInput](/apps-script/reference/card-service/selection-input) widget that uses a multiselect menu, a data source from a Google\nWorkspace application. The data source populates selection items for the multiselect menu.\n\n```javascript\nconst chatSpaceDataSource =\n CardService.newChatSpaceDataSource().setDefaultToCurrentSpace(true);\n\nconst chatClientDataSource =\n CardService.newChatClientDataSource().setSpaceDataSource(\n chatSpaceDataSource);\n\nconst hostAppDataSource =\n CardService.newHostAppDataSource().setChatDataSource(chatClientDataSource);\n```\n\nOnly available for Google Chat apps. Not available for Google Workspace add-ons. \n\n### Methods\n\n| Method | Return type | Brief description |\n|-------------------------------------------------------------------------------------|------------------------|----------------------------------------|\n| [setChatDataSource(chatClientDataSource)](#setChatDataSource(ChatClientDataSource)) | [HostAppDataSource](#) | Sets the data source from Google Chat. |\n\nDetailed documentation\n----------------------\n\n### `set``Chat``Data``Source(chatClientDataSource)`\n\nSets the data source from Google Chat.\n\n```javascript\nconst chatSpaceDataSource =\n CardService.newChatSpaceDataSource().setDefaultToCurrentSpace(true);\n\nconst chatClientDataSource =\n CardService.newChatClientDataSource().setSpaceDataSource(\n chatSpaceDataSource);\n\nconst hostAppDataSource =\n CardService.newHostAppDataSource().setChatDataSource(chatClientDataSource);\n```\nOnly available for Google Chat apps. Not available for Google Workspace add-ons.\n\n#### Parameters\n\n| Name | Type | Description |\n|------------------------------|-------------------------------------------------------------------------------------|----------------------------|\n| `chat``Client``Data``Source` | [ChatClientDataSource](/apps-script/reference/card-service/chat-client-data-source) | The data source to be set. |\n\n#### Return\n\n\n[HostAppDataSource](#) --- This object, for chaining."]]
