Package google.apps.card.v1

string

Uma função personalizada para invocar quando o elemento que contém o elemento de destino for clicado ou ativado de outra forma.

Para conferir um exemplo de uso, consulte Ler dados de formulário.

ActionParameter

Lista de parâmetros de ação.

LoadIndicator

Especifica o indicador de carregamento que a ação exibe ao fazer a call-to-action.

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 a ação ser 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 cards em apps de chat, também é necessário definir a ResponseType da ação como UPDATE_MESSAGE e usar o mesmo card_id do card que continha a ação.

Se false, os valores do formulário são limpos quando a ação é acionada. Para impedir que o usuário faça alterações enquanto a ação está sendo processada, defina LoadIndicator como SPINNER.

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 uma 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, o card inteiro é removido e nada é mostrado no cliente.

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

string

Opcional. Preencha a lista com os nomes dos widgets necessários 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á interrompido.

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

bool

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.

string

O nome do parâmetro do script de ação.

string

O valor do parâmetro.

BorderType

O tipo de borda.

Color

As cores a serem usadas quando o tipo é 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 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 código 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, este campo será ignorado.

int32

O raio dos cantos da borda.

string

O texto exibido dentro do botão.

Icon

Um ícone exibido dentro do botão. Se icon e text forem definidos, o ícone vai aparecer antes do texto.

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 definida como azul, qualquer texto ou ícone no botão será definido como 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 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 código 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, este campo será ignorado.

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.

bool

Se true, o botão aparece em um estado inativo e não responde às ações do usuário.

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

Opcional. O tipo de um botão. Se não for definido, o tipo de botão será definido como OUTLINED. 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.

Button

Uma matriz de botões.

CardHeader

O cabeçalho do card. Um cabeçalho geralmente contém uma imagem principal e um título. Os cabeçalhos sempre aparecem na parte de cima de um card.

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 conferir um exemplo em apps do Google Chat, consulte Definir uma seção de um card.

DividerStyle

O estilo do divisor entre o cabeçalho, as seções e o rodapé.

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 constrói um menu de ação de 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"
      }
    }
  }
]

string

Nome do card. Usado como um identificador de cartão na navegação de cards.

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

CardFixedFooter

O rodapé fixo mostrado na parte de baixo deste card.

A configuração de fixedFooter sem especificar um primaryButton ou um secondaryButton causa um erro. Para apps de chat, é possível usar cabeçalhos 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

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.

CardHeader

Ao mostrar conteúdo contextual, o cabeçalho do card de visualização funciona como um marcador para que o usuário possa navegar entre os cards da página inicial e os cards contextuais.

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

string

O rótulo que aparece como o item do menu de ação.

OnClick

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

Button

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

Button

O botão secundário do rodapé fixo. O botão precisa ser de texto com texto e cor definidos. Se secondaryButton estiver definido, defina também primaryButton.

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 ocupará as duas linhas.

string

O subtítulo do cabeçalho do card. Se especificado, aparece na própria linha abaixo de title.

ImageType

A forma usada para cortar a imagem.

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

string

O URL HTTPS da imagem no cabeçalho do cartão.

string

O texto alternativo dessa imagem usado para acessibilidade.

TextParagraph

Um widget de parágrafo de texto.

ButtonList

Um widget de lista de botões.

Image

Um widget de imagem.

string

Texto que aparece na parte de cima de uma seção. Suporta texto simples formatado em HTML. Para mais informações sobre a formatação de texto, consulte Formatar texto em apps do Google Chat e Formatar texto em complementos do Google Workspace.

Widget

Todos os widgets da seção. Precisa conter pelo menos um widget.

bool

Indica se essa 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. Os usuários podem ocultar os widgets novamente clicando em Mostrar menos.

Para determinar quais widgets estão ocultos, especifique uncollapsibleWidgetsCount.

int32

O número de widgets não redimensionáveis que permanecem visíveis mesmo quando uma seção está recolhida.

Por exemplo, quando uma seção contém cinco widgets e 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 é levado em conta apenas quando collapsible é true.

CollapseControl

Opcional. Defina o botão de expansão e retração 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.

CarouselCard

Uma lista de cards incluídos no carrossel.

NestedWidget

Uma lista de widgets exibidos no card do carrossel. Os widgets são mostrados na ordem em que são especificados.

NestedWidget

Uma lista de widgets exibida na parte de baixo do card do carrossel. Os widgets são mostrados na ordem em que são especificados.

Icon

A imagem do ícone. Se icon e text forem definidos, o ícone vai aparecer antes do texto.

string

O texto exibido dentro do ícone.

OnClick

Opcional. A ação a ser realizada quando um usuário clicar no ícone, como abrir um hiperlink ou executar uma função personalizada.

bool

Indica se o ícone está em um estado ativo e responde às ações do usuário. O valor padrão é true. Obsoleto. Use disabled.

bool

Indica se o ícone está em um estado inativo e ignora as ações do usuário. O valor padrão é false.

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".

Layout

Layout da lista de ícones especificado.

Chip

Uma matriz de chips.

HorizontalAlignment

O alinhamento horizontal do botão de abrir e fechar.

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 vai entrar em vigor. Se esse campo não estiver definido, o botão padrão será usado.

Button

Opcional. Defina um botão personalizável para recolher a seção. Os campos expandButton e collapseButton precisam ser definidos. Apenas um conjunto de campos não vai entrar em vigor. Se esse campo não estiver definido, o botão padrão será usado.

Column

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

HorizontalSizeStyle

Especifica como uma coluna preenche a largura do card.

HorizontalAlignment

Especifica se os widgets são alinhados à esquerda, à direita ou ao centro de uma coluna.

VerticalAlignment

Especifica se os widgets são alinhados à parte de cima, de baixo ou ao centro de uma coluna.

Widgets

Uma matriz de widgets incluída em uma coluna. Os widgets aparecem na ordem em que são especificados.

TextParagraph

Widget de TextParagraph.

Image

Widget de Image.

DecoratedText

Widget de DecoratedText.

ButtonList

Widget de ButtonList.

TextInput

Widget de TextInput.

SelectionInput

Widget de SelectionInput.

DateTimePicker

Widget de DateTimePicker.

ChipList

Widget de ChipList.

HostAppDataActionMarkup

Define como atualizar os dados do Google Workspace.

string

O nome pelo qual o DateTimePicker é identificado em um evento de entrada de formulário.

Para saber mais sobre como trabalhar com entradas de formulário, consulte Receber dados de formulário.

string

O texto que solicita que os usuários insiram uma data, uma hora 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.

DateTimePickerType

Se o widget aceita a entrada de uma data, uma hora ou a data e a hora.

int64

O valor padrão exibido no widget, em milissegundos desde a é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 do calendário às 00:00:00 UTC. Por exemplo, para representar 1º de janeiro de 2023, use 1672531200000.
• TIME_ONLY: um horário no fuso UTC. Por exemplo, para representar 12h, use 43200000 (ou 12 * 60 * 60 * 1000).

int32

O número que representa a compensação de fuso horário em relação ao UTC, em minutos. Se definido, o value_ms_epoch 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.

Action

Acionado quando o usuário clica em Salvar ou Limpar na interface DateTimePicker.

Icon

Descontinuado em favor de startIcon.

Icon

O ícone exibido na frente do texto.

string

O texto que aparece acima de text. Sempre trunca.

string

Obrigatório. O texto principal.

Suporta formatação simples. Para mais informações sobre a formatação de texto, consulte Formatar texto em apps do Google Chat e Formatar texto em complementos do Google Workspace.

bool

A configuração de ajuste de texto. Se true, o texto é quebrado e mostrado em várias linhas. Caso contrário, o texto é truncado.

Válido apenas para text, não para topLabel e bottomLabel.

string

O texto que aparece abaixo de text. Sempre envolve.

OnClick

Essa ação é acionada quando os usuários clicam em topLabel ou bottomLabel.

Button

Um botão em que o usuário pode clicar para acionar uma ação.

SwitchControl

Um widget de alternância que o usuário pode clicar para mudar o estado e acionar uma ação.

Icon

Um ícone exibido após o texto.

Suporte a ícones integrados e personalizados.

string

O nome pelo qual o widget de chave é identificado em um evento de entrada de formulário.

Para saber mais sobre como trabalhar com entradas de formulário, consulte Receber dados de formulário.

string

O valor inserido por um usuário, retornado como parte de um evento de entrada de formulário.

Para saber mais sobre como trabalhar com entradas de formulário, consulte Receber dados de formulário.

bool

Quando true, o interruptor é selecionado.

Action

A ação a ser realizada quando o estado do interruptor for alterado, como qual função executar.

ControlType

Como a chave aparece na interface do usuário.

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

Action

Para complementos no Google Chat, a ação que fecha uma caixa de diálogo.

Suggestions

string

Esse é um campo de esquema sem operação que pode estar presente na marcação para a verificação de sintaxe.

string

O texto que aparece no cabeçalho da grade.

GridItem

Os itens a serem mostrados na grade.

BorderStyle

O estilo de borda a ser aplicado a cada item da grade.

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 é mostrada (caixa de diálogo ou complementar).

OnClick

Esse callback é reutilizado por cada item da grade, mas com o identificador e o índice do item na lista de itens adicionados aos parâmetros do callback.

string

Um identificador especificado pelo usuário para este item de grade. Esse identificador é retornado nos parâmetros de callback onClick da grade mãe.

ImageComponent

A imagem que aparece no item da grade.

string

O título do item da grade.

string

O subtítulo do item da grade.

GridItemLayout

O layout a ser usado para o item da grade.

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 para o que o ícone mostra 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 um Button, o altText vai 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

O estilo de corte aplicado à imagem. Em alguns casos, a aplicação de um corte CIRCLE faz com que a imagem seja renderizada maior do que um ícone integrado.

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.

string

Mostre 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 compatíveis incluem .png e .jpg.

MaterialIcon

Mostre um dos ícones do Google Material Design.

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.

string

O URL HTTPS que hospeda a imagem.

Exemplo:

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

OnClick

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

string

O texto alternativo dessa imagem usado para acessibilidade.

string

O URL da imagem.

string

O rótulo de acessibilidade da imagem.

ImageCropStyle

O estilo de corte a ser aplicado à imagem.

BorderStyle

O estilo de borda a ser aplicado à imagem.

ImageCropType

O tipo de corte.

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
}

string

URL do link para retornar ao complemento.

string

Título do link para retornar ao complemento.

Card

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

string

O título que aparece no ícone inteligente para a visualização do link. Se não for definido, o ícone inteligente vai mostrar o cabeçalho do preview_card.

string

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

string

O nome do ícone definido no ícone do Google Material, por exemplo, check_box. Todos os nomes inválidos são abandonados e substituídos por uma string vazia, o que resulta na falha na renderização do ícone.

bool

Indica se o ícone é renderizado como preenchido. O valor padrão é “false”.

Para visualizar diferentes configurações de ícones, acesse Ícones de fonte do Google e ajuste as configurações em Personalizar.

int32

A espessura do traço do ícone. Escolha entre {100, 200, 300, 400, 500, 600, 700}. Se não estiver presente, o valor padrão será 400. Se outro valor for especificado, o valor padrão será usado.

Para visualizar diferentes configurações de ícones, acesse Ícones de fonte do Google e ajuste as configurações em Personalizar.

int32

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 ajustes de peso e têm um pequeno impacto no tamanho do símbolo. Escolha entre {-25, 0, 200}. Se não houver, o valor padrão será 0. Se outro valor for especificado, o valor padrão será usado.

Para visualizar diferentes configurações de ícones, acesse Ícones de fonte do Google e ajuste as configurações em Personalizar.

UpdateWidget

Para complementos no Google Chat, atualiza um widget em um card ou caixa de diálogo.

SelectionInputWidgetSuggestions

Para widgets selectionInput, uma matriz de itens sugeridos em um menu de múltipla seleção. Quando um menu de múltipla seleção usa uma fonte de dados externa para preencher os itens, o widget pode preencher dinamicamente as sugestões com base no que o usuário digita no menu. Para mais informações, consulte Coletar informações dos usuários do Google Chat.

SelectionItem

Uma matriz de itens selecionáveis que aparecem para um usuário depois que ele digita em um menu de seleção múltipla.

bool

Mostra todos os cards, exceto o card raiz.

bool

Tira um cartão.

string

Abre todos os cards acima do especificado com o nome do card.

Card

Insere um card na pilha.

Prévia para desenvolvedores: para caixas de diálogo no Google Chat, abre ou atualiza uma caixa de diálogo.

Card

Atualiza o card principal com um novo card e preserva os valores dos campos de formulário preenchidos. Para um campo não equivalente, o valor é descartado.

Prévia para desenvolvedores: para caixas de diálogo no Google Chat, abre ou atualiza uma caixa de diálogo.

EndNavigation

Para complementos no Google Chat, fecha uma caixa de diálogo.

string

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

Action

Se especificado, uma ação será acionada por esse onClick.

OpenLink

Se especificado, esse onClick aciona uma ação de abrir link.

Action

Um complemento aciona essa ação quando ela precisa abrir um link. Isso é diferente do open_link acima, porque precisa se comunicar com o servidor para receber o link. Portanto, é necessário algum trabalho de preparação para o cliente da Web antes que a resposta da ação de abrir link seja retornada.

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

Card

Um novo card é enviado para a pilha de cards após o clique, se especificado.

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

OverflowMenu

Se especificado, esse onClick abre um menu flutuante.

string

O URL a ser aberto.

OpenAs

Como abrir um link.

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

OnClose

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

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

OverflowMenuItem

Obrigatório. A lista de opções do menu.

Icon

O ícone exibido na frente do texto.

string

Obrigatório. O texto que identifica ou descreve o item para os usuários.

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.

bool

Indica se a opção do menu está desativada. O padrão é "false".

Action

A ação que os complementos podem usar para atualizar a interface.

Prévia para desenvolvedores: complementos no Google Chat.

HostAppActionMarkup

Ações processadas por apps de host individuais.

string

Esse é um campo de esquema sem operação que pode estar presente na marcação para a verificação de sintaxe.

Navigation

Empurra, abre ou atualiza um card.

Prévia para desenvolvedores: complementos no Google Chat.

OpenLink

Abre o link de destino em uma nova guia ou janela pop-up.

Notification

Mostra uma notificação no aplicativo do Google Workspace de destino quando um usuário interage com um card.

Prévia para desenvolvedores: para complementos no Google Chat, mostra uma notificação quando os usuários enviam e fecham uma caixa de diálogo.

LinkPreview

Disponível nos apps Documentos, Planilhas e Apresentações Google. Visualizar links com ícones inteligentes e cartão. Para saber mais, consulte Visualizar links com ícones inteligentes.

Link

Disponível nos Documentos Google. Retorna um link de um recurso de terceiros e o converte em um ícone inteligente no aplicativo host. Formatado como uma matriz de objetos com um item.

Para mais informações, consulte Criar recursos de terceiros com o menu "@".

ModifyCard

Para complementos no Google Chat, atualiza um card com base na interação do usuário. A matriz precisa conter apenas um objeto.

string

Obrigatório. O nome que identifica a entrada de seleção em um evento de entrada de formulário.

Para saber mais sobre como trabalhar com entradas de formulário, consulte Receber dados de formulário.

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 pode ser "Urgência" ou "Selecionar urgência".

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 selecionar uma ou mais caixas de seleção, mas só podem selecionar um valor em um menu suspenso.

SelectionItem

Uma matriz de itens selecionáveis. Por exemplo, uma matriz de botões de opção ou caixas de seleção. Suporta até 100 itens.

Action

Se especificado, o formulário será enviado quando a seleção mudar. Se não for especificado, você vai precisar especificar um botão separado que envie o formulário.

Para saber mais sobre como trabalhar com entradas de formulário, consulte Receber dados de formulário.

int32

Para menus de múltipla seleção, 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.

int32

Para menus de múltipla escolha, o número de caracteres de texto que um usuário insere antes que o menu retorne os itens de seleção sugeridos.

Se não for definido, o menu de seleção múltipla vai 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 os itens sugeridos.

Action

Uma fonte de dados externa, como um banco de dados relacional.

PlatformDataSource

Uma fonte de dados do Google Workspace.

CommonDataSource

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

HostAppDataSourceMarkup

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

Esse campo oferece suporte às 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.

string

O texto que identifica ou descreve o item para os usuários.

string

O valor associado a esse item. O cliente precisa usar esse valor como um valor de entrada de formulário.

Para saber mais sobre como trabalhar com entradas de formulário, consulte Receber dados de formulário.

bool

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.

string

Para menus de múltipla seleção, 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.

string

Para menus de múltipla escolha, uma descrição de texto ou um rótulo exibido abaixo do campo text do item.

RenderActions

Um conjunto de instruções de renderização que informa ao card para realizar uma ação e/ou informa ao app de complemento para realizar uma ação específica do app.

bool

Se o estado dos cards mudou e os dados nos cards atuais estão desatualizados.

string

Esse é um campo de esquema sem operação que pode estar presente na marcação para a verificação de sintaxe.

SuggestionItem

Uma lista de sugestões usadas para recomendações de preenchimento automático em campos de entrada de texto.

string

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

string

O nome pelo qual a entrada de texto é identificada em um evento de entrada de formulário.

Para saber mais sobre como trabalhar com entradas de formulário, consulte Receber dados de formulário.

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 estiver especificado. Caso contrário, é opcional.

string

Texto que aparece abaixo do campo de entrada de texto para ajudar os usuários a inserir um determinado valor. Esse texto está sempre visível.

Obrigatório se label não estiver especificado. Caso contrário, é opcional.

string

O valor inserido por um usuário, retornado como parte de um evento de entrada de formulário.

Para saber mais sobre como trabalhar com entradas de formulário, consulte Receber dados de formulário.

Type

Como um campo de entrada de texto aparece na interface do usuário. Por exemplo, se o campo é de linha única ou múltipla.

Action

O que fazer quando uma mudança ocorre no campo de entrada de texto. Por exemplo, um usuário adicionando ou excluindo texto.

Exemplos de ações incluem executar uma função personalizada ou abrir uma caixa de diálogo no Google Chat.

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 os usuários 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 é filtrada para mostrar apenas Java e JavaScript.

Os valores sugeridos ajudam a orientar 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 interação dos usuários 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.

Action

Opcional. Especifique a ação a ser realizada quando o campo de entrada de texto oferecer 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 executa 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.

Validation

Especifique a validação do formato de entrada necessária para este campo de texto.

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

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.

string

O texto mostrado no widget.

int32

O número máximo de linhas de texto exibidas no widget. Se o texto exceder o número máximo especificado de linhas, o conteúdo excedente será ocultado por um botão mostrar mais. Se o texto for igual ou menor que o número máximo especificado de linhas, o botão mostrar mais não será exibido.

O valor padrão é 0. Nesse caso, todo o contexto é mostrado. Valores negativos são ignorados.

int32

Especifique o limite de caracteres para widgets de entrada de texto. Ele é usado apenas para entrada de texto e é ignorado para outros widgets.

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

InputType

Especifique o tipo dos widgets de entrada.

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

HorizontalAlignment

Especifica se os widgets são alinhados à esquerda, à direita ou ao centro de uma coluna.

TextParagraph

Mostra um parágrafo de texto. Suporta texto simples formatado em HTML. Para mais informações sobre a formatação de texto, consulte 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

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

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

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

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

Mostra um controle de seleção que permite que os usuários selecionem 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 que os usuários escolham 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

Mostra 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 hora para agendar um horário:

"dateTimePicker": {
  "name": "appointment_time",
  "label": "Book your appointment at:",
  "type": "DATE_AND_TIME",
  "valueMsEpoch": "796435200000"
}

Divider

Mostra uma linha horizontal entre os widgets.

Por exemplo, o JSON a seguir cria um divisor:

"divider": {
}

Grid

Mostra uma grade com uma coleção de itens.

Uma grade oferece suporte a qualquer número de colunas e itens. O número de linhas é determinado pelos limites superiores do número de itens dividido 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

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 que contêm 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

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

Uma lista de ícones.

Por exemplo, o JSON a seguir cria dois ícones. 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"
        }
      }
    }
  ]
}