Esta página foi traduzida pela API Cloud Translation.

Package google.apps.card.v1

Índice

Action (mensagem)
Action.ActionParameter (mensagem)
Action.Interaction (enum)
Action.LoadIndicator (enum)
BorderStyle (mensagem)
BorderStyle.BorderType (enum)
Button (mensagem)
ButtonList (mensagem)
Card (mensagem)
Card.CardAction (mensagem)
Card.CardFixedFooter (mensagem)
Card.CardHeader (mensagem)
Card.DisplayStyle (enum)
Card.DividerStyle (enum)
Card.Section (mensagem)
Columns (mensagem)
Columns.Column (mensagem)
Columns.Column.HorizontalSizeStyle (enum)
Columns.Column.VerticalAlignment (enum)
Columns.Column.Widgets (mensagem)
DateTimePicker (mensagem)
DateTimePicker.DateTimePickerType (enum)
DecoratedText (mensagem)
DecoratedText.SwitchControl (mensagem)
DecoratedText.SwitchControl.ControlType (enum)
Divider (mensagem)
EndNavigation (mensagem)
EndNavigation.Action (enum)
GetAutocompletionResponse (mensagem)
Grid (mensagem)
Grid.GridItem (mensagem)
Grid.GridItem.GridItemLayout (enum)
Icon (mensagem)
Image (mensagem)
ImageComponent (mensagem)
ImageCropStyle (mensagem)
ImageCropStyle.ImageCropType (enum)
Link (mensagem)
LinkPreview (mensagem)
MaterialIcon (mensagem)
Navigation (mensagem)
Notification (mensagem)
OnClick (mensagem)
OpenLink (mensagem)
OpenLink.OnClose (enum)
OpenLink.OpenAs (enum)
RenderActions (mensagem)
RenderActions.Action (mensagem)
SelectionInput (mensagem)
SelectionInput.PlatformDataSource (mensagem)
SelectionInput.PlatformDataSource.CommonDataSource (enum)
SelectionInput.SelectionItem (mensagem)
SelectionInput.SelectionType (enum)
SubmitFormResponse (mensagem)
Suggestions (mensagem)
Suggestions.SuggestionItem (mensagem)
TextInput (mensagem)
TextInput.Type (enum)
TextParagraph (mensagem)
Widget (mensagem)
Widget.HorizontalAlignment (enum)
Widget.ImageType (enum)

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.

Campos
`function`	`string` Uma função personalizada para invocar quando o elemento que o contém for clicado ou ativado de outra forma. Para exemplo de uso, consulte Ler dados de formulário.
`parameters[]`	`ActionParameter` Lista de parâmetros de ação.
`loadIndicator`	`LoadIndicator` Especifica o indicador de carregamento que a ação exibe ao fazer a chamada.
`persistValues`	`bool` Indica se os valores do formulário persistem após a ação. O valor padrão é `false`. Se `true`, os valores do formulário permanecem após o acionamento da ação. 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 `card_id` do card que continha a ação. Se for `false`, os valores do formulário serão apagados 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`	`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 responderá executando uma `action`, como abrir um link ou executar uma função, como normal. Ao especificar uma `interaction`, o app pode responder de maneiras interativas especiais. Por exemplo, definindo `interaction` como `OPEN_DIALOG`, o app pode abrir uma caixa de diálogo. Quando especificado, um indicador de carregamento não é exibido. Se especificado para um complemento, todo o card será removido e nada será exibido no cliente. Disponível para apps do Google Chat e indisponível para 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 soneca: "Adiar agora", "Adiar um dia" ou "Adiar na próxima semana". Você pode usar action method = snooze(), transmitindo o tipo e o tempo de soneca na lista de parâmetros de string.

Para saber mais, consulte CommonEventObject.

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

Campos

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

key

string

Nome do parâmetro do script de ação.

value

string

O valor do parâmetro.

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 responderá executando uma action, como abrir um link ou executar uma função, como normal.

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

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

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

Enums

INTERACTION_UNSPECIFIED Valor padrão. A action é executada normalmente.

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

OPEN_DIALOG

Abre uma caixa de diálogo, uma interface em janelas baseada em cards que os apps de chat usam para interagir com os usuários.

Compatível apenas com apps do Chat em resposta a cliques em botões em mensagens de cards. Se especificado para um complemento, todo o card será removido e nada será exibido no cliente.

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

LoadIndicator

Especifica o indicador de carregamento que a ação exibe 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.

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.

Campos

Campos
`type`	`BorderType` O tipo de borda.
`strokeColor`	`Color` As cores a serem usadas quando o tipo for `BORDER_TYPE_STROKE`.
`cornerRadius`	`int32` O raio do canto da borda.

type

BorderType

O tipo de borda.

strokeColor

Color

As cores a serem usadas quando o tipo for BORDER_TYPE_STROKE.

cornerRadius

int32

O raio do canto da borda.

BorderType

Representa os tipos de borda aplicados a 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`	Valor padrão. Sem borda.
`STROKE`	Esboço.

Botão

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

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

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

Campos
`text`	`string` O texto exibido dentro do botão.
`icon`	`Icon` A imagem do ícone. Se `icon` e `text` estiverem definidos, o ícone vai aparecer antes do texto.
`color`	`Color` Se definida, o botão será preenchido com uma cor de plano de fundo sólida, e a cor da fonte vai mudar para manter o contraste com a cor de fundo. Por exemplo, definir um plano de fundo azul provavelmente resulta em texto branco. Se ela não for definida, o plano de fundo da imagem será branco e a cor da fonte será azul. Para vermelho, verde e azul, o valor de cada campo é um número `float` que pode ser expresso de duas maneiras: como um número entre 0 e 255 dividido por 255 (153/255) ou como um valor entre 0 e 1 (0,6). O valor 0 representa a ausência de uma cor, e 1 ou 255/255 representa a presença total dessa cor na escala RGB. Defina como `alpha`, que define um nível de transparência usando esta equação: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` Para `alpha`, um valor de `1` corresponde a uma cor sólida, e um valor de `0` corresponde a uma cor completamente transparente. Por exemplo, a cor a seguir representa um vermelho meio transparente: `"color": { "red": 1, "green": 0, "blue": 0, "alpha": 0.5 }`
`onClick`	`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`	`bool` Se for `true`, o botão vai aparecer 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ê talvez escreva: "Abre uma nova guia do navegador e acessa a documentação para desenvolvedores do Google Chat em https://developers.google.com/workspace/chat".

ButtonList

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

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

Campos

Campos
`buttons[]`	`Button` Uma matriz de botões.

buttons[]

Button

Uma matriz de botões.

Card

Interface de card mostrada em uma mensagem do Google Chat ou em um complemento do Google Workspace.

Os cards são compatíveis com um layout definido, elementos interativos da IU, 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 avançar.

Crie e visualize cards com o Criador de cards.

Abra o Card Builder

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

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

Exemplo: mensagem com card para um app do Google Chat

Exemplo de card de contato

Para criar a mensagem do 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": "sasha@example.com"
                 }
               },
               {
                 "decoratedText": {
                   "startIcon": {
                     "knownIcon": "PERSON"
                   },
                   "text": "<font color=\"#80e27e\">Online</font>"
                 }
               },
               {
                 "decoratedText": {
                   "startIcon": {
                     "knownIcon": "PHONE"
                   },
                   "text": "+1 (555) 555-1234"
                 }
               },
               {
                 "buttonList": {
                   "buttons": [
                     {
                       "text": "Share",
                       "onClick": {
                        "openLink": {
                           "url": "https://example.com/share"
                         }
                       }
                     },
                     {
                       "text": "Edit",
                       "onClick": {
                         "action": {
                           "function": "goToView",
                           "parameters": [
                             {
                               "key": "viewType",
                               "value": "EDIT"
                             }
                           ]
                         }
                       }
                     }
                   ]
                 }
               }
             ]
           }
         ]
       }
    }
  ]
}

Campos
`header`	`CardHeader` O cabeçalho do cartão. O cabeçalho geralmente contém uma imagem principal e um título. Os cabeçalhos sempre aparecem na parte superior dos cards.
`sections[]`	`Section` Contém um conjunto de widgets. Cada seção tem seu próprio cabeçalho opcional. As seções são visualmente separadas por um divisor de linhas. Para ver um exemplo nos apps do Google Chat, consulte Definir uma seção de um card.
`sectionDividerStyle`	`DividerStyle` O estilo de divisor entre as seções.
`cardActions[]`	`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 indisponível para apps do Google Chat. Por exemplo, o JSON a seguir cria um menu de ações em cards 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 cartão. Usado como identificador de cartão na navegação com cartões. Disponível para complementos do Google Workspace e indisponível para apps do Google Chat.
`fixedFooter`	`CardFixedFooter` O rodapé fixo mostrado na parte inferior deste card. Definir `fixedFooter` sem especificar um `primaryButton` ou um `secondaryButton` causa um erro. Nos apps de chat, é possível 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`	`DisplayStyle` Nos complementos do Google Workspace, define as propriedades de exibição do `peekCardHeader`. Disponível para complementos do Google Workspace e indisponível para apps do Google Chat.
`peekCardHeader`	`CardHeader` Ao exibir conteúdo contextual, o cabeçalho do card de exibição atua como um marcador de posição para que o usuário possa navegar entre os cards da página inicial e os cards de contexto. Disponível para complementos do Google Workspace e indisponível para apps do Google Chat.

CardAction

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

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

Campos

Campos
`actionLabel`	`string` O rótulo exibido como o item do menu de ações.
`onClick`	`OnClick` A ação `onClick` para esse item de ação.

actionLabel

string

O rótulo exibido como o item do menu de ações.

onClick

OnClick

A ação onClick para esse item de ação.

CardFixedFooter

Um rodapé persistente (fixo) que aparece na parte inferior do cartão.

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

Nos apps de chat, é possível usar rodapés fixos em caixas de diálogo, mas não em mensagens de cards. Para conferir um exemplo nos apps do Google Chat, consulte Adicionar um rodapé permanente.

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

Campos

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

primaryButton

Button

O botão principal do rodapé fixo. O botão precisa ser de texto com texto e cores definidos.

secondaryButton

Button

O botão secundário do rodapé fixo. O botão precisa ser de texto com texto e cores definidos. Se secondaryButton estiver definido, você também vai precisar definir primaryButton.

CardHeader

Representa um cabeçalho de card. Veja um exemplo nos apps do Google Chat em Adicionar um cabeçalho.

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

Campos
`title`	`string` Obrigatório. O título do cabeçalho do cartão. O cabeçalho tem uma altura fixa: se um título e um subtítulo forem especificados, cada um ocupa uma linha. Se apenas o título for especificado, ele ocupará as duas linhas.
`subtitle`	`string` O subtítulo do cabeçalho do cartão. Se especificado, aparece na própria linha abaixo de `title`.
`imageType`	`ImageType` O formato usado 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 cartão.
`imageAltText`	`string` O texto alternativo dessa imagem que é usado para acessibilidade.

DisplayStyle

Em "Complementos do Google Workspace", determina como um card é exibido.

Disponível para complementos do Google Workspace e indisponí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 cartão é exibido na pilha. Se o cartão não tiver cabeçalho, será usado um cabeçalho gerado.
`REPLACE`	Valor padrão. O card é exibido substituindo a visualização do card superior na pilha de cards.

DividerStyle

O estilo de divisor de um card. No momento, só é usado para divisores entre seções do card.

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. Renderize um divisor sólido entre seções.
`NO_DIVIDER`	Se definido, nenhum divisor será renderizado entre as seções.

Seção

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

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

Campos
`header`	`string` Texto que aparece na parte de cima de uma seção. Compatível com texto formatado em HTML simples. Saiba mais sobre a formatação de texto em Formatar texto em apps do Google Chat e Formatar texto em complementos do Google Workspace.
`widgets[]`	`Widget` Todos os widgets da seção. Precisa conter pelo menos um widget.
`collapsible`	`bool` Indica se esta seção pode ser recolhida. As seções recolhíveis ocultam alguns ou todos os widgets, mas os usuários podem expandi-la para exibir os widgets ocultos clicando em Mostrar mais. Os usuários podem ocultar os widgets novamente clicando em Mostrar menos. Para determinar quais widgets estão ocultos, especifique `uncollapsibleWidgetsCount`.
`uncollapsibleWidgetsCount`	`int32` O número de widgets que podem ser recolhidos que permanecem visíveis mesmo quando uma seção é recolhida. Por exemplo, quando uma seção contém cinco widgets e a `uncollapsibleWidgetsCount` está definida como `2`, os dois primeiros widgets são sempre mostrados e os três últimos ficam recolhidos por padrão. O `uncollapsibleWidgetsCount` é considerado apenas quando `collapsible` é `true`.

Coluna

O widget Columns mostra até duas colunas em um card ou caixa de diálogo. Você pode adicionar widgets a cada coluna, os widgets aparecem na ordem em que são especificados. Para um exemplo nos apps do Google Chat, consulte Exibir 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 ou alinhar widgets entre as colunas.

As colunas são exibidas 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 ser agrupada abaixo da primeira:

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

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

Disponível para apps do Google Chat e complementos do Google Workspace. As colunas para complementos do Google Workspace estão na prévia para desenvolvedores.

Campos

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

columnItems[]

Column

Uma matriz de colunas. É possível incluir até duas colunas em um card ou caixa de diálogo.

Coluna

Uma coluna.

Disponível para apps do Google Chat e complementos do Google Workspace. As colunas para complementos do Google Workspace estão na prévia para desenvolvedores.

Campos
`horizontalSizeStyle`	`HorizontalSizeStyle` Especifica como uma coluna preenche a largura do card.
`horizontalAlignment`	`HorizontalAlignment` Especifica se os widgets são alinhados à esquerda, à direita ou no centro de uma coluna.
`verticalAlignment`	`VerticalAlignment` Especifica se os widgets são alinhados na parte superior, inferior ou no centro de uma coluna.
`widgets[]`	`Widgets` Uma matriz de widgets incluídos em uma coluna. Eles aparecem na ordem em que são especificados.

HorizontalSizeStyle

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

Disponível para apps do Google Chat e complementos do Google Workspace. As colunas para complementos do Google Workspace estão na prévia para desenvolvedores.

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 em até 70% da largura do card. Se as duas colunas forem definidas como `FILL_AVAILABLE_SPACE`, cada uma delas preencherá 50% do espaço.
`FILL_MINIMUM_SPACE`	A coluna preenche a menor quantidade possível de espaço e não mais que 30% da largura do card.

VerticalAlignment

Especifica se os widgets são alinhados na parte superior, inferior ou no centro de uma coluna.

Disponível para apps do Google Chat e complementos do Google Workspace. As colunas para complementos do Google Workspace estão na prévia para desenvolvedores.

Enums
`VERTICAL_ALIGNMENT_UNSPECIFIED`	Não use. Não especificado.
`CENTER`	Valor padrão. Alinha os widgets ao centro de uma coluna.
`TOP`	Alinha os widgets à parte superior de uma coluna.
`BOTTOM`	Alinha os widgets à parte inferior de uma coluna.

Widgets

Os widgets compatíveis que você pode incluir em uma coluna.

Disponível para apps do Google Chat e complementos do Google Workspace. As colunas para complementos do Google Workspace estão na prévia para desenvolvedores.

Campos
Campo de união `data`. `data` pode ser apenas de um dos tipos a seguir:
`textParagraph`	`TextParagraph` Widget de `TextParagraph`.
`image`	`Image` Widget de `Image`.
`decoratedText`	`DecoratedText` Widget de `DecoratedText`.
`buttonList`	`ButtonList` Widget de `ButtonList`.
`textInput`	`TextInput` Widget de `TextInput`.
`selectionInput`	`SelectionInput` Widget de `SelectionInput`.
`dateTimePicker`	`DateTimePicker` Widget de `DateTimePicker`.

DateTimePicker

Permite que os usuários insiram uma data, uma hora ou uma data e hora. Para conferir um exemplo nos 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 selecionar datas e horários. Se os usuários inserirem uma data ou hora inválida, o seletor mostrará um erro que solicita que os usuários insiram as informações corretamente.

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

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 solicita que os usuários insiram uma data, hora ou data e hora. Por exemplo, se os usuários estiverem agendando um horário, use um marcador como `Appointment date` ou `Appointment date and time`.
`type`	`DateTimePickerType` Define se o widget é compatível com a inserção de uma data, hora ou data e hora.
`valueMsEpoch`	`int64` O valor padrão exibido no widget, em milissegundos, desde o horário da era Unix (link em inglês). Especifique o valor com base no tipo de seletor (`DateTimePickerType`): `DATE_AND_TIME`: data e hora do calendário em UTC. Por exemplo, para representar 1o de janeiro de 2023 às 12h UTC, use `1672574400000`. `DATE_ONLY`: uma data do calendário às 00:00:00 UTC. Por exemplo, para representar 1o de janeiro de 2023, use `1672531200000`. `TIME_ONLY`: um horário em UTC. Por exemplo, para representar 12h, use `43200000` (ou `12 * 60 * 60 * 1000`).
`timezoneOffsetDate`	`int32` O número que representa a diferença do fuso horário em relação ao UTC, em minutos. Se definido, o `value_ms_epoch` será exibido no fuso horário especificado. Se não for definido, o valor será definido por padrão como o fuso horário do usuário.
`onChangeAction`	`Action` Acionado quando o usuário clica em Salvar ou Limpar na interface do `DateTimePicker`.

DateTimePickerType

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

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.

DecoratedText

Um widget que exibe texto com decorações opcionais, como uma etiqueta acima ou abaixo do texto, um ícone na frente do texto, um widget de seleção ou um botão após o texto. Para conferir um exemplo nos apps do Google Chat, consulte Exibir texto com texto decorativo.

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

Campos
`icon (deprecated)`	`Icon` Este item está obsoleto. Descontinuado e substituído por `startIcon`.
`startIcon`	`Icon` O ícone exibido na frente do texto.
`topLabel`	`string` O texto que aparece acima de `text`. Sempre trunca.
`text`	`string` Obrigatório. O texto principal. Compatível com formatação simples. Saiba mais sobre a formatação de texto em Formatar texto em apps do Google Chat e Formatar texto em complementos do Google Workspace.
`wrapText`	`bool` A configuração de ajuste de texto. Se for `true`, o texto será unido e exibido em várias linhas. Caso contrário, o texto fica truncado. Só se aplica a `text`, não a `topLabel` e `bottomLabel`.
`bottomLabel`	`string` O texto que aparece abaixo de `text`. Sempre encapsula.
`onClick`	`OnClick` Esta ação é acionada quando os usuários clicam em `topLabel` ou `bottomLabel`.
Campo de união `control`. Um botão, uma chave, uma caixa de seleção ou uma imagem que aparece à direita do texto no widget `decoratedText`. `control` pode ser apenas de um dos tipos a seguir:
`button`	`Button` Um botão em que o usuário pode clicar para acionar uma ação.
`switchControl`	`SwitchControl` É um widget de alternância em que o usuário pode clicar para mudar o estado e acionar uma ação.
`endIcon`	`Icon` Ícone exibido após o texto. Compatível com ícones integrados e personalizados.

SwitchControl

Uma chave de estilo 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.

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`	`bool` Quando `true`, a chave é selecionada.
`onChangeAction`	`Action` A ação a ser realizada quando o estado do interruptor muda, como qual função será executada.
`controlType`	`ControlType` Como a chave é exibida na interface do usuário. Disponível para apps do Google Chat e complementos do Google Workspace.

ControlType

Como a chave é exibida na interface do usuário.

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

Enums
`SWITCH`	Um interruptor no estilo de alternância.
`CHECKBOX`	Descontinuado e substituído por `CHECK_BOX`.
`CHECK_BOX`	Uma caixa de seleção.

Separador

Esse tipo não tem campos.

Mostra um divisor entre widgets como uma linha horizontal. Para conferir um exemplo nos 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": {}

EndNavigation

Ação do fluxo da caixa de diálogo.

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

Campos

action

Action

A ação de renderização para o cliente encerrar um fluxo de caixa de diálogo.

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

Ação

Os tipos de ação de renderização para o cliente encerrar um fluxo de caixa de diálogo.

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

Enums
`ACTION_UNSPECIFIED`	Ação não especificada.
`CLOSE_DIALOG`	Fechar o fluxo da caixa de diálogo.
`CLOSE_DIALOG_AND_EXECUTE`	Feche o fluxo da caixa de diálogo e atualize o card que abriu o fluxo.

GetAutocompletionResponse

Uma resposta para receber o contêiner de preenchimento automático, que inclui elementos necessários para mostrar itens de preenchimento automático para o campo de texto.

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

{
  "autoComplete": {
    "items": [
      {
        "text": "C++"
      },
      {
        "text": "Java"
      },
      {
        "text": "JavaScript"
      },
      {
        "text": "Python"
      }
    ]
  }
}

Campos

Campos
`autoComplete`	`Suggestions`
`schema`	`string` Esse é um campo de esquema autônomo que pode estar presente na marcação para verificação de sintaxe.

autoComplete

Suggestions

schema

string

Esse é um campo de esquema autônomo que pode estar presente na marcação para verificação de sintaxe.

Grade

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

Uma grade é compatível com 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"
    }
  }
}

Campos
`title`	`string` O texto que aparece no cabeçalho da grade.
`items[]`	`GridItem` Os itens a serem exibidos na grade.
`borderStyle`	`BorderStyle` O estilo de borda a ser aplicado a cada item da grade.
`columnCount`	`int32` O número de colunas a serem exibidas na grade. Um valor padrão será usado se esse campo não for especificado e esse valor padrão será diferente dependendo de onde a grade for exibida (caixa de diálogo ou complementar).
`onClick`	`OnClick` Esse callback é reutilizado por cada item de grade individual, 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, imagem ou texto e imagem.

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

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

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.

Ícone

Um ícone exibido em um widget em um card. Para conferir um exemplo nos 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.

Campos
`altText`	`string` Opcional. Uma descrição do ícone usado para acessibilidade. Se não for especificado, será fornecido o valor padrão `Button`. Como prática recomendada, você deve definir uma descrição útil para o que o ícone exibe e, se aplicável, o 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 for definido em uma `Button`, a `altText` aparecerá como texto auxiliar 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`	`ImageType` Estilo de corte aplicado à imagem. Em alguns casos, aplicar um corte `CIRCLE` faz com que a imagem seja desenhada maior que um ícone integrado.
Campo de união `icons`. O ícone exibido no widget do card. `icons` pode ser apenas de um dos tipos a seguir:
`knownIcon`	`string` Exiba um dos ícones integrados fornecidos pelo Google Workspace. Por exemplo, para mostrar um ícone de avião, especifique `AIRPLANE`. Para ônibus, especifique `BUS`. Para uma lista completa dos ícones compatíveis, consulte ícones integrados.
`iconUrl`	`string` Exiba 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`	`MaterialIcon` Exiba um dos ícones do Material Design do Google (link em inglês). Por exemplo, para exibir 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.

Imagem

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

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

Campos

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

imageUrl

string

O URL HTTPS que hospeda a imagem.

Exemplo:

https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png

onClick

OnClick

Quando um usuário clica na imagem, o clique aciona a ação.

altText

string

O texto alternativo dessa imagem que é usado para acessibilidade.

ImageComponent

Representa uma imagem.

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

Campos
`imageUri`	`string` O URL da imagem.
`altText`	`string` O rótulo de acessibilidade da imagem.
`cropStyle`	`ImageCropStyle` O estilo de corte a ser aplicado à imagem.
`borderStyle`	`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
}

Campos

Campos
`type`	`ImageCropType` O tipo de corte.
`aspectRatio`	`double` 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 }`

type

ImageCropType

O tipo de corte.

aspectRatio

double

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.

Link

O objeto de link do recurso de terceiros retornado ao complemento. Saiba mais em Criar recursos de terceiros no menu @.

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

Campos

Campos
`url`	`string` URL do link para retornar ao complemento.
`title`	`string` Título do link para retornar ao complemento.

url

string

URL do link para retornar ao complemento.

title

string

Título do link para retornar ao complemento.

LinkPreview

Ação de card que mostra um link de terceiros com um card e um ícone inteligente. Para saber mais, consulte Visualizar links com ícones inteligentes.

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

Por exemplo, o JSON a seguir retorna um título exclusivo para a visualização do link e o ícone inteligente dele, além de um card de visualização com um cabeçalho e uma descrição de texto:

{
  "action": {
    "linkPreview": {
      "title": "Smart chip title",
      "linkPreviewTitle": "Link preview title",
      "previewCard": {
        "header": {
          "title": "Preview card header",
        },
        "sections": [
          {
            "widgets": [
              {
                "textParagraph": {
                  "text": "Description of the link."
                }
              }
            ]
          }
        ]
      }
    }
  }
}

O exemplo retorna a seguinte visualização de link:

Exemplo de visualização de link

Campos

Campos
`previewCard`	`Card` Um card com informações sobre um link de um serviço de terceiros.
`title`	`string` O título exibido no ícone inteligente da visualização do link. Se não for definido, o ícone inteligente exibirá o cabeçalho do `preview_card`.
`linkPreviewTitle`	`string` O título que aparece na visualização do link. Se ela não for definida, a visualização do link mostrará o cabeçalho do `preview_card`.

previewCard

Card

Um card com informações sobre um link de um serviço de terceiros.

title

string

O título exibido no ícone inteligente da visualização do link. Se não for definido, o ícone inteligente exibirá o cabeçalho do preview_card.

linkPreviewTitle

string

O título que aparece na visualização do link. Se ela não for definida, a visualização do link mostrará o cabeçalho do preview_card.

MaterialIcon

Um ícone do Material Design do Google (link em inglês), que inclui mais de 2.500 opções.

Por exemplo, para exibir um ícone de caixa de seleção com peso e grau 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.

Campos
`name`	`string` O nome do ícone definido no ícone do Material Design do Google (link em inglês), por exemplo, `check_box`. Todos os nomes inválidos são abandonados e substituídos por uma string vazia, o que resulta na falha da renderização do ícone.
`fill`	`bool` Indica se o ícone é renderizado como preenchido. O valor padrão é “false”. Para visualizar diferentes configurações de ícone, acesse Google Font Icons e ajuste as configurações em Personalizar.
`weight`	`int32` A espessura do traço do ícone. Escolha entre {100, 200, 300, 400, 500, 600, 700}. Se ausente, o valor padrão será 400. Se outro valor for especificado, será usado o padrão. Para visualizar diferentes configurações de ícone, acesse Google Font Icons e ajuste as configurações em Personalizar.
`grade`	`int32` O peso e a grau afetam a espessura do símbolo. Os ajustes de gradação são mais detalhados que os ajustes de peso e têm um pequeno impacto no tamanho do símbolo. Escolha entre {-25, 0, 200}. Se ausente, o valor padrão será 0. Se outro valor for especificado, será usado o padrão. Para visualizar diferentes configurações de ícone, acesse Google Font Icons e ajuste as configurações em Personalizar.

Ação de carta que manipula a pilha de cards.

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

Exemplo:

1) Adicionar um novo cartão à pilha (navegue para frente).

 navigations : {
    pushCard : CARD
  }

2) Atualize o cartão na parte superior da pilha (atualização local).

  navigations : {
    popCard : true,
  }, {
    pushCard : CARD
  }

3) Volte uma etapa sem atualizar.

  navigations : {
    popCard : true,
  }

4) Volte várias etapas e atualize o card.

  navigations : {
    popCard : true,
  }, ... {
    pushCard : CARD
  }

5) Volte várias etapas para um CARD_NAME definido.

  navigations : {
    popToCardName : CARD_NAME,
  }, {
    pushCard : CARD
  }

6) Volte para a raiz e atualize o cartão.

  navigations : {
    popToRoot : true
  }, {
    pushCard : CARD
  }

7) Vá para o cartão especificado e coloque-o também.

navigations : { popToCardName : CARD_NAME }, { popCard : true, }

8) Substitua o cartão superior por um novo.

  navigations : {
    updateCard : CARD
  }

Campos
Campo de união `navigate_action`. `navigate_action` pode ser apenas de um dos tipos a seguir:
`popToRoot`	`bool` A pilha de cartões destaca todos os cartões, exceto o cartão raiz.
`pop`	`bool` A pilha de cartões destaca um cartão.
`popToCard`	`string` A pilha de cartões exibe todos os cartões acima do cartão especificado com o nome do cartão fornecido.
`pushCard`	`Card` A pilha de cartões empurra um cartão para ela.
`updateCard`	`Card` A pilha de cards atualiza o card superior com um novo card e preserva os valores dos campos preenchidos do formulário. Para um campo não equivalente, o valor é descartado.
`endNavigation`	`EndNavigation` Ação de navegação para o fim do fluxo da caixa de diálogo. Para saber mais, consulte Responder a uma caixa de diálogo para mensagens do card da página inicial do app Disponível para apps do Google Chat e indisponível para complementos do Google Workspace.

Notificação

Ação de card que mostra uma notificação no app host.

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

Campos

Campos
`text`	`string` Texto simples a ser exibido para a notificação, sem tags HTML.

text

string

Texto simples a ser exibido para a notificação, sem tags HTML.

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.

Campos
Campo de união `data`. `data` pode ser apenas de um dos tipos a seguir:
`action`	`Action` Se especificado, uma ação será acionada por esta `onClick`.
`openLink`	`OpenLink` Se especificado, este `onClick` aciona uma ação de abrir link.
`openDynamicLinkAction`	`Action` Um complemento aciona essa ação quando é necessário abrir um link. Ele é diferente do `open_link` acima porque precisa se comunicar com o servidor para receber o link. Dessa forma, é necessário algum trabalho de preparação para que o cliente Web faça antes que a resposta da ação de link aberto retorne. Disponível para complementos do Google Workspace e indisponível para apps do Google Chat.
`card`	`Card` Se especificado, um novo cartão será enviado para a pilha após um clique. Disponível para complementos do Google Workspace e indisponível para apps do Google Chat.

OpenLink

Representa um evento onClick que abre um hiperlink.

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

Campos

Campos
`url`	`string` O URL a ser aberto.
`openAs`	`OpenAs` Como abrir um link. Disponível para complementos do Google Workspace e indisponível para apps do Google Chat.
`onClose`	`OnClose` Se o cliente esquece um link depois de abri-lo ou o observa até que a janela feche. Disponível para complementos do Google Workspace e indisponível para apps do Google Chat.

url

string

O URL a ser aberto.

openAs

OpenAs

Como abrir um link.

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

onClose

OnClose

Se o cliente esquece um link depois de abri-lo ou o observa até que a janela feche.

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

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 gerenciador OnClose.

Se os gerenciadores OnOpen e OnClose estiverem definidos e a plataforma do cliente não oferecer suporte aos dois valores, OnClose terá precedência.

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

Enums

NOTHING Valor padrão. O cartão não é recarregado, nada acontece.

Enums
`NOTHING`	Valor padrão. O cartão não é recarregado, nada acontece.
`RELOAD`	Recarrega o card depois que a janela filha é fechada. Se usada com `OpenAs.OVERLAY`, a janela filha vai funcionar como uma caixa de diálogo modal, e o card principal vai ser bloqueado até que a filha seja fechada.

RELOAD

Recarrega o card depois que a janela filha é fechada.

Se usada com OpenAs.OVERLAY, a janela filha vai funcionar como uma caixa de diálogo modal, e o card principal vai ser bloqueado até que a filha seja fechada.

OpenAs

Quando uma ação OnClick abre um link, o cliente pode abri-lo como uma janela em tamanho original (se esse for o frame usado pelo cliente) ou como 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 for compatível. FULL_SIZE é aceito por todos os clientes.

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

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

RenderActions

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

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

Campos

Campos
`action`	`Action`
`hostAppAction`	`HostAppActionMarkup` Ações processadas por apps de host individuais.
`schema`	`string` Esse é um campo de esquema autônomo que pode estar presente na marcação para verificação de sintaxe.

action

Action

hostAppAction

HostAppActionMarkup

Ações processadas por apps de host individuais.

schema

string

Esse é um campo de esquema autônomo que pode estar presente na marcação para verificação de sintaxe.

Ação

Campos
`navigations[]`	`Navigation` Envie por push, pop ou atualize os cards exibidos.
`link`	`OpenLink` Abra o link de destino em uma nova guia ou janela pop-up.
`notification`	`Notification` Exiba uma notificação para o usuário final.
`linkPreview`	`LinkPreview` Mostre uma visualização de link para o usuário final.
`links[]`	`Link` O link para um recurso de terceiros criado em um aplicativo do Google Workspace. Formatado como uma matriz de objetos com um item. Saiba mais em Criar recursos de terceiros no menu @.

SelectionInput

Um widget que cria um ou mais itens de IU que os usuários podem selecionar. Por exemplo, um menu suspenso ou caixas de seleção. Você pode usar este widget para coletar dados que podem ser previstos ou enumerados. Para conferir um exemplo nos apps do Google Chat, consulte Adicionar elementos de interface selecionáveis.

Os apps de chat podem processar o valor de 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.

Campos
`name`	`string` 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 selecionarem 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`	`SelectionType` O tipo de itens que são mostrados 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[]`	`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`	`Action` Se especificado, o formulário será enviado quando a seleção for alterada. Se não for especificado, você precisará especificar um botão separado que enviará o formulário. Para detalhes sobre como trabalhar com entradas de formulário, consulte Receber dados de formulário.
`multiSelectMaxSelectedItems`	`int32` 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á de três itens.
`multiSelectMinQueryLength`	`int32` Para menus de seleção múltipla, o número de caracteres de texto que um usuário insere antes da consulta do app é preenchido automaticamente e exibe itens sugeridos no menu. Se não for especificado, o padrão será 0 caracteres para fontes de dados estáticas e 3 caracteres para fontes externas.
Campo de união `multi_select_data_source`. Para um menu de seleção múltipla, é a fonte de dados que preenche 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 de um dos tipos a seguir:
`externalDataSource`	`Action` Uma fonte de dados externa, como um banco de dados relacional.
`platformDataSource`	`PlatformDataSource` Uma fonte de dados do Google Workspace.

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.

Campos

Campos
Campo de união `data_source`. A fonte de dados. `data_source` pode ser apenas de um dos tipos a seguir:
`commonDataSource`	`CommonDataSource` Uma fonte de dados compartilhada por todos os apps do Google Workspace, como os usuários em uma organização do Google Workspace.
`hostAppDataSource`	`HostAppDataSourceMarkup` Uma fonte de dados exclusiva de um aplicativo host do Google Workspace, como os espaços do Google Chat.

Campo de união data_source. A fonte de dados. data_source pode ser apenas de um dos tipos a seguir:

commonDataSource

CommonDataSource

Uma fonte de dados compartilhada por todos os apps do Google Workspace, como os usuários em uma organização do Google Workspace.

hostAppDataSource

HostAppDataSourceMarkup

Uma fonte de dados exclusiva de um aplicativo host do Google Workspace, como os espaços do Google Chat.

CommonDataSource

Uma fonte de dados compartilhada por todos os apps 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 usuários da organização 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 interruptor.

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

Campos
`text`	`string` É o texto que identifica ou descreve o item para os usuários.
`value`	`string` 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`	`bool` Indica se o item está selecionado por padrão. Se a entrada de seleção aceitar apenas um valor (como para botões de opção ou um menu suspenso), defina esse campo apenas para um item.
`startIconUri`	`string` Para menus de seleção múltipla, é o URL do ícone exibido ao lado do campo `text` do item. Oferece suporte a arquivos PNG e JPEG. Precisa ser um URL `HTTPS`. Por exemplo, `https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png`.
`bottomText`	`string` Para menus de seleção múltipla, uma descrição ou rótulo de texto que aparece abaixo do campo `text` do item.

SelectionType

Formato dos itens que os usuários podem selecionar. Diferentes opções suportam diferentes tipos de interações. Por exemplo, os usuários podem marcar várias caixas de seleção, mas só podem selecionar um item em um menu suspenso.

Cada entrada de seleção é compatível com um tipo de seleção. Não é possível misturar caixas de seleção e interruptores, 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 um ou mais interruptores.
`DROPDOWN`	Um menu suspenso. Os usuários podem selecionar um item do menu.
`MULTI_SELECT`	Um menu de seleção múltipla para dados estáticos ou dinâmicos. Na barra de menus, os usuários selecionam um ou mais itens. Os usuários também podem inserir valores para preencher os dados dinâmicos. 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 itens de um menu de seleção múltipla, é possível usar um dos seguintes tipos de fontes de dados: Dados estáticos: os itens são especificados como objetos `SelectionItem` no widget. Até 100 itens. 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 em uma fonte de dados externa fora do Google Workspace. Confira exemplos de como implementar menus de seleção múltipla em Adicionar um menu de seleção múltipla. Disponível para apps do Google Chat e complementos do Google Workspace. A seleção múltipla para complementos do Google Workspace está na prévia para desenvolvedores.

SubmitFormResponse

Uma resposta a um envio de formulário que não seja um contêiner de preenchimento automático, que contém as ações que o cartão deve realizar e/ou o app host de complemento deve realizar e se o estado do cartão foi alterado.

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

{
  "renderActions": {
    "action": {
      "notification": {
        "text": "Email address is added: salam.heba@example.com"
      }
    },
    "hostAppAction": {
      "gmailAction": {
        "openCreatedDraftAction": {
          "draftId": "msg-a:r-79766936926021702",
          "threadServerPermId": "thread-f:15700999851086004"
        }
      }
    }
  }
}

Campos

renderActions

RenderActions

Um conjunto de instruções de renderização que instruem o cartão a realizar uma ação e/ou instrui o app host do complemento a realizar uma ação específica do app.

stateChanged

bool

Indica se o estado dos cards mudou e os dados nos cards estão desatualizados.

schema

string

Esse é um campo de esquema autônomo que pode estar presente na marcação para verificação de sintaxe.

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. Conforme os usuários digitam, os valores sugeridos são filtrados dinamicamente para corresponder ao que eles digitaram.

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 filtra para mostrar Java e JavaScript.

Os valores sugeridos ajudam a orientar os usuários a inserir valores que possam ser compreendidos pelo seu aplicativo. Ao se referir ao JavaScript, alguns usuários podem inserir javascript e outros java script. Ao sugerir JavaScript, você padroniza como os usuários interagem com o 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.

Campos

items[]

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.

Campos

Campo de união content.

content pode ser apenas de um dos tipos a seguir:

text

string

O valor de uma entrada sugerida para um campo de entrada de texto. Isso é equivalente ao que os usuários digitam por conta própria.

TextInput

Um campo em que os usuários podem inserir texto. Oferece suporte a sugestões e ações de mudança. Para conferir um exemplo nos apps do Google Chat, consulte Adicionar um campo em que o usuário pode digitar texto.

Os apps de chat recebem e podem processar o valor do texto inserido durante eventos de entrada no 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 de usuários, use o widget SelectionInput.

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

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 solicitando que 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`	`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`	`Action` O que fazer quando ocorre uma alteração no campo de entrada de texto. Por exemplo, um usuário adicionando ao campo ou excluindo texto. Por exemplo, executar uma função personalizada ou abrir uma caixa de diálogo no Google Chat.
`initialSuggestions`	`Suggestions` Valores sugeridos que os usuários podem inserir. Esses valores aparecem quando os usuários clicam dentro do campo de entrada de texto. Conforme os usuários digitam, os valores sugeridos são filtrados dinamicamente para corresponder ao que eles digitaram. 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 filtra para mostrar apenas `Java` e `JavaScript`. Os valores sugeridos ajudam a orientar os usuários a inserir valores que possam ser compreendidos pelo seu aplicativo. Ao se referir ao JavaScript, alguns usuários podem inserir `javascript` e outros `java script`. Ao sugerir `JavaScript`, você padroniza como os usuários interagem com o 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`	`Action` Opcional. Especifique a ação a ser realizada quando o campo de entrada de texto mostrar sugestões aos usuários que interagem com ele. Se não for especificada, as sugestões serão definidas por `initialSuggestions` e processadas pelo cliente. Se especificado, o app realiza a ação especificada aqui, como executar uma função personalizada. Disponível para complementos do Google Workspace e indisponível para apps do Google Chat.
`placeholderText`	`string` Texto que aparece no campo de entrada de texto quando o campo está vazio. Use esse texto para solicitar 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, um campo de entrada com uma única linha ou várias linhas. Se initialSuggestions for especificado, type será sempre SINGLE_LINE, mesmo se estiver 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.

TextParagraph

Um parágrafo de texto com suporte para formatação. Veja um exemplo nos apps do Google Chat em Adicionar um parágrafo de texto formatado. Saiba mais sobre a formatação de texto em Formatar texto em apps do Google Chat e Formatar texto em complementos do Google Workspace.

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

Campos

text

string

O texto que é mostrado no widget.

Campos
`horizontalAlignment`	`HorizontalAlignment` Especifica se os widgets são alinhados à esquerda, à direita ou no centro de uma coluna.
Campo de união `data`. Um widget pode ter apenas um dos itens a seguir. É possível usar vários campos de widget para exibir mais itens. `data` pode ser apenas de um dos tipos a seguir:
`textParagraph`	`TextParagraph` Mostra um parágrafo de texto. Compatível com texto formatado em HTML simples. Saiba mais sobre a formatação de texto em Formatar texto em apps do Google Chat e Formatar texto em complementos do Google Workspace. Por exemplo, o JSON a seguir cria um texto em negrito: `"textParagraph": { "text": " <b>bold text</b>" }`
`image`	`Image` Exibe 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`	`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": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } }`
`buttonList`	`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, "alpha": 1 }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] }`
`textInput`	`TextInput` Exibe uma caixa de texto na qual 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`	`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, interruptores 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`	`DateTimePicker` Exibe um widget que permite que os usuários insiram uma data, hora ou data e hora. Por exemplo, o JSON a seguir cria um seletor de data e horário para agendar um horário: `"dateTimePicker": { "name": "appointment_time", "label": "Book your appointment at:", "type": "DATE_AND_TIME", "valueMsEpoch": "796435200000" }`
`divider`	`Divider` Exibe um divisor de linhas horizontal entre widgets. Por exemplo, o JSON a seguir cria um divisor: `"divider": { }`
`grid`	`Grid` Mostra uma grade com uma coleção de itens. Uma grade é compatível com qualquer número de colunas e itens. O número de linhas é determinado pelos limites superiores do número de 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`	`Columns` Exibe até duas colunas. Para incluir mais de duas colunas ou usar linhas, utilize 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" } } ] } ] }`

HorizontalAlignment

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

ImageType

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

Package google.apps.card.v1

Índice

Ação

ActionParameter

Interação

LoadIndicator

BorderStyle

BorderType

Botão

ButtonList

Card

CardAction

CardFixedFooter

CardHeader

DisplayStyle

DividerStyle

Seção

Coluna

Coluna

HorizontalSizeStyle

VerticalAlignment

Widgets

DateTimePicker

DateTimePickerType

DecoratedText

SwitchControl

ControlType

Separador

EndNavigation

Ação

GetAutocompletionResponse

Grade

GridItem

GridItemLayout

Ícone

Imagem

ImageComponent

ImageCropStyle

ImageCropType

Link

LinkPreview

MaterialIcon

Navegação

Notificação

OnClick

OpenLink

OnClose

OpenAs

RenderActions

Ação

SelectionInput

PlatformDataSource

CommonDataSource

SelectionItem

SelectionType

SubmitFormResponse

Sugestões

SuggestionItem

TextInput

Tipo

TextParagraph

Widget

HorizontalAlignment

ImageType