Cards v2

Cartas

Uma interface de card exibida em uma mensagem do Google Chat ou em um complemento do Google Workspace.

Os cards oferecem suporte a um layout definido, elementos interativos da interface, como botões, e rich media, como imagens. Use cards para apresentar informações detalhadas, coletar informações dos usuários e orientá-los a seguir para a próxima etapa.

Crie e visualize cards com o Card Builder.

Abrir o Criador de cards

Para saber como criar cards, consulte a seguinte documentação:

• Para apps do Google Chat, consulte Projetar os componentes de um card ou uma caixa de diálogo.
• Para complementos do Google Workspace, consulte Interfaces baseadas em cards.

Observação: é possível adicionar até 100 widgets por card. Todos os widgets além desse limite são ignorados. Esse limite se aplica a mensagens de card e caixas de diálogo em apps do Google Chat, além de cards em complementos do Google Workspace.

Exemplo: mensagem de card para um app do Google Chat

Para criar a mensagem de card de exemplo no Google Chat, use o seguinte JSON:

{
  "cardsV2": [
    {
      "cardId": "unique-card-id",
      "card": {
        "header": {
           "title": "Sasha",
           "subtitle": "Software Engineer",
           "imageUrl":
           "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png",
           "imageType": "CIRCLE",
           "imageAltText": "Avatar for Sasha"
         },
         "sections": [
           {
             "header": "Contact Info",
             "collapsible": true,
             "uncollapsibleWidgetsCount": 1,
             "widgets": [
               {
                 "decoratedText": {
                   "startIcon": {
                     "knownIcon": "EMAIL"
                   },
                   "text": "[e-mail]"
                 }
               },
               {
                 "decoratedText": {
                   "startIcon": {
                     "knownIcon": "PERSON"
                   },
                   "text": "<font color=\"#80e27e\">Online</font>"
                 }
               },
               {
                 "decoratedText": {
                   "startIcon": {
                     "knownIcon": "PHONE"
                   },
                   "text": "[phone]"
                 }
               },
               {
                 "buttonList": {
                   "buttons": [
                     {
                       "text": "Share",
                       "onClick": {
                        "openLink": {
                           "url": "https://example.com/share"
                         }
                       }
                     },
                     {
                       "text": "Edit",
                       "onClick": {
                         "action": {
                           "function": "goToView",
                           "parameters": [
                             {
                               "key": "viewType",
                               "value": "EDIT"
                             }
                           ]
                         }
                       }
                     }
                   ]
                 }
               }
             ]
           }
         ]
       }
    }
  ]
}

Representação JSON
{ "header": { object (CardHeader) }, "sections": [ { object (Section) } ], "sectionDividerStyle": enum (DividerStyle), "cardActions": [ { object (CardAction) } ], "name": string, "fixedFooter": { object (CardFixedFooter) }, "displayStyle": enum (DisplayStyle), "peekCardHeader": { object (CardHeader) } }

Campos
header	object (CardHeader) O cabeçalho do card. Um cabeçalho geralmente contém uma imagem inicial e um título. Os cabeçalhos sempre aparecem na parte de cima de um card.
sections[]	object (Section) Contém uma coleção de widgets. Cada seção tem um cabeçalho opcional. As seções são separadas visualmente por um divisor de linha. Para um exemplo em apps do Google Chat, consulte Definir uma seção de um card.
sectionDividerStyle	enum (DividerStyle) O estilo do divisor entre o cabeçalho, as seções e o rodapé.
cardActions[]	object (CardAction) As ações do card. As ações são adicionadas ao menu da barra de ferramentas do card. Disponível para complementos do Google Workspace e não disponível para apps do Google Chat. Por exemplo, o JSON a seguir cria um menu de ações do card com as opções Settings e Send Feedback: "cardActions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ]
name	string Nome do card. Usado como um identificador de card na navegação por cards. Disponível para complementos do Google Workspace e não disponível para apps do Google Chat.
fixedFooter	object (CardFixedFooter) O rodapé fixo mostrado na parte de baixo deste card. Definir fixedFooter sem especificar um primaryButton ou um secondaryButton causa um erro. Para apps do Chat, você pode usar rodapés fixos em caixas de diálogo, mas não em mensagens de cards. Disponível para apps do Google Chat e complementos do Google Workspace.
displayStyle	enum (DisplayStyle) Nos complementos do Google Workspace, define as propriedades de exibição do peekCardHeader. Disponível para complementos do Google Workspace e não disponível para apps do Google Chat.
peekCardHeader	object (CardHeader) Ao mostrar conteúdo contextual, o cabeçalho do card de visualização funciona como um marcador de posição para que o usuário possa navegar entre os cards da página inicial e os contextuais. Disponível para complementos do Google Workspace e não disponível para apps do Google Chat.

CardHeader

Representa um cabeçalho de card. Para um exemplo em apps do Google Chat, consulte Adicionar um cabeçalho.

Disponível para apps do Google Chat e complementos do Google Workspace.

Representação JSON
{ "title": string, "subtitle": string, "imageType": enum (ImageType), "imageUrl": string, "imageAltText": string }

Campos
title	string Obrigatório. O título do cabeçalho do card. O cabeçalho tem uma altura fixa: se um título e um subtítulo forem especificados, cada um ocupará uma linha. Se apenas o título for especificado, ele vai ocupar as duas linhas.
subtitle	string O subtítulo do cabeçalho do card. Se especificado, aparece em uma linha separada abaixo do title.
imageType	enum (ImageType) A forma usada para cortar a imagem. Disponível para apps do Google Chat e complementos do Google Workspace.
imageUrl	string O URL HTTPS da imagem no cabeçalho do card.
imageAltText	string O texto alternativo da imagem usado para acessibilidade.

ImageType

A forma usada para cortar a imagem.

Disponível para apps do Google Chat e complementos do Google Workspace.

Enums
SQUARE	Valor padrão. Aplica uma máscara quadrada à imagem. Por exemplo, uma imagem 4:3 se torna 3:3.
CIRCLE	Aplica uma máscara circular à imagem. Por exemplo, uma imagem 4x3 se torna um círculo com um diâmetro de 3.

Seção

Uma seção contém uma coleção de widgets renderizados verticalmente na ordem em que são especificados.

Disponível para apps do Google Chat e complementos do Google Workspace.

Representação JSON
{ "header": string, "widgets": [ { object (Widget) } ], "collapsible": boolean, "uncollapsibleWidgetsCount": integer, "collapseControl": { object (CollapseControl) } }

Campos
header	string Texto que aparece na parte de cima de uma seção. Aceita texto formatado em HTML simples. Para mais informações sobre como formatar texto, consulte Formatar texto nos apps do Google Chat e Formatar texto nos complementos do Google Workspace.
widgets[]	object (Widget) Todos os widgets na seção. Precisa conter pelo menos um widget.
collapsible	boolean Indica se esta seção pode ser recolhida. As seções recolhíveis ocultam alguns ou todos os widgets, mas os usuários podem expandir a seção para revelar os widgets ocultos clicando em Mostrar mais. Para ocultar os widgets novamente, clique em Mostrar menos. Para determinar quais widgets estão ocultos, especifique uncollapsibleWidgetsCount.
uncollapsibleWidgetsCount	integer O número de widgets não recolhíveis que permanecem visíveis mesmo quando uma seção é recolhida. Por exemplo, quando uma seção contém cinco widgets e o uncollapsibleWidgetsCount está definido como 2, os dois primeiros widgets são sempre mostrados, e os três últimos são recolhidos por padrão. O uncollapsibleWidgetsCount é considerado somente quando collapsible é true.
collapseControl	object (CollapseControl) Opcional. Defina o botão de abrir e fechar da seção. Esse botão só vai aparecer se a seção puder ser recolhida. Se esse campo não estiver definido, o botão padrão será usado.

Widget

Cada card é composto por widgets.

Um widget é um objeto composto que pode representar um texto, imagens, botões e outros tipos de objetos.

Representação JSON

{ "horizontalAlignment": enum (HorizontalAlignment), // Union field data can be only one of the following: "textParagraph": { object (TextParagraph) }, "image": { object (Image) }, "decoratedText": { object (DecoratedText) }, "buttonList": { object (ButtonList) }, "textInput": { object (TextInput) }, "selectionInput": { object (SelectionInput) }, "dateTimePicker": { object (DateTimePicker) }, "divider": { object (Divider) }, "grid": { object (Grid) }, "columns": { object (Columns) }, "carousel": { object (Carousel) }, "chipList": { object (ChipList) } // End of list of possible types for union field data. }

Campos
horizontalAlignment	enum (HorizontalAlignment) Especifica se os widgets se alinham à esquerda, à direita ou ao centro de uma coluna.
Campo de união data. Um widget só pode ter um dos seguintes itens. É possível usar vários campos de widget para mostrar mais itens. data pode ser apenas um dos seguintes:
textParagraph	object (TextParagraph) Mostra um parágrafo de texto. Aceita texto formatado em HTML simples. Para mais informações sobre como formatar texto, consulte Formatar texto nos apps do Google Chat e Formatar texto nos complementos do Google Workspace. Por exemplo, o JSON a seguir cria um texto em negrito: "textParagraph": { "text": " <b>bold text</b>" }
image	object (Image) Mostra uma imagem. Por exemplo, o JSON a seguir cria uma imagem com texto alternativo: "image": { "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "altText": "Chat app avatar" }
decoratedText	object (DecoratedText) Mostra um item de texto decorado. Por exemplo, o JSON a seguir cria um widget de texto decorado que mostra o endereço de e-mail: "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "[e-mail]", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } }
buttonList	object (ButtonList) Uma lista de botões. Por exemplo, o JSON a seguir cria dois botões. O primeiro é um botão de texto azul, e o segundo é um botão de imagem que abre um link: "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] }
textInput	object (TextInput) Mostra uma caixa de texto em que os usuários podem digitar. Por exemplo, o JSON a seguir cria uma entrada de texto para um endereço de e-mail: "textInput": { "name": "mailing_address", "label": "Mailing Address" } Como outro exemplo, o JSON a seguir cria uma entrada de texto para uma linguagem de programação com sugestões estáticas: "textInput": { "name": "preferred_programing_language", "label": "Preferred Language", "initialSuggestions": { "items": [ { "text": "C++" }, { "text": "Java" }, { "text": "JavaScript" }, { "text": "Python" } ] } }
selectionInput	object (SelectionInput) Mostra um controle de seleção que permite aos usuários selecionar itens. Os controles de seleção podem ser caixas de seleção, botões de opção, chaves ou menus suspensos. Por exemplo, o JSON a seguir cria um menu suspenso que permite aos usuários escolher um tamanho: "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] }
dateTimePicker	object (DateTimePicker) Mostra um widget que permite aos usuários inserir uma data, um horário ou uma data e hora. Por exemplo, o JSON a seguir cria um seletor de data e hora para agendar um horário: "dateTimePicker": { "name": "appointment_time", "label": "Book your appointment at:", "type": "DATE_AND_TIME", "valueMsEpoch": 796435200000 }
divider	object (Divider) Mostra um divisor de linha horizontal entre widgets. Por exemplo, o JSON a seguir cria um divisor: "divider": { }
grid	object (Grid) Mostra uma grade com uma coleção de itens. Uma grade aceita qualquer número de colunas e itens. O número de linhas é determinado pelos limites superiores dos itens divididos pelo número de colunas. Uma grade com 10 itens e 2 colunas tem 5 linhas. Uma grade com 11 itens e 2 colunas tem 6 linhas. Disponível para apps do Google Chat e complementos do Google Workspace. Por exemplo, o JSON a seguir cria uma grade de duas colunas com um único item: "grid": { "title": "A fine collection of items", "columnCount": 2, "borderStyle": { "type": "STROKE", "cornerRadius": 4 }, "items": [ { "image": { "imageUri": "https://www.example.com/image.png", "cropStyle": { "type": "SQUARE" }, "borderStyle": { "type": "STROKE" } }, "title": "An item", "textAlignment": "CENTER" } ], "onClick": { "openLink": { "url": "https://www.example.com" } } }
columns	object (Columns) Mostra até duas colunas. Para incluir mais de duas colunas ou usar linhas, use o widget Grid. Por exemplo, o JSON a seguir cria duas colunas, cada uma contendo parágrafos de texto: "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] }
carousel	object (Carousel) Um carrossel contém uma coleção de widgets aninhados. Por exemplo, esta é uma representação JSON de um carrossel que contém dois parágrafos de texto. { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] }
chipList	object (ChipList) Uma lista de ícones. Por exemplo, o JSON a seguir cria duas opções. O primeiro é um ícone de texto, e o segundo é um ícone que abre um link: "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] }

TextParagraph

Um parágrafo de texto que aceita formatação. Para um exemplo em apps do Google Chat, consulte Adicionar um parágrafo de texto formatado. Para mais informações sobre como formatar texto, consulte Formatar texto nos apps do Google Chat e Formatar texto nos complementos do Google Workspace.

Disponível para apps do Google Chat e complementos do Google Workspace.

Representação JSON
{ "text": string, "maxLines": integer, "textSyntax": enum (TextSyntax) }

Campos
text	string O texto mostrado no widget.
maxLines	integer O número máximo de linhas de texto que são mostradas no widget. Se o texto exceder o número máximo de linhas especificado, o conteúdo extra será ocultado atrás de um botão Mostrar mais. Se o texto for igual ou menor que o número máximo de linhas especificado, um botão Mostrar mais não será exibido. O valor padrão é 0, em que todo o contexto é mostrado. Valores negativos são ignorados.
textSyntax	enum (TextSyntax) A sintaxe do texto. Se não for definido, o texto será renderizado como HTML. Prévia para desenvolvedores:disponível no Programa de prévia para desenvolvedores do Google Workspace, que concede acesso antecipado a determinados recursos. Disponível para apps do Google Chat e indisponível para complementos do Google Workspace.

TextSyntax

Sintaxe a ser usada para formatar texto.

Prévia para desenvolvedores:disponível no Programa de prévia para desenvolvedores do Google Workspace, que concede acesso antecipado a determinados recursos.

Disponível para apps do Google Chat e indisponível para complementos do Google Workspace.

Enums
TEXT_SYNTAX_UNSPECIFIED	O texto é renderizado como HTML se não for especificado.
HTML	O texto é renderizado como HTML. Esse é o valor padrão.
MARKDOWN	O texto é renderizado como Markdown.

Imagem

Uma imagem especificada por um URL que pode ter uma ação onClick. Para conferir um exemplo, consulte Adicionar uma imagem.

Disponível para apps do Google Chat e complementos do Google Workspace.

Representação JSON
{ "imageUrl": string, "onClick": { object (OnClick) }, "altText": string }

Campos
imageUrl	string O URL HTTPS que hospeda a imagem. Exemplo: https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png
onClick	object (OnClick) Quando um usuário clica na imagem, o clique aciona essa ação.
altText	string O texto alternativo da imagem usado para acessibilidade.

OnClick

Representa como responder quando os usuários clicam em um elemento interativo em um card, como um botão.

Disponível para apps do Google Chat e complementos do Google Workspace.

Representação JSON
{ // Union field data can be only one of the following: "action": { object (Action) }, "openLink": { object (OpenLink) }, "openDynamicLinkAction": { object (Action) }, "card": { object (Card) }, "overflowMenu": { object (OverflowMenu) } // End of list of possible types for union field data. }

Campos
Campo de união data. data pode ser apenas um dos seguintes:
action	object (Action) Se especificado, uma ação será acionada por este onClick.
openLink	object (OpenLink) Se especificado, esse onClick aciona uma ação de abrir link.
openDynamicLinkAction	object (Action) Um complemento aciona essa ação quando precisa abrir um link. Isso difere do openLink acima, já que precisa se comunicar com o servidor para receber o link. Assim, é necessário fazer algum trabalho de preparação para que o cliente da Web faça antes que a resposta da ação de abrir link seja retornada. Disponível para complementos do Google Workspace e não disponível para apps do Google Chat.
card	object (Card) Um novo card é enviado para a pilha após o clique, se especificado. Disponível para complementos do Google Workspace e não disponível para apps do Google Chat.
overflowMenu	object (OverflowMenu) Se especificado, onClick abre um menu flutuante.

Ação

Uma ação que descreve o comportamento quando o formulário é enviado. Por exemplo, você pode invocar um script do Apps Script para processar o formulário. Se a ação for acionada, os valores do formulário serão enviados ao servidor.

Disponível para apps do Google Chat e complementos do Google Workspace.

Representação JSON
{ "function": string, "parameters": [ { object (ActionParameter) } ], "loadIndicator": enum (LoadIndicator), "persistValues": boolean, "interaction": enum (Interaction), "requiredWidgets": [ string ], "allWidgetsAreRequired": boolean }

Campos
function	string Uma função personalizada a ser invocada quando o elemento contido for clicado ou ativado de outra forma. Para exemplos de uso, consulte Ler dados de formulário.
parameters[]	object (ActionParameter) Lista de parâmetros de ação.
loadIndicator	enum (LoadIndicator) Especifica o indicador de carregamento que a ação mostra ao fazer a chamada.
persistValues	boolean Indica se os valores do formulário permanecem após a ação. O valor padrão é false. Se true, os valores do formulário vão permanecer depois que a ação for acionada. Para permitir que o usuário faça mudanças enquanto a ação está sendo processada, defina LoadIndicator como NONE. Para mensagens de card em apps de chat, também é necessário definir o ResponseType da ação como UPDATE_MESSAGE e usar o mesmo cardId do card que continha a ação. Se false, os valores do formulário serão limpos quando a ação for acionada. Para impedir que o usuário faça mudanças enquanto a ação está sendo processada, defina LoadIndicator como SPINNER.
interaction	enum (Interaction) Opcional. Obrigatório ao abrir uma caixa de diálogo. O que fazer em resposta a uma interação com um usuário, como clicar em um botão em uma mensagem de card. Se não for especificado, o app vai responder executando um action (como abrir um link ou executar uma função) normalmente. Ao especificar um interaction, o app pode responder de maneiras interativas especiais. Por exemplo, ao definir interaction como OPEN_DIALOG, o app pode abrir uma caixa de diálogo. Quando especificado, um indicador de carregamento não é mostrado. Se especificado para um complemento, todo o card será removido e nada será mostrado no cliente. Disponível para apps do Google Chat e indisponível para complementos do Google Workspace.
requiredWidgets[]	string Opcional. Preencha esta lista com os nomes dos widgets que essa ação precisa para um envio válido. Se os widgets listados aqui não tiverem um valor quando essa ação for invocada, o envio do formulário será cancelado. Disponível para apps do Google Chat e complementos do Google Workspace.
allWidgetsAreRequired	boolean Opcional. Se for verdadeiro, todos os widgets serão considerados obrigatórios por essa ação. Disponível para apps do Google Chat e complementos do Google Workspace.

ActionParameter

Lista de parâmetros de string a serem fornecidos quando o método de ação é invocado. Por exemplo, considere três botões de adiamento: adiar agora, adiar por um dia ou adiar para a próxima semana. Você pode usar action method = snooze(), transmitindo o tipo e o tempo de adiamento na lista de parâmetros de string.

Para saber mais, consulte CommonEventObject.

Disponível para apps do Google Chat e complementos do Google Workspace.

Representação JSON
{ "key": string, "value": string }

Campos
key	string O nome do parâmetro para o script de ação.
value	string O valor do parâmetro.

LoadIndicator

Especifica o indicador de carregamento que a ação mostra ao fazer a chamada.

Disponível para apps do Google Chat e complementos do Google Workspace.

Enums
SPINNER	Mostra um ícone de carregamento para indicar que o conteúdo está sendo carregado.
NONE	Nada é exibido.

Interação

Opcional. Obrigatório ao abrir uma caixa de diálogo.

O que fazer em resposta a uma interação com um usuário, como clicar em um botão em uma mensagem de card.

Se não for especificado, o app vai responder executando um action (como abrir um link ou executar uma função) normalmente.

Ao especificar um interaction, o app pode responder de maneiras interativas especiais. Por exemplo, ao definir interaction como OPEN_DIALOG, o app pode abrir uma caixa de diálogo.

Quando especificado, um indicador de carregamento não é mostrado. Se especificado para um complemento, todo o card será removido e nada será mostrado no cliente.

Disponível para apps do Google Chat e indisponível para complementos do Google Workspace.

Enums
INTERACTION_UNSPECIFIED	Valor padrão. O action é executado normalmente.
OPEN_DIALOG	Abre uma caixa de diálogo, uma interface baseada em cards e janelas que os apps de chat usam para interagir com os usuários. Compatível apenas com apps de chat em resposta a cliques de botão em mensagens de card. Se especificado para um complemento, todo o card será removido e nada será mostrado no cliente. Disponível para apps do Google Chat e indisponível para complementos do Google Workspace.

OpenLink

Representa um evento onClick que abre um hiperlink.

Disponível para apps do Google Chat e complementos do Google Workspace.

Representação JSON
{ "url": string, "openAs": enum (OpenAs), "onClose": enum (OnClose) }

Campos
url	string O URL a ser aberto.
openAs	enum (OpenAs) Como abrir um link. Disponível para complementos do Google Workspace e não disponível para apps do Google Chat.
onClose	enum (OnClose) Se o cliente esquece um link depois de abri-lo ou o observa até que a janela seja fechada. Disponível para complementos do Google Workspace e não disponível para apps do Google Chat.

OpenAs

Quando uma ação OnClick abre um link, o cliente pode abri-lo como uma janela em tamanho real (se esse for o frame usado pelo cliente) ou uma sobreposição (como um pop-up). A implementação depende dos recursos da plataforma do cliente, e o valor selecionado pode ser ignorado se o cliente não o aceitar. FULL_SIZE é compatível com todos os clientes.

Disponível para complementos do Google Workspace e não disponível para apps do Google Chat.

Enums
FULL_SIZE	O link é aberto como uma janela em tamanho real (se esse for o frame usado pelo cliente).
OVERLAY	O link é aberto como uma sobreposição, como um pop-up.

OnClose

O que o cliente faz quando um link aberto por uma ação OnClick é fechado.

A implementação depende dos recursos da plataforma do cliente. Por exemplo, um navegador da Web pode abrir um link em uma janela pop-up com um manipulador de OnClose.

Se os manipuladores OnOpen e OnClose estiverem definidos, e a plataforma do cliente não puder aceitar os dois valores, OnClose terá precedência.

Disponível para complementos do Google Workspace e não disponível para apps do Google Chat.

Enums
NOTHING	Valor padrão. O card não é atualizado, e nada acontece.
RELOAD	Recarrega o card depois que a janela infantil é fechada. Se usado em conjunto com OpenAs.OVERLAY, a janela filha funciona como uma caixa de diálogo modal, e o card pai fica bloqueado até que a janela filha seja fechada.

OverflowMenu

Um widget que apresenta um menu pop-up com uma ou mais ações que os usuários podem invocar. Por exemplo, mostrar ações não principais em um card. Use esse widget quando as ações não cabem no espaço disponível. Para usar, especifique este widget na ação OnClick de widgets compatíveis. Por exemplo, em um Button.

Disponível para apps do Google Chat e complementos do Google Workspace.

Representação JSON
{ "items": [ { object (OverflowMenuItem) } ] }

Campos
items[]	object (OverflowMenuItem) Obrigatório. A lista de opções do menu.

OverflowMenuItem

Uma opção que os usuários podem invocar em um menu flutuante.

Disponível para apps do Google Chat e complementos do Google Workspace.

Representação JSON
{ "startIcon": { object (Icon) }, "text": string, "onClick": { object (OnClick) }, "disabled": boolean }

Campos
startIcon	object (Icon) O ícone exibido na frente do texto.
text	string Obrigatório. O texto que identifica ou descreve o item para os usuários.
onClick	object (OnClick) Obrigatório. A ação invocada quando uma opção de menu é selecionada. Esse OnClick não pode conter um OverflowMenu. Qualquer OverflowMenu especificado é descartado e o item de menu desativado.
disabled	boolean Se a opção de menu está desativada. O padrão é "false".

Ícone

Um ícone exibido em um widget em um card. Para ver um exemplo em apps do Google Chat, consulte Adicionar um ícone.

Compatível com ícones integrados e personalizados.

Disponível para apps do Google Chat e complementos do Google Workspace.

Representação JSON
{ "altText": string, "imageType": enum (ImageType), // Union field icons can be only one of the following: "knownIcon": string, "iconUrl": string, "materialIcon": { object (MaterialIcon) } // End of list of possible types for union field icons. }

Campos
altText	string Opcional. Uma descrição do ícone usado para acessibilidade. Se não for especificado, o valor padrão Button será fornecido. Como prática recomendada, defina uma descrição útil do que o ícone mostra e, se aplicável, do que ele faz. Por exemplo, A user's account portrait ou Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat. Se o ícone estiver definido em um Button, o altText vai aparecer como texto de ajuda quando o usuário passar o cursor sobre o botão. No entanto, se o botão também definir text, o altText do ícone será ignorado.
imageType	enum (ImageType) O estilo de corte aplicado à imagem. Em alguns casos, aplicar um corte CIRCLE faz com que a imagem seja desenhada maior do que um ícone integrado.
Campo de união icons. O ícone mostrado no widget do card. icons pode ser apenas um dos seguintes:
knownIcon	string Mostrar um dos ícones integrados fornecidos pelo Google Workspace. Por exemplo, para mostrar um ícone de avião, especifique AIRPLANE. Para um ônibus, especifique BUS. Para conferir uma lista completa de ícones compatíveis, consulte ícones integrados.
iconUrl	string Mostrar um ícone personalizado hospedado em um URL HTTPS. Exemplo: "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" Os tipos de arquivo aceitos são .png e .jpg.
materialIcon	object (MaterialIcon) Mostre um dos ícones do Google Material. Por exemplo, para mostrar um ícone de caixa de seleção, use "materialIcon": { "name": "check_box" } Disponível para apps do Google Chat e indisponível para complementos do Google Workspace.

MaterialIcon

Um ícone do Material do Google, que inclui mais de 2.500 opções.

Por exemplo, para mostrar um ícone de caixa de seleção com peso e gradiente personalizados, escreva o seguinte:

{
  "name": "check_box",
  "fill": true,
  "weight": 300,
  "grade": -25
}

Disponível para apps do Google Chat e indisponível para complementos do Google Workspace.

Representação JSON
{ "name": string, "fill": boolean, "weight": integer, "grade": integer }

Campos
name	string O nome do ícone definido no Google Material Icon, por exemplo, check_box. Nomes inválidos são abandonados e substituídos por uma string vazia, o que faz com que o ícone não seja renderizado.
fill	boolean Indica se o ícone é renderizado como preenchido. O valor padrão é “false”. Para visualizar diferentes configurações de ícones, acesse Ícones de fontes do Google e ajuste as configurações em Personalizar.
weight	integer A espessura do traço do ícone. Escolha entre {100, 200, 300, 400, 500, 600, 700}. Se ausente, o valor padrão é 400. Se qualquer outro valor for especificado, o valor padrão será usado. Para visualizar diferentes configurações de ícones, acesse Ícones de fontes do Google e ajuste as configurações em Personalizar.
grade	integer O peso e a gradação afetam a espessura de um símbolo. Os ajustes de gradação são mais detalhados do que os de peso e têm um pequeno impacto no tamanho do símbolo. Escolha entre {-25, 0, 200}. Se estiver ausente, o valor padrão será 0. Se qualquer outro valor for especificado, o valor padrão será usado. Para visualizar diferentes configurações de ícones, acesse Ícones de fontes do Google e ajuste as configurações em Personalizar.

DecoratedText

Um widget que mostra texto com decorações opcionais, como um rótulo acima ou abaixo do texto, um ícone na frente do texto, um widget de seleção ou um botão depois do texto. Para ver um exemplo nos apps do Google Chat, consulte Mostrar texto com texto decorativo.

Disponível para apps do Google Chat e complementos do Google Workspace.

Representação JSON

{ "icon": { object (Icon) }, "startIcon": { object (Icon) }, "startIconVerticalAlignment": enum (VerticalAlignment), "topLabel": string, "topLabelText": { object (TextParagraph) }, "text": string, "contentText": { object (TextParagraph) }, "wrapText": boolean, "bottomLabel": string, "bottomLabelText": { object (TextParagraph) }, "onClick": { object (OnClick) }, // Union field control can be only one of the following: "button": { object (Button) }, "switchControl": { object (SwitchControl) }, "endIcon": { object (Icon) } // End of list of possible types for union field control. }

Campos
icon (deprecated)	object (Icon) Este item está obsoleto. Descontinuado em favor de startIcon.
startIcon	object (Icon) O ícone exibido na frente do texto.
startIconVerticalAlignment	enum (VerticalAlignment) Opcional. Alinhamento vertical do ícone de início. Se não for definido, o ícone será centralizado verticalmente. Prévia para desenvolvedores:disponível no Programa de prévia para desenvolvedores do Google Workspace, que concede acesso antecipado a determinados recursos. Disponível para apps do Google Chat e indisponível para complementos do Google Workspace.
topLabel	string O texto que aparece acima de text. Sempre trunca.
topLabelText	object (TextParagraph) TextParagraph equivalente a topLabel. Sempre trunca. Permite uma formatação mais complexa do que topLabel. Prévia para desenvolvedores:disponível no Programa de prévia para desenvolvedores do Google Workspace, que concede acesso antecipado a determinados recursos. Disponível para apps do Google Chat e indisponível para complementos do Google Workspace.
text	string Obrigatório. O texto principal. Aceita formatação simples. Para mais informações sobre como formatar texto, consulte Formatar texto nos apps do Google Chat e Formatar texto nos complementos do Google Workspace.
contentText	object (TextParagraph) TextParagraph equivalente a text. Permite uma formatação mais complexa do que text. Prévia para desenvolvedores:disponível no Programa de prévia para desenvolvedores do Google Workspace, que concede acesso antecipado a determinados recursos. Disponível para apps do Google Chat e indisponível para complementos do Google Workspace.
wrapText	boolean A configuração de ajuste de texto. Se true, o texto será ajustado e exibido em várias linhas. Caso contrário, o texto será truncado. Aplica-se apenas a text, não a topLabel e bottomLabel.
bottomLabel	string O texto que aparece abaixo de text. Sempre quebra.
bottomLabelText	object (TextParagraph) TextParagraph equivalente a bottomLabel. Sempre quebra. Permite uma formatação mais complexa do que bottomLabel. Prévia para desenvolvedores:disponível no Programa de prévia para desenvolvedores do Google Workspace, que concede acesso antecipado a determinados recursos. Disponível para apps do Google Chat e indisponível para complementos do Google Workspace.
onClick	object (OnClick) Essa ação é acionada quando os usuários clicam em topLabel ou bottomLabel.
Campo de união control. Um botão, interruptor, caixa de seleção ou imagem que aparece à direita do texto no widget decoratedText. control pode ser apenas um dos seguintes:
button	object (Button) Um botão em que o usuário pode clicar para acionar uma ação.
switchControl	object (SwitchControl) Um widget de interruptor em que o usuário pode clicar para mudar o estado e acionar uma ação.
endIcon	object (Icon) Um ícone exibido após o texto. Compatível com ícones integrados e personalizados.

VerticalAlignment

Representa o atributo de alinhamento vertical.

Enums
VERTICAL_ALIGNMENT_UNSPECIFIED	Tipo não especificado. Não use.
TOP	Alinhamento com a posição superior.
MIDDLE	Alinhamento à posição média.
BOTTOM	Alinhamento com a posição inferior.

Botão

Um botão de texto, ícone ou texto e ícone em que os usuários podem clicar. Para ver um exemplo em apps do Google Chat, consulte Adicionar um botão.

Para transformar uma imagem em um botão clicável, especifique um Image (não um ImageComponent) e defina uma ação onClick.

Disponível para apps do Google Chat e complementos do Google Workspace.

Representação JSON
{ "text": string, "icon": { object (Icon) }, "color": { object (Color) }, "onClick": { object (OnClick) }, "disabled": boolean, "altText": string, "type": enum (Type) }

Campos
text	string O texto exibido dentro do botão.
icon	object (Icon) Um ícone exibido dentro do botão. Se icon e text forem definidos, o ícone vai aparecer antes do texto.
color	object (Color) Opcional. É a cor do botão. Se definido, o botão type será definido como FILLED e a cor dos campos text e icon será definida como uma cor contrastante para facilitar a leitura. Por exemplo, se a cor do botão for azul, qualquer texto ou ícone nele será branco. Para definir a cor do botão, especifique um valor para os campos red, green e blue. O valor precisa ser um número de ponto flutuante entre 0 e 1 com base no valor da cor RGB, em que 0 (0/255) representa a ausência de cor e 1 (255/255) representa a intensidade máxima da cor. Por exemplo, o comando a seguir define a cor como vermelho na intensidade máxima: "color": { "red": 1, "green": 0, "blue": 0, } O campo alpha não está disponível para a cor do botão. Se especificado, esse campo será ignorado.
onClick	object (OnClick) Obrigatório. A ação a ser realizada quando um usuário clica no botão, como abrir um hiperlink ou executar uma função personalizada.
disabled	boolean Se true, o botão será mostrado em um estado inativo e não vai responder às ações do usuário.
altText	string O texto alternativo usado para acessibilidade. Defina um texto descritivo que informe aos usuários o que o botão faz. Por exemplo, se um botão abrir um hiperlink, você pode escrever: "Abre uma nova guia do navegador e navega até a documentação para desenvolvedores do Google Chat em https://developers.google.com/workspace/chat".
type	enum (Type) Opcional. O tipo de um botão. Se não for definido, o tipo de botão será OUTLINED por padrão. Se o campo color estiver definido, o tipo de botão será forçado para FILLED e qualquer valor definido para esse campo será ignorado.

Cor

Representa uma cor no espaço de cores RGBA. Essa representação foi projetada para simplificar a conversão de e para representações de cores em vários idiomas, em vez de compactação. Por exemplo, os campos dessa representação podem ser fornecidos trivialmente ao construtor de java.awt.Color em Java. Também podem ser fornecidos trivialmente ao método +colorWithRed:green:blue:alpha do UIColor no iOS. Com um pouco de trabalho, é possível formatar facilmente em uma string rgba() CSS em JavaScript.

Esta página de referência não tem informações sobre o espaço de cores absoluto que precisa ser usado para interpretar o valor RGB. Por exemplo, sRGB, Adobe RGB, DCI-P3 e BT.2020. Por padrão, os aplicativos usam o espaço de cores sRGB.

Quando a igualdade de cores precisa ser decidida, as implementações, a menos que documentadas de outra forma, tratam duas cores como iguais se todos os valores de vermelho, verde, azul e alfa diferirem em no máximo 1e-5.

Exemplo (Java):

 import com.google.type.Color;

 // ...
 public static java.awt.Color fromProto(Color protocolor) {
   float alpha = protocolor.hasAlpha()
       ? protocolor.getAlpha().getValue()
       : 1.0;

   return new java.awt.Color(
       protocolor.getRed(),
       protocolor.getGreen(),
       protocolor.getBlue(),
       alpha);
 }

 public static Color toProto(java.awt.Color color) {
   float red = (float) color.getRed();
   float green = (float) color.getGreen();
   float blue = (float) color.getBlue();
   float denominator = 255.0;
   Color.Builder resultBuilder =
       Color
           .newBuilder()
           .setRed(red / denominator)
           .setGreen(green / denominator)
           .setBlue(blue / denominator);
   int alpha = color.getAlpha();
   if (alpha != 255) {
     result.setAlpha(
         FloatValue
             .newBuilder()
             .setValue(((float) alpha) / denominator)
             .build());
   }
   return resultBuilder.build();
 }
 // ...

Exemplo (iOS/Obj-C):

 // ...
 static UIColor* fromProto(Color* protocolor) {
    float red = [protocolor red];
    float green = [protocolor green];
    float blue = [protocolor blue];
    FloatValue* alpha_wrapper = [protocolor alpha];
    float alpha = 1.0;
    if (alpha_wrapper != nil) {
      alpha = [alpha_wrapper value];
    }
    return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
 }

 static Color* toProto(UIColor* color) {
     CGFloat red, green, blue, alpha;
     if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
       return nil;
     }
     Color* result = [[Color alloc] init];
     [result setRed:red];
     [result setGreen:green];
     [result setBlue:blue];
     if (alpha <= 0.9999) {
       [result setAlpha:floatWrapperWithValue(alpha)];
     }
     [result autorelease];
     return result;
}
// ...

Exemplo (JavaScript):

// ...

var protoToCssColor = function(rgb_color) {
   var redFrac = rgb_color.red || 0.0;
   var greenFrac = rgb_color.green || 0.0;
   var blueFrac = rgb_color.blue || 0.0;
   var red = Math.floor(redFrac * 255);
   var green = Math.floor(greenFrac * 255);
   var blue = Math.floor(blueFrac * 255);

   if (!('alpha' in rgb_color)) {
      return rgbToCssColor(red, green, blue);
   }

   var alphaFrac = rgb_color.alpha.value || 0.0;
   var rgbParams = [red, green, blue].join(',');
   return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
};

var rgbToCssColor = function(red, green, blue) {
  var rgbNumber = new Number((red << 16) | (green << 8) | blue);
  var hexString = rgbNumber.toString(16);
  var missingZeros = 6 - hexString.length;
  var resultBuilder = ['#'];
  for (var i = 0; i < missingZeros; i++) {
     resultBuilder.push('0');
  }
  resultBuilder.push(hexString);
  return resultBuilder.join('');
};

// ...

Representação JSON
{ "red": number, "green": number, "blue": number, "alpha": number }

Campos
red	number A quantidade de vermelho na cor como um valor no intervalo [0, 1].
green	number A quantidade de verde na cor como um valor no intervalo [0, 1].
blue	number A quantidade de azul na cor como um valor no intervalo [0, 1].
alpha	number A fração desta cor que deve ser aplicada ao pixel. Ou seja, a cor final do pixel é definida pela equação: pixel color = alpha * (this color) + (1.0 - alpha) * (background color) Isto significa que um valor de 1,0 corresponde a uma cor sólida, enquanto um valor de 0,0 corresponde a uma cor completamente transparente. Esse recurso usa uma mensagem de wrapper, em vez de um escalar flutuante simples, para que seja possível distinguir entre um valor padrão e o valor que está sendo desativado. Se omitido, esse objeto de cor será renderizado como uma cor sólida, como se o valor alfa fosse informado explicitamente com um valor de 1,0.

Tipo

Opcional. O tipo de um botão. Se o campo color estiver definido, o type será forçado a FILLED.

Disponível para apps do Google Chat e indisponível para complementos do Google Workspace.

Enums
TYPE_UNSPECIFIED	Não use. Não especificado.
OUTLINED	Os botões circunscritos são de ênfase média. Geralmente, eles contêm ações importantes, mas não são a principal ação em um app ou complemento do Chat.
FILLED	Um botão preenchido tem um contêiner com uma cor sólida. Ele tem o maior impacto visual e é recomendado para a ação principal e importante em um app do Chat ou complemento.
FILLED_TONAL	Um botão tonal preenchido é uma alternativa intermediária entre botões preenchidos e com contorno. Eles são úteis em contextos em que um botão de prioridade mais baixa precisa de um pouco mais de ênfase do que um botão de contorno.
BORDERLESS	Um botão não tem um contêiner invisível no estado padrão. Geralmente, ele é usado para ações de menor prioridade, principalmente ao apresentar várias opções.

SwitchControl

Um interruptor de alternância ou uma caixa de seleção dentro de um widget decoratedText.

Disponível para apps do Google Chat e complementos do Google Workspace.

Compatível apenas com o widget decoratedText.

Representação JSON
{ "name": string, "value": string, "selected": boolean, "onChangeAction": { object (Action) }, "controlType": enum (ControlType) }

Campos
name	string O nome pelo qual o widget de alternância é identificado em um evento de entrada de formulário. Para detalhes sobre como trabalhar com entradas de formulário, consulte Receber dados de formulário.
value	string O valor inserido por um usuário, retornado como parte de um evento de entrada de formulário. Para detalhes sobre como trabalhar com entradas de formulário, consulte Receber dados de formulário.
selected	boolean Quando true, o botão é selecionado.
onChangeAction	object (Action) A ação a ser realizada quando o estado do interruptor for alterado, como qual função executar.
controlType	enum (ControlType) Como a chave aparece na interface do usuário. Disponível para apps do Google Chat e complementos do Google Workspace.

ControlType

Como a chave aparece na interface do usuário.

Disponível para apps do Google Chat e complementos do Google Workspace.

Enums
SWITCH	Um botão de alternância.
CHECKBOX	Descontinuado em favor de CHECK_BOX.
CHECK_BOX	Uma caixa de seleção.

ButtonList

Uma lista de botões dispostos horizontalmente. Para ver um exemplo em apps do Google Chat, consulte Adicionar um botão.

Disponível para apps do Google Chat e complementos do Google Workspace.

Representação JSON
{ "buttons": [ { object (Button) } ] }

Campos
buttons[]	object (Button) Uma matriz de botões.

TextInput

Um campo em que os usuários podem inserir texto. Compatível com sugestões e ações de mudança. Aceita a validação de envio de formulários. Quando Action.all_widgets_are_required é definido como true ou este widget é especificado em Action.required_widgets, a ação de envio é bloqueada, a menos que um valor seja inserido. Para um exemplo em apps do Google Chat, consulte Adicionar um campo em que um usuário pode inserir texto.

Os apps de chat recebem e podem processar o valor do texto inserido durante eventos de entrada de formulário. Para detalhes sobre como trabalhar com entradas de formulário, consulte Receber dados de formulário.

Quando você precisar coletar dados indefinidos ou abstratos dos usuários, use uma entrada de texto. Para coletar dados definidos ou enumerados dos usuários, use o widget SelectionInput.

Disponível para apps do Google Chat e complementos do Google Workspace.

Representação JSON
{ "name": string, "label": string, "hintText": string, "value": string, "type": enum (Type), "onChangeAction": { object (Action) }, "initialSuggestions": { object (Suggestions) }, "autoCompleteAction": { object (Action) }, "validation": { object (Validation) }, "placeholderText": string }

Campos
name	string O nome pelo qual a entrada de texto é identificada em um evento de entrada de formulário. Para detalhes sobre como trabalhar com entradas de formulário, consulte Receber dados de formulário.
label	string O texto que aparece acima do campo de entrada de texto na interface do usuário. Especifique um texto que ajude o usuário a inserir as informações necessárias para o app. Por exemplo, se você estiver perguntando o nome de alguém, mas precisar especificamente do sobrenome, escreva surname em vez de name. Obrigatório se hintText não for especificado. Caso contrário, é opcional.
hintText	string Texto que aparece abaixo do campo de entrada de texto para ajudar os usuários, pedindo que eles insiram um determinado valor. Esse texto está sempre visível. Obrigatório se label não for especificado. Caso contrário, é opcional.
value	string O valor inserido por um usuário, retornado como parte de um evento de entrada de formulário. Para detalhes sobre como trabalhar com entradas de formulário, consulte Receber dados de formulário.
type	enum (Type) Como um campo de entrada de texto aparece na interface do usuário. Por exemplo, se o campo é de uma ou várias linhas.
onChangeAction	object (Action) O que fazer quando uma mudança ocorre no campo de entrada de texto. Por exemplo, um usuário adicionando ou excluindo texto no campo. Por exemplo, executar uma função personalizada ou abrir uma caixa de diálogo no Google Chat.
initialSuggestions	object (Suggestions) Valores sugeridos que os usuários podem inserir. Esses valores aparecem quando os usuários clicam dentro do campo de entrada de texto. À medida que os usuários digitam, os valores sugeridos são filtrados dinamicamente para corresponder ao que foi digitado. Por exemplo, um campo de entrada de texto para linguagem de programação pode sugerir Java, JavaScript, Python e C++. Quando os usuários começam a digitar Jav, a lista de sugestões é filtrada para mostrar apenas Java e JavaScript. Os valores sugeridos ajudam os usuários a inserir valores que seu app pode entender. Ao se referir a JavaScript, alguns usuários podem inserir javascript e outros java script. Sugerir JavaScript pode padronizar a forma como os usuários interagem com seu app. Quando especificado, TextInput.type é sempre SINGLE_LINE, mesmo que esteja definido como MULTIPLE_LINE. Disponível para apps do Google Chat e complementos do Google Workspace.
autoCompleteAction	object (Action) Opcional. Especifique a ação a ser realizada quando o campo de entrada de texto fornecer sugestões aos usuários que interagem com ele. Se não for especificado, as sugestões serão definidas por initialSuggestions e processadas pelo cliente. Se especificado, o app realiza a ação indicada aqui, como executar uma função personalizada. Disponível para complementos do Google Workspace e não disponível para apps do Google Chat.
validation	object (Validation) Especifique a validação de formato de entrada necessária para este campo de texto. Disponível para apps do Google Chat e complementos do Google Workspace.
placeholderText	string Texto que aparece no campo de entrada de texto quando ele está vazio. Use esse texto para pedir que os usuários insiram um valor. Por exemplo: Enter a number from 0 to 100 Disponível para apps do Google Chat e indisponível para complementos do Google Workspace.

Tipo

Como um campo de entrada de texto aparece na interface do usuário. Por exemplo, se é um campo de entrada de linha única ou de várias linhas. Se initialSuggestions for especificado, type será sempre SINGLE_LINE, mesmo que esteja definido como MULTIPLE_LINE.

Disponível para apps do Google Chat e complementos do Google Workspace.

Enums
SINGLE_LINE	O campo de entrada de texto tem uma altura fixa de uma linha.
MULTIPLE_LINE	O campo de entrada de texto tem uma altura fixa de várias linhas.

RenderActions

Um conjunto de instruções de renderização que dizem a um card para realizar uma ação ou dizem ao app host do complemento ou ao app Chat para realizar uma ação específica do app.

Disponível para apps do Google Chat e complementos do Google Workspace.

Campos
action	Action

Ação

Campos
navigations[]	Navigation Envia, abre ou atualiza um card. Complementos no Google Chat.

Navegação

Adicione um novo card à pilha (navegue para frente). Para apps do Chat, disponível apenas para a página inicial do app.

Disponível para apps do Google Chat e complementos do Google Workspace.

navigations: {
  pushCard: CARD
}

Substitua o card de cima por um novo. Para apps do Chat, disponível apenas para a página inicial do app.

Disponível para apps do Google Chat e complementos do Google Workspace.

navigations: {
  updateCard: CARD
}

Campos
Campo de união navigate_action. navigate_action pode ser apenas de um dos tipos a seguir:
pushCard	Card Envia um card para a pilha de cards. Para caixas de diálogo no Google Chat, abre ou atualiza uma caixa de diálogo.
updateCard	Card Atualiza o card superior com um novo card e preserva os valores dos campos do formulário preenchidos. Para um campo não equivalente, o valor é descartado. Para caixas de diálogo no Google Chat, abre ou atualiza uma caixa de diálogo.

Sugestões

Valores sugeridos que os usuários podem inserir. Esses valores aparecem quando os usuários clicam dentro do campo de entrada de texto. À medida que os usuários digitam, os valores sugeridos são filtrados dinamicamente para corresponder ao que foi digitado.

Por exemplo, um campo de entrada de texto para linguagem de programação pode sugerir Java, JavaScript, Python e C++. Quando os usuários começam a digitar Jav, a lista de sugestões é filtrada para mostrar Java e JavaScript.

Os valores sugeridos ajudam os usuários a inserir valores que seu app pode entender. Ao se referir a JavaScript, alguns usuários podem inserir javascript e outros java script. Sugerir JavaScript pode padronizar a forma como os usuários interagem com seu app.

Quando especificado, TextInput.type é sempre SINGLE_LINE, mesmo que esteja definido como MULTIPLE_LINE.

Disponível para apps do Google Chat e complementos do Google Workspace.

Representação JSON
{ "items": [ { object (SuggestionItem) } ] }

Campos
items[]	object (SuggestionItem) Uma lista de sugestões usadas para recomendações de preenchimento automático em campos de entrada de texto.

SuggestionItem

Um valor sugerido que os usuários podem inserir em um campo de entrada de texto.

Disponível para apps do Google Chat e complementos do Google Workspace.

Representação JSON
{ // Union field content can be only one of the following: "text": string // End of list of possible types for union field content. }

Campos
Campo de união content. content pode ser apenas um dos seguintes:
text	string O valor de uma entrada sugerida para um campo de entrada de texto. Isso é equivalente ao que os usuários inserem.

Validação

Representa os dados necessários para validar o widget a que está anexado.

Disponível para apps do Google Chat e complementos do Google Workspace.

Representação JSON
{ "characterLimit": integer, "inputType": enum (InputType) }

Campos
characterLimit	integer Especifique o limite de caracteres para widgets de entrada de texto. Isso só é usado para entrada de texto e é ignorado em outros widgets. Disponível para apps do Google Chat e complementos do Google Workspace.
inputType	enum (InputType) Especifique o tipo dos widgets de entrada. Disponível para apps do Google Chat e complementos do Google Workspace.

InputType

O tipo do widget de entrada.

Enums
INPUT_TYPE_UNSPECIFIED	Tipo não especificado. Não use.
TEXT	Texto normal que aceita todos os caracteres.
INTEGER	Um valor inteiro.
FLOAT	Um valor flutuante.
EMAIL	Um endereço de e-mail.
EMOJI_PICKER	Um emoji selecionado no seletor fornecido pelo sistema.

SelectionInput

Um widget que cria um ou mais itens de interface que os usuários podem selecionar. Compatível com a validação de envio de formulário apenas para os menus dropdown e multiselect. Quando Action.all_widgets_are_required é definido como true ou este widget é especificado em Action.required_widgets, a ação de envio é bloqueada, a menos que um valor seja selecionado. Por exemplo, um menu suspenso ou caixas de seleção. Use esse widget para coletar dados que podem ser previstos ou enumerados. Para ver um exemplo em apps do Google Chat, consulte Adicionar elementos de interface selecionáveis.

Os apps de chat podem processar o valor dos itens que os usuários selecionam ou inserem. Para detalhes sobre como trabalhar com entradas de formulário, consulte Receber dados de formulário.

Para coletar dados indefinidos ou abstratos dos usuários, use o widget TextInput.

Disponível para apps do Google Chat e complementos do Google Workspace.

Representação JSON

{ "name": string, "label": string, "type": enum (SelectionType), "items": [ { object (SelectionItem) } ], "onChangeAction": { object (Action) }, "multiSelectMaxSelectedItems": integer, "multiSelectMinQueryLength": integer, // Union field multi_select_data_source can be only one of the following: "externalDataSource": { object (Action) }, "platformDataSource": { object (PlatformDataSource) } // End of list of possible types for union field multi_select_data_source. }

Campos
name	string Obrigatório. O nome que identifica a entrada de seleção em um evento de entrada de formulário. Para detalhes sobre como trabalhar com entradas de formulário, consulte Receber dados de formulário.
label	string O texto que aparece acima do campo de entrada de seleção na interface do usuário. Especifique um texto que ajude o usuário a inserir as informações necessárias para o app. Por exemplo, se os usuários estiverem selecionando a urgência de um tíquete de trabalho em um menu suspenso, o rótulo poderá ser "Urgência" ou "Selecionar urgência".
type	enum (SelectionType) O tipo de itens exibidos aos usuários em um widget SelectionInput. Os tipos de seleção são compatíveis com diferentes tipos de interações. Por exemplo, os usuários podem marcar uma ou mais caixas de seleção, mas só podem selecionar um valor em um menu suspenso.
items[]	object (SelectionItem) Uma matriz de itens selecionáveis. Por exemplo, uma matriz de botões de opção ou caixas de seleção. Aceita até 100 itens.
onChangeAction	object (Action) Se especificado, o formulário será enviado quando a seleção mudar. Se não for especificado, você precisará definir um botão separado para enviar o formulário. Para detalhes sobre como trabalhar com entradas de formulário, consulte Receber dados de formulário.
multiSelectMaxSelectedItems	integer Para menus de seleção múltipla, o número máximo de itens que um usuário pode selecionar. O valor mínimo é 1 item. Se não for especificado, o padrão será 3 itens.
multiSelectMinQueryLength	integer Para menus de seleção múltipla, o número de caracteres de texto que um usuário insere antes que o menu retorne itens de seleção sugeridos. Se não estiver definido, o menu de seleção múltipla usará os seguintes valores padrão: Se o menu usar uma matriz estática de itens SelectionInput, o padrão será 0 caracteres, e os itens da matriz serão preenchidos imediatamente. Se o menu usar uma fonte de dados dinâmica ( multi_select_data_source), o padrão será de três caracteres antes de consultar a fonte de dados para retornar itens sugeridos.
Campo de união multi_select_data_source. Para um menu de seleção múltipla, uma fonte de dados que preenche dinamicamente os itens de seleção. Disponível para apps do Google Chat e indisponível para complementos do Google Workspace. multi_select_data_source pode ser apenas um dos seguintes:
externalDataSource	object (Action) Uma fonte de dados externa, como um banco de dados relacional.
platformDataSource	object (PlatformDataSource) Uma fonte de dados do Google Workspace.

SelectionType

O formato dos itens que os usuários podem selecionar. Cada opção é compatível com um tipo de interação. Por exemplo, os usuários podem marcar várias caixas de seleção, mas só podem escolher um item em um menu suspenso.

Cada entrada de seleção aceita um tipo de seleção. Não é possível misturar caixas de seleção e chaves, por exemplo.

Disponível para apps do Google Chat e complementos do Google Workspace.

Enums
CHECK_BOX	Um conjunto de caixas de seleção. Os usuários podem marcar uma ou mais caixas de seleção.
RADIO_BUTTON	Um conjunto de botões de opção. Os usuários podem selecionar um botão de opção.
SWITCH	Um conjunto de interruptores. Os usuários podem ativar uma ou mais chaves.
DROPDOWN	Um menu suspenso. Os usuários podem selecionar um item no menu.
MULTI_SELECT	Um menu com uma caixa de texto. Os usuários podem digitar e selecionar um ou mais itens. Para complementos do Google Workspace, você precisa preencher os itens usando uma matriz estática de objetos SelectionItem. Para apps do Google Chat, também é possível preencher itens usando uma fonte de dados dinâmica e sugestões automáticas enquanto os usuários digitam no menu. Por exemplo, os usuários podem começar a digitar o nome de um espaço do Google Chat, e o widget sugere automaticamente o espaço. Para preencher dinamicamente itens de um menu de seleção múltipla, use um dos seguintes tipos de fontes de dados: Dados do Google Workspace: os itens são preenchidos com dados do Google Workspace, como usuários ou espaços do Google Chat. Dados externos: os itens são preenchidos com base em uma fonte de dados externa fora do Google Workspace. Para ver exemplos de como implementar menus de seleção múltipla para apps do Chat, consulte Adicionar um menu de seleção múltipla. Disponível para apps do Google Chat e complementos do Google Workspace.

SelectionItem

Um item que os usuários podem selecionar em uma entrada de seleção, como uma caixa de seleção ou um botão de alternância. Aceita até 100 itens.

Disponível para apps do Google Chat e complementos do Google Workspace.

Representação JSON
{ "text": string, "value": string, "selected": boolean, "bottomText": string, // Union field start_icon can be only one of the following: "startIconUri": string // End of list of possible types for union field start_icon. }

Campos
text	string O texto que identifica ou descreve o item para os usuários.
value	string O valor associado a este item. O cliente deve usar isso como um valor de entrada de formulário. Para detalhes sobre como trabalhar com entradas de formulário, consulte Receber dados de formulário.
selected	boolean Se o item está selecionado por padrão. Se a entrada de seleção aceitar apenas um valor (como botões de opção ou um menu suspenso), defina esse campo para apenas um item.
bottomText	string Para menus de seleção múltipla, uma descrição ou um rótulo de texto exibido abaixo do campo text do item.
Campo de união start_icon. Para menus de seleção múltipla, o URL do ícone exibido ao lado do campo text do item. Compatível com arquivos PNG e JPEG. Precisa ser um URL HTTPS. Por exemplo, https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png. start_icon pode ser apenas um dos seguintes:
startIconUri	string

PlatformDataSource

Para um widget SelectionInput que usa um menu de seleção múltipla, uma fonte de dados do Google Workspace. Usado para preencher itens em um menu de seleção múltipla.

Disponível para apps do Google Chat e indisponível para complementos do Google Workspace.

Representação JSON
{ // Union field data_source can be only one of the following: "commonDataSource": enum (CommonDataSource), "hostAppDataSource": { object (HostAppDataSourceMarkup) } // End of list of possible types for union field data_source. }

Campos
Campo de união data_source. A fonte de dados. data_source pode ser apenas um dos seguintes:
commonDataSource	enum (CommonDataSource) Uma fonte de dados compartilhada por todos os aplicativos do Google Workspace, como usuários em uma organização do Google Workspace.
hostAppDataSource	object (HostAppDataSourceMarkup) Uma fonte de dados exclusiva de um aplicativo host do Google Workspace, como os espaços no Google Chat. Esse campo é compatível com as bibliotecas de cliente de APIs do Google, mas não está disponível nas bibliotecas de cliente do Cloud. Para saber mais, consulte Instalar as bibliotecas de cliente.

CommonDataSource

Uma fonte de dados compartilhada por todos os aplicativos do Google Workspace.

Disponível para apps do Google Chat e indisponível para complementos do Google Workspace.

Enums
UNKNOWN	Valor padrão. Não use.
USER	Usuários do Google Workspace. O usuário só pode ver e selecionar pessoas da organização do Google Workspace.

HostAppDataSourceMarkup

Para um widget SelectionInput que usa um menu de seleção múltipla, uma fonte de dados de um aplicativo do Google Workspace. A origem de dados preenche os itens de seleção do menu de seleção múltipla.

Disponível para apps do Google Chat e indisponível para complementos do Google Workspace.

Representação JSON
{ // Union field data_source can be only one of the following: "chatDataSource": { object (ChatClientDataSourceMarkup) } // End of list of possible types for union field data_source. }

Campos
Campo de união data_source. O aplicativo do Google Workspace que preenche itens para um menu de seleção múltipla. data_source pode ser apenas um dos seguintes:
chatDataSource	object (ChatClientDataSourceMarkup) Uma fonte de dados do Google Chat.

ChatClientDataSourceMarkup

Para um widget SelectionInput que usa um menu de seleção múltipla, uma fonte de dados do Google Chat. A origem de dados preenche os itens de seleção do menu de seleção múltipla. Por exemplo, um usuário pode selecionar os espaços do Google Chat de que participa.

Disponível para apps do Google Chat e indisponível para complementos do Google Workspace.

Representação JSON
{ // Union field source can be only one of the following: "spaceDataSource": { object (SpaceDataSource) } // End of list of possible types for union field source. }

Campos
Campo de união source. A fonte de dados do Google Chat. source pode ser apenas um dos seguintes:
spaceDataSource	object (SpaceDataSource) Espaços do Google Chat de que o usuário participa.

SpaceDataSource

Uma fonte de dados que preenche os espaços do Google Chat como itens de seleção para um menu de seleção múltipla. Preenche apenas os espaços de que o usuário é membro.

Disponível para apps do Google Chat e indisponível para complementos do Google Workspace.

Representação JSON
{ "defaultToCurrentSpace": boolean }

Campos
defaultToCurrentSpace	boolean Se definido como true, o menu de seleção múltipla vai selecionar o espaço atual do Google Chat como um item por padrão.

DateTimePicker

Permite que os usuários insiram uma data, um horário ou ambos. Aceita a validação de envio de formulários. Quando Action.all_widgets_are_required é definido como true ou este widget é especificado em Action.required_widgets, a ação de envio é bloqueada, a menos que um valor seja selecionado. Para um exemplo em apps do Google Chat, consulte Permitir que um usuário escolha uma data e hora.

Os usuários podem inserir texto ou usar o seletor para escolher datas e horários. Se os usuários inserirem uma data ou hora inválida, o seletor vai mostrar um erro que pede para eles inserirem as informações corretamente.

Disponível para apps do Google Chat e complementos do Google Workspace.

Representação JSON
{ "name": string, "label": string, "type": enum (DateTimePickerType), "valueMsEpoch": int64, "timezoneOffsetDate": integer, "onChangeAction": { object (Action) } }

Campos
name	string O nome pelo qual o DateTimePicker é identificado em um evento de entrada de formulário. Para detalhes sobre como trabalhar com entradas de formulário, consulte Receber dados de formulário.
label	string O texto que pede aos usuários para inserir uma data, um horário ou uma data e hora. Por exemplo, se os usuários estiverem agendando um horário, use um rótulo como Appointment date ou Appointment date and time.
type	enum (DateTimePickerType) Se o widget aceita entrada de uma data, um horário ou a data e a hora.
valueMsEpoch	int64 O valor padrão mostrado no widget, em milissegundos desde o tempo da época Unix. Especifique o valor com base no tipo de seletor ( DateTimePickerType): DATE_AND_TIME : uma data e hora do calendário em UTC. Por exemplo, para representar 1º de janeiro de 2023 às 12h UTC, use 1672574400000. DATE_ONLY : uma data de calendário às 00:00:00 UTC. Por exemplo, para representar 1º de janeiro de 2023, use 1672531200000. TIME_ONLY : um horário em UTC. Por exemplo, para representar 12:00 PM, use 43200000 (ou 12 * 60 * 60 * 1000).
timezoneOffsetDate	integer O número que representa o ajuste de fuso horário em relação ao UTC, em minutos. Se definido, o valueMsEpoch será mostrado no fuso horário especificado. Se não for definido, o valor padrão será a configuração de fuso horário do usuário.
onChangeAction	object (Action) Acionado quando o usuário clica em Salvar ou Limpar na interface DateTimePicker.

DateTimePickerType

O formato da data e da hora no widget DateTimePicker. Determina se os usuários podem inserir uma data, um horário ou ambos.

Disponível para apps do Google Chat e complementos do Google Workspace.

Enums
DATE_AND_TIME	Os usuários inserem uma data e hora.
DATE_ONLY	Os usuários inserem uma data.
TIME_ONLY	Os usuários inserem um horário.

Separador

Esse tipo não tem campos.

Mostra um divisor entre widgets como uma linha horizontal. Para um exemplo em apps do Google Chat, consulte Adicionar um divisor horizontal entre widgets.

Disponível para apps do Google Chat e complementos do Google Workspace.

Por exemplo, o JSON a seguir cria um divisor:

"divider": {}

Grade

Mostra uma grade com uma coleção de itens. Os itens só podem incluir texto ou imagens. Para colunas responsivas ou para incluir mais do que texto ou imagens, use Columns. Para ver um exemplo em apps do Google Chat, consulte Mostrar uma grade com uma coleção de itens.

Uma grade aceita qualquer número de colunas e itens. O número de linhas é determinado por itens divididos por colunas. Uma grade com 10 itens e 2 colunas tem 5 linhas. Uma grade com 11 itens e 2 colunas tem 6 linhas.

Disponível para apps do Google Chat e complementos do Google Workspace.

Por exemplo, o JSON a seguir cria uma grade de duas colunas com um único item:

"grid": {
  "title": "A fine collection of items",
  "columnCount": 2,
  "borderStyle": {
    "type": "STROKE",
    "cornerRadius": 4
  },
  "items": [
    {
      "image": {
        "imageUri": "https://www.example.com/image.png",
        "cropStyle": {
          "type": "SQUARE"
        },
        "borderStyle": {
          "type": "STROKE"
        }
      },
      "title": "An item",
      "textAlignment": "CENTER"
    }
  ],
  "onClick": {
    "openLink": {
      "url": "https://www.example.com"
    }
  }
}

Representação JSON
{ "title": string, "items": [ { object (GridItem) } ], "borderStyle": { object (BorderStyle) }, "columnCount": integer, "onClick": { object (OnClick) } }

Campos
title	string O texto que aparece no cabeçalho da grade.
items[]	object (GridItem) Os itens a serem mostrados na grade.
borderStyle	object (BorderStyle) O estilo de borda a ser aplicado a cada item da grade.
columnCount	integer O número de colunas a serem exibidas na grade. Um valor padrão será usado se este campo não for especificado, e esse valor padrão será diferente dependendo de onde a grade é mostrada (diálogo x complemento).
onClick	object (OnClick) Esse callback é reutilizado por cada item individual da grade, mas com o identificador e o índice do item na lista de itens adicionados aos parâmetros do callback.

GridItem

Representa um item em um layout de grade. Os itens podem conter texto, uma imagem ou ambos.

Disponível para apps do Google Chat e complementos do Google Workspace.

Representação JSON
{ "id": string, "image": { object (ImageComponent) }, "title": string, "subtitle": string, "layout": enum (GridItemLayout) }

Campos
id	string Um identificador especificado pelo usuário para este item da grade. Esse identificador é retornado nos parâmetros de callback onClick da grade principal.
image	object (ImageComponent) A imagem que aparece no item da grade.
title	string O título do item da grade.
subtitle	string O subtítulo do item da grade.
layout	enum (GridItemLayout) O layout a ser usado para o item da grade.

ImageComponent

Representa uma imagem.

Disponível para apps do Google Chat e complementos do Google Workspace.

Representação JSON
{ "imageUri": string, "altText": string, "cropStyle": { object (ImageCropStyle) }, "borderStyle": { object (BorderStyle) } }

Campos
imageUri	string O URL da imagem.
altText	string O rótulo de acessibilidade da imagem.
cropStyle	object (ImageCropStyle) O estilo de corte a ser aplicado à imagem.
borderStyle	object (BorderStyle) O estilo de borda a ser aplicado à imagem.

ImageCropStyle

Representa o estilo de corte aplicado a uma imagem.

Disponível para apps do Google Chat e complementos do Google Workspace.

Por exemplo, veja como aplicar uma proporção de 16:9:

cropStyle {
 "type": "RECTANGLE_CUSTOM",
 "aspectRatio": 16/9
}

Representação JSON
{ "type": enum (ImageCropType), "aspectRatio": number }

Campos
type	enum (ImageCropType) O tipo de corte.
aspectRatio	number A proporção a ser usada se o tipo de corte for RECTANGLE_CUSTOM. Por exemplo, veja como aplicar uma proporção de 16:9: cropStyle { "type": "RECTANGLE_CUSTOM", "aspectRatio": 16/9 }

ImageCropType

Representa o estilo de corte aplicado a uma imagem.

Disponível para apps do Google Chat e complementos do Google Workspace.

Enums
IMAGE_CROP_TYPE_UNSPECIFIED	Não use. Não especificado.
SQUARE	Valor padrão. Aplica um corte quadrado.
CIRCLE	Aplica um corte circular.
RECTANGLE_CUSTOM	Aplica um corte retangular com uma proporção personalizada. Defina a proporção personalizada com aspectRatio.
RECTANGLE_4_3	Aplica um corte retangular com uma proporção de 4:3.

BorderStyle

As opções de estilo para a borda de um card ou widget, incluindo o tipo e a cor da borda.

Disponível para apps do Google Chat e complementos do Google Workspace.

Representação JSON
{ "type": enum (BorderType), "strokeColor": { object (Color) }, "cornerRadius": integer }

Campos
type	enum (BorderType) O tipo de borda.
strokeColor	object (Color) As cores a serem usadas quando o tipo for BORDER_TYPE_STROKE. Para definir a cor do traço, especifique um valor para os campos red, green e blue. O valor precisa ser um número de ponto flutuante entre 0 e 1 com base no valor da cor RGB, em que 0 (0/255) representa a ausência de cor e 1 (255/255) representa a intensidade máxima da cor. Por exemplo, o comando a seguir define a cor como vermelho na intensidade máxima: "color": { "red": 1, "green": 0, "blue": 0, } O campo alpha não está disponível para a cor do traço. Se especificado, esse campo será ignorado.
cornerRadius	integer O raio do canto da borda.

BorderType

Representa os tipos de borda aplicados aos widgets.

Disponível para apps do Google Chat e complementos do Google Workspace.

Enums
BORDER_TYPE_UNSPECIFIED	Não use. Não especificado.
NO_BORDER	Sem borda.
STROKE	Valor padrão. Contorno.

GridItemLayout

Representa as várias opções de layout disponíveis para um item de grade.

Disponível para apps do Google Chat e complementos do Google Workspace.

Enums
GRID_ITEM_LAYOUT_UNSPECIFIED	Não use. Não especificado.
TEXT_BELOW	O título e o subtítulo são mostrados abaixo da imagem do item da grade.
TEXT_ABOVE	O título e o subtítulo são mostrados acima da imagem do item da grade.

Colunas

O widget Columns mostra até duas colunas em um card ou caixa de diálogo. É possível adicionar widgets a cada coluna. Eles aparecem na ordem em que são especificados. Para um exemplo nos apps do Google Chat, consulte Mostrar cards e caixas de diálogo em colunas.

A altura de cada coluna é determinada pela coluna mais alta. Por exemplo, se a primeira coluna for mais alta que a segunda, ambas terão a altura da primeira. Como cada coluna pode conter um número diferente de widgets, não é possível definir linhas nem alinhar widgets entre as colunas.

As colunas são mostradas lado a lado. É possível personalizar a largura de cada coluna usando o campo HorizontalSizeStyle. Se a largura da tela do usuário for muito estreita, a segunda coluna vai aparecer abaixo da primeira:

• Na Web, a segunda coluna é quebrada se a largura da tela for menor ou igual a 480 pixels.
• Em dispositivos iOS, a segunda coluna é quebrada se a largura da tela for menor ou igual a 300 pt.
• Em dispositivos Android, a segunda coluna é quebrada se a largura da tela for menor ou igual a 320 dp.

Para incluir mais de duas colunas ou usar linhas, use o widget Grid.

Disponível para apps do Google Chat e complementos do Google Workspace. As interfaces do complemento que oferecem suporte a colunas incluem:

• A caixa de diálogo exibida quando os usuários abrem o complemento em um rascunho de e-mail.
• A caixa de diálogo exibida quando os usuários abrem o complemento no menu Adicionar anexo em um evento do Google Agenda.

Representação JSON
{ "columnItems": [ { object (Column) } ] }

Campos
columnItems[]	object (Column) Uma matriz de colunas. É possível incluir até duas colunas em um card ou diálogo.

Coluna

Uma coluna.

Complementos do Google Workspace e apps de chat

Representação JSON
{ "horizontalSizeStyle": enum (HorizontalSizeStyle), "horizontalAlignment": enum (HorizontalAlignment), "verticalAlignment": enum (VerticalAlignment), "widgets": [ { object (Widgets) } ] }

Campos
horizontalSizeStyle	enum (HorizontalSizeStyle) Especifica como uma coluna preenche a largura do card.
horizontalAlignment	enum (HorizontalAlignment) Especifica se os widgets se alinham à esquerda, à direita ou ao centro de uma coluna.
verticalAlignment	enum (VerticalAlignment) Especifica se os widgets se alinham à parte de cima, de baixo ou ao centro de uma coluna.
widgets[]	object (Widgets) Uma matriz de widgets incluídos em uma coluna. Os widgets aparecem na ordem em que são especificados.

HorizontalSizeStyle

Especifica como uma coluna preenche a largura do card. A largura de cada coluna depende do HorizontalSizeStyle e da largura dos widgets dentro dela.

Complementos do Google Workspace e apps de chat

Enums
HORIZONTAL_SIZE_STYLE_UNSPECIFIED	Não use. Não especificado.
FILL_AVAILABLE_SPACE	Valor padrão. A coluna preenche o espaço disponível, até 70% da largura do card. Se as duas colunas forem definidas como FILL_AVAILABLE_SPACE, cada uma vai ocupar 50% do espaço.
FILL_MINIMUM_SPACE	A coluna preenche o menor espaço possível e não mais de 30% da largura do card.

HorizontalAlignment

Especifica se os widgets se alinham à esquerda, à direita ou ao centro de uma coluna.

Disponível para apps do Google Chat e indisponível para complementos do Google Workspace.

Enums
HORIZONTAL_ALIGNMENT_UNSPECIFIED	Não use. Não especificado.
START	Valor padrão. Alinha widgets à posição inicial da coluna. Para layouts da esquerda para a direita, alinha à esquerda. Para layouts da direita para a esquerda, alinha à direita.
CENTER	Alinha os widgets ao centro da coluna.
END	Alinha widgets à posição final da coluna. Para layouts da esquerda para a direita, alinha widgets à direita. Para layouts da direita para a esquerda, alinha widgets à esquerda.

VerticalAlignment

Especifica se os widgets se alinham à parte de cima, de baixo ou ao centro de uma coluna.

Complementos do Google Workspace e apps de chat

Enums
VERTICAL_ALIGNMENT_UNSPECIFIED	Não use. Não especificado.
CENTER	Valor padrão. Alinha widgets ao centro de uma coluna.
TOP	Alinha widgets à parte de cima de uma coluna.
BOTTOM	Alinha widgets à parte de baixo de uma coluna.

Widgets

Os widgets compatíveis que podem ser incluídos em uma coluna.

Complementos do Google Workspace e apps de chat

Representação JSON

{ // Union field data can be only one of the following: "textParagraph": { object (TextParagraph) }, "image": { object (Image) }, "decoratedText": { object (DecoratedText) }, "buttonList": { object (ButtonList) }, "textInput": { object (TextInput) }, "selectionInput": { object (SelectionInput) }, "dateTimePicker": { object (DateTimePicker) }, "chipList": { object (ChipList) } // End of list of possible types for union field data. }

Campos
Campo de união data. data pode ser apenas um dos seguintes:
textParagraph	object (TextParagraph) Widget de TextParagraph.
image	object (Image) Widget de Image.
decoratedText	object (DecoratedText) Widget de DecoratedText.
buttonList	object (ButtonList) Widget de ButtonList.
textInput	object (TextInput) Widget de TextInput.
selectionInput	object (SelectionInput) Widget de SelectionInput.
dateTimePicker	object (DateTimePicker) Widget de DateTimePicker.
chipList	object (ChipList) Widget de ChipList.

ChipList

Uma lista de ícones dispostos horizontalmente, que podem rolar horizontalmente ou passar para a próxima linha.

Disponível para apps do Google Chat e complementos do Google Workspace.

Representação JSON
{ "layout": enum (Layout), "chips": [ { object (Chip) } ] }

Campos
layout	enum (Layout) Layout da lista de ícones especificado.
chips[]	object (Chip) Uma matriz de chips.

Layout

O layout da lista de ícones.

Enums
LAYOUT_UNSPECIFIED	Não use. Não especificado.
WRAPPED	Valor padrão. A lista de ícones passa para a próxima linha se não houver espaço horizontal suficiente.
HORIZONTAL_SCROLLABLE	Os ícones rolam horizontalmente se não couberem no espaço disponível.

Ícone

Um texto, ícone ou texto e ícone que os usuários podem clicar.

Disponível para apps do Google Chat e complementos do Google Workspace.

Representação JSON
{ "icon": { object (Icon) }, "label": string, "onClick": { object (OnClick) }, "enabled": boolean, "disabled": boolean, "altText": string }

Campos
icon	object (Icon) A imagem do ícone. Se icon e text forem definidos, o ícone vai aparecer antes do texto.
label	string O texto exibido dentro do ícone.
onClick	object (OnClick) Opcional. A ação a ser realizada quando um usuário clica no ícone, como abrir um hiperlink ou executar uma função personalizada.
enabled (deprecated)	boolean Este item está obsoleto. Indica se o ícone está em um estado ativo e responde às ações do usuário. O padrão é true. Obsoleto. Use disabled em vez disso.
disabled	boolean Se o ícone está em um estado inativo e ignora as ações do usuário. O padrão é false.
altText	string O texto alternativo usado para acessibilidade. Defina um texto descritivo que informe aos usuários o que o ícone faz. Por exemplo, se um ícone abrir um hiperlink, escreva: "Abre uma nova guia do navegador e navega até a documentação para desenvolvedores do Google Chat em https://developers.google.com/workspace/chat".

Carrossel

Prévia para desenvolvedores:disponível no Programa de prévia para desenvolvedores do Google Workspace, que concede acesso antecipado a determinados recursos.

Um carrossel, também conhecido como controle deslizante, gira e mostra uma lista de widgets em formato de apresentação de slides, com botões que navegam para o widget anterior ou seguinte.

Por exemplo, esta é uma representação JSON de um carrossel que contém três widgets de parágrafo de texto.

{
  "carouselCards": [
    {
      "widgets": [
        {
          "textParagraph": {
            "text": "First text paragraph in carousel",
          }
        }
      ]
    },
    {
      "widgets": [
        {
          "textParagraph": {
            "text": "Second text paragraph in carousel",
          }
        }
      ]
    },
    {
      "widgets": [
        {
          "textParagraph": {
            "text": "Third text paragraph in carousel",
          }
        }
      ]
    }
  ]
}

Disponível para apps do Google Chat e indisponível para complementos do Google Workspace.

Representação JSON
{ "carouselCards": [ { object (CarouselCard) } ] }

Campos
carouselCards[]	object (CarouselCard) Uma lista de cards incluídos no carrossel.

CarouselCard

Prévia para desenvolvedores:disponível no Programa de prévia para desenvolvedores do Google Workspace, que concede acesso antecipado a determinados recursos.

Um card que pode ser exibido como um item de carrossel. Disponível para apps do Google Chat e indisponível para complementos do Google Workspace.

Representação JSON
{ "widgets": [ { object (NestedWidget) } ], "footerWidgets": [ { object (NestedWidget) } ] }

Campos
widgets[]	object (NestedWidget) Uma lista de widgets exibidos no card do carrossel. Os widgets são mostrados na ordem em que são especificados.
footerWidgets[]	object (NestedWidget) Uma lista de widgets exibidos na parte de baixo do card do carrossel. Os widgets são mostrados na ordem em que são especificados.

NestedWidget

Prévia para desenvolvedores:disponível no Programa de prévia para desenvolvedores do Google Workspace, que concede acesso antecipado a determinados recursos.

Uma lista de widgets que podem ser mostrados em um layout de contêiner, como um CarouselCard. Disponível para apps do Google Chat e indisponível para complementos do Google Workspace.

Representação JSON
{ // Union field data can be only one of the following: "textParagraph": { object (TextParagraph) }, "buttonList": { object (ButtonList) }, "image": { object (Image) } // End of list of possible types for union field data. }

Campos
Campo de união data. data pode ser apenas um dos seguintes:
textParagraph	object (TextParagraph) Um widget de parágrafo de texto.
buttonList	object (ButtonList) Um widget de lista de botões.
image	object (Image) Um widget de imagem.

CollapseControl

Representa um controle de abrir e fechar.

Disponível para apps do Google Chat e complementos do Google Workspace.

Representação JSON
{ "horizontalAlignment": enum (HorizontalAlignment), "expandButton": { object (Button) }, "collapseButton": { object (Button) } }

Campos
horizontalAlignment	enum (HorizontalAlignment) O alinhamento horizontal do botão de abrir e fechar.
expandButton	object (Button) Opcional. Defina um botão personalizável para abrir a seção. Os campos "expandButton" e "collapseButton" precisam ser definidos. Apenas um conjunto de campos não será aplicado. Se esse campo não estiver definido, o botão padrão será usado.
collapseButton	object (Button) Opcional. Defina um botão personalizável para fechar a seção. Os campos "expandButton" e "collapseButton" precisam ser definidos. Apenas um conjunto de campos não será aplicado. Se esse campo não estiver definido, o botão padrão será usado.

DividerStyle

O estilo do divisor de um card. No momento, usado apenas para divisores entre seções de cards.

Disponível para apps do Google Chat e complementos do Google Workspace.

Enums
DIVIDER_STYLE_UNSPECIFIED	Não use. Não especificado.
SOLID_DIVIDER	Opção padrão. Renderiza um divisor sólido.
NO_DIVIDER	Se definido, nenhum divisor será renderizado. Esse estilo remove completamente o divisor do layout. O resultado é equivalente a não adicionar um divisor.

CardAction

Uma ação do card é a ação associada a ele. Por exemplo, um card de fatura pode incluir ações como excluir, enviar por e-mail ou abrir a fatura em um navegador.

Disponível para complementos do Google Workspace e não disponível para apps do Google Chat.

Representação JSON
{ "actionLabel": string, "onClick": { object (OnClick) } }

Campos
actionLabel	string O rótulo que aparece como o item do menu de ação.
onClick	object (OnClick) A ação onClick para este item de ação.

CardFixedFooter

Um rodapé fixo que aparece na parte de baixo do card.

Definir fixedFooter sem especificar um primaryButton ou um secondaryButton causa um erro.

Para apps do Chat, você pode usar rodapés fixos em caixas de diálogo, mas não em mensagens de card. Para um exemplo em apps do Google Chat, consulte Adicionar um rodapé permanente.

Disponível para apps do Google Chat e complementos do Google Workspace.

Representação JSON
{ "primaryButton": { object (Button) }, "secondaryButton": { object (Button) } }

Campos
primaryButton	object (Button) O botão principal do rodapé fixo. O botão precisa ser um botão de texto com texto e cor definidos.
secondaryButton	object (Button) O botão secundário do rodapé fixo. O botão precisa ser um botão de texto com texto e cor definidos. Se secondaryButton estiver definido, você também precisará definir primaryButton.

DisplayStyle

Nos complementos do Google Workspace, determina como um card é exibido.

Disponível para complementos do Google Workspace e não disponível para apps do Google Chat.

Enums
DISPLAY_STYLE_UNSPECIFIED	Não use. Não especificado.
PEEK	O cabeçalho do card aparece na parte de baixo da barra lateral, cobrindo parcialmente o card superior atual da pilha. Ao clicar no cabeçalho, o card aparece na pilha. Se o card não tiver um cabeçalho, um cabeçalho gerado será usado.
REPLACE	Valor padrão. O card é mostrado substituindo a visualização do card superior na pilha.