Class HostAppDataSource

  • HostAppDataSource is used with SelectionInput widgets in multiselect menus to populate items from a Google Workspace application data source.

  • This feature is exclusively available for Google Chat apps and cannot be used with Google Workspace add-ons.

  • The setChatDataSource method allows setting the data source from Google Chat.
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 and Google Workspace add-ons that extend flows. Not available for other Google Workspace add-ons.

Methods

MethodReturn typeBrief description
setChatDataSource(chatClientDataSource)HostAppDataSourceSets the data source from Google Chat.
setWorkflowDataSource(workflowDataSource)HostAppDataSourceSets the data source from Google Workspace Flows.

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

NameTypeDescription
chatClientDataSourceChatClientDataSourceThe data source to be set.

Return

HostAppDataSource — This object, for chaining.

setWorkflowDataSource(workflowDataSource)

Sets the data source from Google Workspace Flows.

Only available through the Gemini Alpha program for Google Workspace add-ons that extend Google Workspace Flows. 

const workflowDataSource =
    CardService.newWorkflowDataSource().setIncludeVariables(true);

const hostAppDataSource =
    CardService.newHostAppDataSource().setWorkflowDataSource(workflowDataSource);

Parameters

NameTypeDescription
workflowDataSourceWorkflowDataSourceThe data source to be set.

Return

HostAppDataSource — This object, for chaining.