Nesta página, explicamos como adicionar widgets e elementos da interface a mensagens de cards ou caixas de diálogo para que os usuários possam interagir com seu app do Google Chat, como clicar em um botão ou enviar informações.
Use o Card Builder para criar e visualizar mensagens de cards JSON para apps do Chat:
Abrir o Card BuilderPré-requisitos
Adicionar um botão
O
widget ButtonList
mostra um conjunto de botões. Os botões podem exibir texto,
um ícone ou texto e ícone. Cada
Button
oferece suporte a uma
ação OnClick
que ocorre quando os usuários clicam no botão. Exemplo:
- Abra um hiperlink com
OpenLinkpara fornecer mais informações aos usuários. - Execute um
actionque execute uma função personalizada, como chamar uma API.
Para acessibilidade, os botões oferecem suporte a texto alternativo.
Adicionar um botão que execute uma função personalizada
Confira abaixo um card que consiste em um widget ButtonList com dois botões.
Um botão abre a documentação do desenvolvedor do Google Chat em uma nova guia. O
outro botão executa uma função personalizada chamada goToView() e transmite o
parâmetro viewType="BIRD EYE VIEW".
Adicionar um botão com cor personalizada e um botão desativado
Para impedir que os usuários cliquem em um botão, defina "disabled": "true".
O exemplo abaixo mostra um card que consiste em um widget ButtonList com dois
botões. Um deles usa o
campo Color
para personalizar a cor do plano de fundo
dele. O outro botão é desativado com o campo Disabled, que
impede que o usuário clique nele e execute a função.
Adicionar um botão com um ícone
O exemplo abaixo mostra um card que consiste em um widget ButtonList com dois widgets
Button de ícone. Um botão usa o campo
knownIcon
para mostrar o ícone de e-mail integrado do Google Chat. O outro usa o campo
iconUrl para mostrar um
widget de ícone personalizado.
Adicionar um botão com ícone e texto
Veja a seguir um card que consiste em um widget ButtonList que solicita que o usuário envie um e-mail. O primeiro botão exibe um ícone de e-mail, e o
segundo, texto. O usuário pode clicar no ícone ou no botão de texto
para executar a função sendEmail.
Adicionar elementos selecionáveis de interface
O widget SelectionInput
oferece um conjunto de itens selecionáveis, como caixas de seleção, botões de opção, chaves
ou um menu suspenso. É possível usar esse widget
para coletar dados definidos e padronizados dos usuários. Para coletar dados indefinidos
de usuários, use o widget TextInput.
O widget SelectionInput oferece suporte a sugestões, que ajudam os usuários a inserir dados
uniformes, e ações quando há mudança, que são
Actions
executadas quando ocorre uma mudança em um campo de entrada de seleção, como quando um usuário
seleciona ou desmarca um item.
Os apps de chat podem receber e processar o valor de itens selecionados. Para detalhes sobre como trabalhar com entradas de formulário, consulte Receber dados de formulários.
Esta seção fornece exemplos de cards que usam o widget SelectionInput.
Os exemplos usam diferentes tipos de entradas de seção:
Adicionar uma caixa de seleção
Veja a seguir uma caixa de diálogo que solicita que o usuário especifique se um
contato é profissional, pessoal ou ambos, com um widget SelectionInput que
usa caixas de seleção:
Adicionar um botão de opção
O código abaixo mostra uma caixa de diálogo que solicita que o usuário especifique se um
contato é profissional ou pessoal com um widget SelectionInput que usa
botões de opção:
Adicionar uma chave
Veja a seguir uma caixa de diálogo que solicita que o usuário especifique se um
contato é profissional, pessoal ou ambos com um widget SelectionInput que
usa chaves:
Adicionar um menu suspenso
Veja a seguir uma caixa de diálogo que solicita que o usuário especifique se um
contato é profissional ou pessoal com um widget SelectionInput que usa
um menu suspenso:
Adicionar um menu de seleção múltipla
O exemplo a seguir mostra uma caixa de diálogo que solicita que o usuário selecione contatos em um menu de seleção múltipla:
Usar fontes de dados para menus de seleção múltipla
Na seção a seguir, explicamos como usar menus de seleção múltipla para preencher dados de fontes dinâmicas, como um aplicativo do Google Workspace ou uma fonte de dados externa.
Fontes de dados do Google Workspace
É possível preencher itens para um menu de seleção múltipla das seguintes fontes de dados no Google Workspace:
- Usuários do Google Workspace: só é possível preencher usuários na mesma organização do Google Workspace.
- Espaços do Chat: o usuário que insere itens no menu de seleção múltipla só pode ler e selecionar espaços a que pertence à organização do Google Workspace.
Para usar fontes de dados do Google Workspace, especifique o
campo
platformDataSource. Ao contrário de outros tipos de entrada de seleção, você omite
objetos SectionItem
porque esses itens de seleção são provenientes dinamicamente do
Google Workspace.
O código a seguir mostra um menu de seleção múltipla de usuários do Google Workspace.
Para preencher usuários, a entrada de seleção define commonDataSource como USER:
JSON
{
"selectionInput": {
"name": "contacts",
"type": "MULTI_SELECT",
"label": "Selected contacts",
"multiSelectMaxSelectedItems": 5,
"multiSelectMinQueryLength": 1,
"platformDataSource": {
"commonDataSource": "USER"
}
}
}
O código a seguir mostra um menu de seleção múltipla de espaços do
Chat. Para preencher espaços, a entrada de seleção especifica o
campo hostAppDataSource. O menu de seleção múltipla também define
defaultToCurrentSpace como true, o que torna o espaço atual a seleção
padrão no menu:
JSON
{
"selectionInput": {
"name": "spaces",
"type": "MULTI_SELECT",
"label": "Selected contacts",
"multiSelectMaxSelectedItems": 3,
"multiSelectMinQueryLength": 1,
"platformDataSource": {
"hostAppDataSource": {
"chatDataSource": {
"spaceDataSource": {
"defaultToCurrentSpace": true
}
}
}
}
}
}
Fontes de dados fora do Google Workspace
Os menus de seleção múltipla também podem preencher itens de uma fonte de dados externa ou de terceiros. Por exemplo, é possível usar menus de seleção múltipla para ajudar um usuário a selecionar de uma lista de leads de vendas de um sistema de gestão de relacionamento com o cliente (CRM).
Para usar uma fonte de dados externa, use o campo externalDataSource para especificar uma função que retorna itens da fonte de dados.
Para reduzir as solicitações a uma fonte de dados externa, inclua
itens sugeridos que aparecem no menu de seleção múltipla antes que os usuários digitem
no menu. Por exemplo, você pode preencher contatos pesquisados recentemente para o usuário. Para preencher itens sugeridos em uma fonte de dados externa, especifique
objetos
SelectionItem.
O código abaixo mostra um menu de seleção múltipla de itens de um
conjunto externo de contatos para o usuário. O menu exibe um contato por padrão
e executa a função getContacts para recuperar e preencher itens da
fonte de dados externa:
JSON
{
"selectionInput": {
"name": "contacts",
"type": "MULTI_SELECT",
"label": "Selected contacts",
"multiSelectMaxSelectedItems": 5,
"multiSelectMinQueryLength": 2,
"externalDataSource": {
"function": "getContacts"
},
"items": [
{
"text": "Contact 3",
"value": "contact-3",
"startIconUri": "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
"bottomText": "Contact three description",
"selected": false
}
]
}
}
Para fontes de dados externas, também é possível preencher automaticamente itens que os usuários começam a digitar no menu de seleção múltipla. Por exemplo, se um usuário começar a digitar Atl em um
menu que preenche cidades nos Estados Unidos, o
app do Chat poderá sugerir automaticamente Atlanta antes que o
usuário termine de digitar. Você pode preencher automaticamente até 100 itens.
Para preencher automaticamente os itens, crie uma função que consulta a fonte de dados externa e retorna itens sempre que um usuário digita no menu de seleção múltipla. A função precisa fazer o seguinte:
- Transmita um objeto de evento que represente a interação do usuário com o menu.
- Identifique se o valor
invokedFunctiondo evento de interação corresponde à função do campoexternalDataSource. - Quando as funções corresponderem, retorne itens sugeridos da fonte de dados
externa. Para sugerir itens com base no que o usuário digita, acesse o valor da
chave
autocomplete_widget_query. Esse valor representa o que o usuário digita no menu.
O código a seguir preenche automaticamente itens de um recurso de dados externo. Usando o
exemplo anterior, o app do Chat sugere itens com base
no momento em que a função getContacts é acionada:
Apps Script
Node.js
Adicionar um campo em que o usuário pode inserir texto
O widget TextInput
fornece um campo em que os usuários podem inserir texto. O
widget oferece suporte a sugestões, que ajudam os usuários a inserir dados uniformes, e ações
ao mudar, que são
Actions
executadas quando ocorre uma mudança no campo de entrada de texto, como quando um usuário adiciona ou
exclui texto.
Quando precisar coletar dados abstratos ou desconhecidos dos usuários, use este
widget TextInput. Para coletar dados definidos dos usuários, use o widget
SelectionInput.
Para processar o texto inserido pelos usuários, consulte Receber dados do formulário.
Confira abaixo um card que consiste em um widget TextInput:
Permitir que o usuário escolha uma data e hora
O
widget DateTimePicker
permite que os usuários insiram uma data, uma hora ou ambos. Os usuários também podem usar o seletor para selecionar datas e horários. Se os usuários inserirem
uma data ou hora inválida, o seletor mostrará um erro solicitando que eles insiram
as informações corretamente.
Para processar os valores de data e hora inseridos pelos usuários, consulte Receber dados do formulário.
Confira abaixo um card que consiste em três tipos diferentes de
widgets DateTimePicker:
Validar dados inseridos em cartões
Esta página explica como validar dados inseridos no action
e nos widgets de um card.
Por exemplo, é possível validar se um campo de entrada de texto tem um texto inserido pelo
usuário ou se ele contém um determinado número de caracteres.
Definir os widgets necessários para ações
Como parte do action do card,
adicione nomes de widgets necessários para uma ação à lista requiredWidgets.
Se algum widget listado aqui não tiver um valor quando essa ação for invocada, o envio da ação do formulário será cancelado.
Quando "all_widgets_are_required": "true" é definido para uma ação, todos os widgets
no card são exigidos por essa ação.
Definir uma ação all_widgets_are_required em seleção múltipla
JSON
{
"sections": [
{
"header": "Select contacts",
"widgets": [
{
"selectionInput": {
"type": "MULTI_SELECT",
"label": "Selected contacts",
"name": "contacts",
"multiSelectMaxSelectedItems": 3,
"multiSelectMinQueryLength": 1,
"onChangeAction": {
"all_widgets_are_required": true
},
"items": [
{
"value": "contact-1",
"startIconUri": "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
"text": "Contact 1",
"bottomText": "Contact one description",
"selected": false
},
{
"value": "contact-2",
"startIconUri": "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
"text": "Contact 2",
"bottomText": "Contact two description",
"selected": false
},
{
"value": "contact-3",
"startIconUri": "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
"text": "Contact 3",
"bottomText": "Contact three description",
"selected": false
},
{
"value": "contact-4",
"startIconUri": "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
"text": "Contact 4",
"bottomText": "Contact four description",
"selected": false
},
{
"value": "contact-5",
"startIconUri": "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
"text": "Contact 5",
"bottomText": "Contact five description",
"selected": false
}
]
}
}
]
}
]
}
Definir uma ação all_widgets_are_required em dateTimePicker
JSON
{
"sections": [
{
"widgets": [
{
"textParagraph": {
"text": "A datetime picker widget with both date and time:"
}
},
{
"divider": {}
},
{
"dateTimePicker": {
"name": "date_time_picker_date_and_time",
"label": "meeting",
"type": "DATE_AND_TIME"
}
},
{
"textParagraph": {
"text": "A datetime picker widget with just date:"
}
},
{
"divider": {}
},
{
"dateTimePicker": {
"name": "date_time_picker_date_only",
"label": "Choose a date",
"type": "DATE_ONLY",
"onChangeAction":{
"all_widgets_are_required": true
}
}
},
{
"textParagraph": {
"text": "A datetime picker widget with just time:"
}
},
{
"divider": {}
},
{
"dateTimePicker": {
"name": "date_time_picker_time_only",
"label": "Select a time",
"type": "TIME_ONLY"
}
}
]
}
]
}
Defina uma ação all_widgets_are_required no menu suspenso
JSON
{
"sections": [
{
"header": "Section Header",
"collapsible": true,
"uncollapsibleWidgetsCount": 1,
"widgets": [
{
"selectionInput": {
"name": "location",
"label": "Select Color",
"type": "DROPDOWN",
"onChangeAction": {
"all_widgets_are_required": true
},
"items": [
{
"text": "Red",
"value": "red",
"selected": false
},
{
"text": "Green",
"value": "green",
"selected": false
},
{
"text": "White",
"value": "white",
"selected": false
},
{
"text": "Blue",
"value": "blue",
"selected": false
},
{
"text": "Black",
"value": "black",
"selected": false
}
]
}
}
]
}
]
}
Definir a validação de um widget de entrada de texto
No campo de validação do widget textInput, ele pode especificar o limite de caracteres e o tipo de entrada para
esse widget de entrada de texto.
Definir um limite de caracteres para um widget de entrada de texto
JSON
{
"sections": [
{
"header": "Tell us about yourself",
"collapsible": true,
"uncollapsibleWidgetsCount": 2,
"widgets": [
{
"textInput": {
"name": "favoriteColor",
"label": "Favorite color",
"type": "SINGLE_LINE",
"validation": {"character_limit":15},
"onChangeAction":{
"all_widgets_are_required": true
}
}
}
]
}
]
}
Definir o tipo de entrada para um widget de entrada de texto
JSON
{
"sections": [
{
"header": "Validate text inputs by input types",
"collapsible": true,
"uncollapsibleWidgetsCount": 2,
"widgets": [
{
"textInput": {
"name": "mailing_address",
"label": "Please enter a valid email address",
"type": "SINGLE_LINE",
"validation": {
"input_type": "EMAIL"
},
"onChangeAction": {
"all_widgets_are_required": true
}
}
},
{
"textInput": {
"name": "validate_integer",
"label": "Please enter a number",
"type": "SINGLE_LINE",
"validation": {
"input_type": "INTEGER"
}
}
},
{
"textInput": {
"name": "validate_float",
"label": "Please enter a number with a decimal",
"type": "SINGLE_LINE",
"validation": {
"input_type": "FLOAT"
}
}
}
]
}
]
}
Resolver problemas
Quando um app ou card do Google Chat retorna um erro, a interface do Chat mostra uma mensagem dizendo "Algo deu errado". ou "Não foi possível processar sua solicitação". Às vezes, a interface do Chat não exibe nenhuma mensagem de erro, mas o app ou card produz um resultado inesperado. Por exemplo, uma mensagem de card pode não aparecer.
Embora uma mensagem de erro possa não ser exibida na interface do Chat, mensagens de erro descritivas e dados de registro estão disponíveis para ajudar você a corrigir erros quando a geração de registros de erros para apps do Chat está ativada. Se precisar de ajuda para visualizar, depurar e corrigir erros, consulte Resolver problemas e corrigir erros do Google Chat.