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 cartões.
Exemplo: mensagem com card para um app do Google Chat
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"
}
]
}
}
}
]
}
}
]
}
]
}
}
]
}
Representação JSON |
---|
{ "header": { object ( |
Campos | |
---|---|
header
|
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[]
|
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 conferir um exemplo nos apps do Google Chat, consulte Definir uma seção de um card. |
sectionDividerStyle
|
O estilo de divisor entre as seções. |
cardActions[]
|
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 de card com as opções
|
name
|
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
|
O rodapé fixo mostrado na parte inferior deste card.
Definir
Disponível para apps do Google Chat e complementos do Google Workspace. |
displayStyle
|
Em complementos do Google Workspace, define as propriedades de exibição de
Disponível para complementos do Google Workspace e indisponível para apps do Google Chat. |
peekCardHeader
|
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. |
CardHeader
Representa um cabeçalho de card. Para conferir um exemplo nos apps do Google Chat, consulte Adicionar um cabeçalho.
Disponível para apps do Google Chat e complementos do Google Workspace.
Representação JSON |
---|
{
"title": string,
"subtitle": string,
"imageType": enum (
|
Campos | |
---|---|
title
|
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
|
O subtítulo do cabeçalho do cartão. Se especificado, aparece na própria linha abaixo de |
imageType
|
O formato usado para cortar a imagem. Disponível para apps do Google Chat e complementos do Google Workspace. |
imageUrl
|
O URL HTTPS da imagem no cabeçalho do cartão. |
imageAltText
|
O texto alternativo dessa imagem que é usado para acessibilidade. |
ImageType
O formato usado para cortar a imagem.
Disponível para apps do Google Chat e complementos do Google Workspace.
Enums | |
---|---|
SQUARE
|
Valor padrão. Aplica uma máscara quadrada à imagem. Por exemplo, uma imagem 4 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. |
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.
Representação JSON |
---|
{
"header": string,
"widgets": [
{
object (
|
Campos | |
---|---|
header
|
Texto que aparece na parte de cima de uma seção. Compatível com texto formatado em HTML 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. |
widgets[]
|
Todos os widgets da seção. Precisa conter pelo menos um widget. |
collapsible
|
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 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
|
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
|
Widget
Cada card é composto por widgets.
Um widget é um objeto composto que pode representar texto, imagens, botões e outros tipos de objetos.
Representação JSON |
---|
{ "horizontalAlignment": enum ( |
Campos | |
---|---|
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
|
Mostra um parágrafo de texto. Compatível com texto formatado em HTML 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. Por exemplo, o JSON a seguir cria um texto em negrito:
|
image
|
Exibe uma imagem. Por exemplo, o JSON a seguir cria uma imagem com texto alternativo:
|
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:
|
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:
|
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:
Como outro exemplo, o JSON a seguir cria uma entrada de texto para uma linguagem de programação com sugestões estáticas:
|
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:
|
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:
|
divider
|
Exibe um divisor de linhas horizontal entre widgets. Por exemplo, o JSON a seguir cria um divisor:
|
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:
|
columns
|
Exibe até duas colunas.
Para incluir mais de duas colunas ou usar linhas, utilize o widget Por exemplo, o JSON a seguir cria duas colunas, cada uma contendo parágrafos de texto:
|
TextParagraph
Um parágrafo de texto com suporte para formatação. Para conferir um exemplo nos apps do Google Chat, consulte Adicionar um parágrafo de texto formatado. 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.
Disponível para apps do Google Chat e complementos do Google Workspace.
Representação JSON |
---|
{ "text": string } |
Campos | |
---|---|
text
|
O texto que é mostrado no widget. |
Imagem
Uma imagem especificada por um URL e que pode ter uma ação onClick
. Para ver um exemplo, consulte Adicionar uma imagem.
Disponível para apps do Google Chat e complementos do Google Workspace.
Representação JSON |
---|
{
"imageUrl": string,
"onClick": {
object (
|
Campos | |
---|---|
imageUrl
|
O URL HTTPS que hospeda a imagem. Exemplo:
|
onClick
|
Quando um usuário clica na imagem, o clique aciona a ação. |
altText
|
O texto alternativo dessa imagem que é usado para acessibilidade. |
OnClick
Representa como responder quando os usuários clicam em um elemento interativo em um card, como um botão.
Disponível para apps do Google Chat e complementos do Google Workspace.
Representação JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de união
|
|
action
|
Se especificado, uma ação será acionada por este
|
openLink
|
Se especificado, este
|
openDynamicLinkAction
|
Um complemento aciona essa ação quando é necessário abrir um link. Ele é diferente do
Disponível para complementos do Google Workspace e indisponível para apps do Google Chat. |
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. |
Ação
Uma ação que descreve o comportamento quando o formulário é enviado. Por exemplo, você pode invocar um script do Apps Script para processar o formulário. Se a ação for acionada, os valores do formulário serão enviados ao servidor.
Disponível para apps do Google Chat e complementos do Google Workspace.
Representação JSON |
---|
{ "function": string, "parameters": [ { object ( |
Campos | |
---|---|
function
|
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[]
|
Lista de parâmetros de ação. |
loadIndicator
|
Especifica o indicador de carregamento que a ação exibe ao fazer a chamada. |
persistValues
|
Indica se os valores do formulário persistem após a ação. O valor padrão é
Se for
Se for |
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 um
Ao especificar um Disponível para apps do Google Chat e indisponível para complementos do Google Workspace. |
requiredWidgets[]
|
Opcional. Preencha a lista com os nomes dos widgets necessários para essa ação para um envio válido.
Se os widgets listados aqui não tiverem um valor quando essa Ação for invocada, o envio do formulário será cancelado. Disponível para apps do Google Chat e complementos do Google Workspace. |
allWidgetsAreRequired
|
Opcional. Se for verdadeiro, todos os widgets serão considerados obrigatórios por essa ação.
Disponível para apps do Google Chat e complementos do Google Workspace. |
ActionParameter
Lista de parâmetros de string a serem fornecidos quando o método de ação é invocado. Por exemplo, considere três botões de soneca: "Adiar agora", "Adiar um dia" ou "Adiar na próxima semana". Você pode usar action method = snooze()
, passando o tipo e o tempo de adiamento na lista de parâmetros de string.
Para saber mais, consulte
CommonEventObject
.
Disponível para apps do Google Chat e complementos do Google Workspace.
Representação JSON |
---|
{ "key": string, "value": string } |
Campos | |
---|---|
key
|
Nome do parâmetro do script de ação. |
value
|
O valor do parâmetro. |
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. |
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 um
action
,
como abrir um link ou executar uma função, como normal.
Ao especificar um 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. O
action
é executado 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. |
OpenLink
Representa um evento onClick
que abre um hiperlink.
Disponível para apps do Google Chat e complementos do Google Workspace.
Representação JSON |
---|
{ "url": string, "openAs": enum ( |
Campos | |
---|---|
url
|
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 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. |
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
é compatível com 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. |
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 aceitar os dois valores,
OnClose
vai 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. |
RELOAD
|
Recarrega o card depois que a janela filha é fechada.
Se usada com
|
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.
Representação JSON |
---|
{ "icon": { object ( |
Campos | |
---|---|
icon
|
Descontinuado e substituído por
|
startIcon
|
O ícone exibido na frente do texto. |
topLabel
|
O texto que aparece acima de
|
text
|
Obrigatório. O texto principal. Compatível com 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. |
wrapText
|
A configuração de ajuste de texto. Se for
Só se aplica a
|
bottomLabel
|
O texto que aparece abaixo de |
onClick
|
Esta ação é acionada quando os usuários clicam em
|
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
|
Um botão em que o usuário pode clicar para acionar uma ação. |
switchControl
|
É um widget de alternância em que o usuário pode clicar para mudar o estado e acionar uma ação. |
endIcon
|
Ícone exibido após o texto. Oferece suporte a ícones integrados e personalizados. |
Icon
Um ícone exibido em um widget em um card. Para ver um exemplo nos apps do Google Chat, consulte Adicionar um ícone.
Oferece suporte a ícones integrados e personalizados.
Disponível para apps do Google Chat e complementos do Google Workspace.
Representação JSON |
---|
{ "altText": string, "imageType": enum ( |
Campos | |
---|---|
altText
|
Opcional. Uma descrição do ícone usado para acessibilidade. Se não for especificado, o valor padrão
Se o ícone estiver definido em um |
imageType
|
Estilo de corte aplicado à imagem. Em alguns casos, aplicar um corte |
Campo de união icons . O ícone exibido no widget do card.
icons
pode ser apenas de um dos tipos a seguir:
|
|
knownIcon
|
Exiba um dos ícones integrados fornecidos pelo Google Workspace.
Por exemplo, para mostrar um ícone de avião, especifique
Para uma lista completa de ícones compatíveis, consulte ícones integrados. |
iconUrl
|
Exiba um ícone personalizado hospedado em um URL HTTPS. Exemplo:
Os tipos de arquivos aceitos são
|
materialIcon
|
Mostre um dos ícones do Google Material Design. Por exemplo, para exibir um ícone de caixa de seleção, use
Disponível para apps do Google Chat e indisponível para complementos do Google Workspace. |
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.
Representação JSON |
---|
{ "name": string, "fill": boolean, "weight": integer, "grade": integer } |
Campos | |
---|---|
name
|
O nome do ícone definido no
ícone do Material Design do Google (link em inglês), por exemplo,
|
fill
|
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 Customize. |
weight
|
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 Customize. |
grade
|
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 Customize. |
Botão
Um texto, ícone ou texto e botão de ícone em que os usuários podem clicar. Para ver um exemplo nos apps do Google Chat, consulte Adicionar um botão.
Para transformar uma imagem em um botão clicável, especifique um
(não um
Image
) e defina uma
ação
ImageComponent
onClick
.
Disponível para apps do Google Chat e complementos do Google Workspace.
Representação JSON |
---|
{ "text": string, "icon": { object ( |
Campos | |
---|---|
text
|
O texto exibido dentro do botão. |
icon
|
A imagem do ícone. Se
|
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
Você também pode definir
Para
Por exemplo, a cor a seguir representa um vermelho meio transparente:
|
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
|
Se for |
altText
|
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". |
Cor
Representa uma cor no espaço de cores RGBA. Essa representação foi projetada para simplificar a conversão de e para representações de cores em vários idiomas, em vez de ser mais compacto. Por exemplo, os campos dessa representação podem ser trivialmente fornecidos ao construtor de java.awt.Color
em Java, eles também podem ser fornecidos ao método +colorWithRed:green:blue:alpha
da UIColor no iOS e, com um pouco de trabalho, podem ser facilmente formatados em uma string CSS rgba()
em JavaScript.
Esta página de referência não tem informações sobre o espaço de cor absoluto que deve ser usado para interpretar o valor RGB, por exemplo, sRGB, Adobe RGB, DCI-P3 e BT.2020. Por padrão, os aplicativos consideram o espaço de cores sRGB.
Quando a igualdade de cores precisa ser decidida, as implementações (a menos que seja documentada de outra forma) tratam duas cores como iguais se todos os valores vermelho, verde, azul e alfa tiverem uma diferença no máximo em
1e-5
.
Exemplo (Java):
import com.google.type.Color;
// ...
public static java.awt.Color fromProto(Color protocolor) {
float alpha = protocolor.hasAlpha()
? protocolor.getAlpha().getValue()
: 1.0;
return new java.awt.Color(
protocolor.getRed(),
protocolor.getGreen(),
protocolor.getBlue(),
alpha);
}
public static Color toProto(java.awt.Color color) {
float red = (float) color.getRed();
float green = (float) color.getGreen();
float blue = (float) color.getBlue();
float denominator = 255.0;
Color.Builder resultBuilder =
Color
.newBuilder()
.setRed(red / denominator)
.setGreen(green / denominator)
.setBlue(blue / denominator);
int alpha = color.getAlpha();
if (alpha != 255) {
result.setAlpha(
FloatValue
.newBuilder()
.setValue(((float) alpha) / denominator)
.build());
}
return resultBuilder.build();
}
// ...
Exemplo (iOS/Obj-C):
// ...
static UIColor* fromProto(Color* protocolor) {
float red = [protocolor red];
float green = [protocolor green];
float blue = [protocolor blue];
FloatValue* alpha_wrapper = [protocolor alpha];
float alpha = 1.0;
if (alpha_wrapper != nil) {
alpha = [alpha_wrapper value];
}
return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
}
static Color* toProto(UIColor* color) {
CGFloat red, green, blue, alpha;
if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
return nil;
}
Color* result = [[Color alloc] init];
[result setRed:red];
[result setGreen:green];
[result setBlue:blue];
if (alpha <= 0.9999) {
[result setAlpha:floatWrapperWithValue(alpha)];
}
[result autorelease];
return result;
}
// ...
Exemplo (JavaScript):
// ...
var protoToCssColor = function(rgb_color) {
var redFrac = rgb_color.red || 0.0;
var greenFrac = rgb_color.green || 0.0;
var blueFrac = rgb_color.blue || 0.0;
var red = Math.floor(redFrac * 255);
var green = Math.floor(greenFrac * 255);
var blue = Math.floor(blueFrac * 255);
if (!('alpha' in rgb_color)) {
return rgbToCssColor(red, green, blue);
}
var alphaFrac = rgb_color.alpha.value || 0.0;
var rgbParams = [red, green, blue].join(',');
return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
};
var rgbToCssColor = function(red, green, blue) {
var rgbNumber = new Number((red << 16) | (green << 8) | blue);
var hexString = rgbNumber.toString(16);
var missingZeros = 6 - hexString.length;
var resultBuilder = ['#'];
for (var i = 0; i < missingZeros; i++) {
resultBuilder.push('0');
}
resultBuilder.push(hexString);
return resultBuilder.join('');
};
// ...
Representação JSON |
---|
{ "red": number, "green": number, "blue": number, "alpha": number } |
Campos | |
---|---|
red
|
A quantidade de vermelho na cor como um valor no intervalo [0, 1]. |
green
|
A quantidade de verde na cor como um valor no intervalo [0, 1]. |
blue
|
A quantidade de azul na cor como um valor no intervalo [0, 1]. |
alpha
|
A fração desta cor que deve ser aplicada ao pixel. Ou seja, a cor final do pixel é definida pela equação:
Isto significa que um valor de 1,0 corresponde a uma cor sólida, enquanto um valor de 0,0 corresponde a uma cor completamente transparente. Esse recurso usa uma mensagem de wrapper, em vez de um escalar flutuante simples, para que seja possível distinguir entre um valor padrão e o valor que está sendo desativado. Se omitido, esse objeto de cor é renderizado como uma cor sólida (como se o valor alfa tivesse recebido explicitamente o valor 1,0). |
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
.
Representação JSON |
---|
{ "name": string, "value": string, "selected": boolean, "onChangeAction": { object ( |
Campos | |
---|---|
name
|
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
|
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
|
Quando
|
onChangeAction
|
A ação a ser realizada quando o estado do interruptor muda, como qual função será executada. |
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. |
ButtonList
Uma lista de botões dispostos horizontalmente. Para ver um exemplo nos apps do Google Chat, consulte Adicionar um botão.
Disponível para apps do Google Chat e complementos do Google Workspace.
Representação JSON |
---|
{
"buttons": [
{
object (
|
Campos | |
---|---|
buttons[]
|
Uma matriz de botões. |
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.
Representação JSON |
---|
{ "name": string, "label": string, "hintText": string, "value": string, "type": enum ( |
Campos | |
---|---|
name
|
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
|
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
Obrigatório se |
hintText
|
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 |
value
|
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
|
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
|
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. Exemplos de ações a serem realizadas incluem executar uma função personalizada ou abrir uma caixa de diálogo no Google Chat. |
initialSuggestions
|
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
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
Quando especificado,
Disponível para apps do Google Chat e complementos do Google Workspace. |
autoCompleteAction
|
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
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. |
validation
|
Especifique a validação necessária para esse campo de entrada de texto.
Disponível para apps do Google Chat e complementos do Google Workspace. |
placeholderText
|
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: 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. |
RenderActions
Um conjunto de instruções de renderização que instrui um cartão 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 | |
---|---|
action |
Ação
Campos | |
---|---|
navigations[] |
Envie ou atualize os cards exibidos. |
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 filtros de sugestões 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
. Sugerir
JavaScript
pode padronizar como os usuários interagem com seu app.
Quando especificado,
TextInput.type
é sempre
SINGLE_LINE
, mesmo que esteja definido como
MULTIPLE_LINE
.
Disponível para apps do Google Chat e complementos do Google Workspace.
Representação JSON |
---|
{
"items": [
{
object (
|
Campos | |
---|---|
items[]
|
Uma lista de sugestões usadas para recomendações de preenchimento automático em campos de entrada de texto. |
SuggestionItem
Um valor sugerido que os usuários podem inserir em um campo de entrada de texto.
Disponível para apps do Google Chat e complementos do Google Workspace.
Representação JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de união
|
|
text
|
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. |
Validação
Representa os dados necessários para validar o widget ao qual está anexado.
Disponível para apps do Google Chat e complementos do Google Workspace.
Representação JSON |
---|
{
"characterLimit": integer,
"inputType": enum (
|
Campos | |
---|---|
characterLimit
|
Especifique o limite de caracteres dos widgets de entrada de texto. Esse recurso é usado somente 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. |
InputType
O tipo do widget de entrada.
Enums | |
---|---|
INPUT_TYPE_UNSPECIFIED
|
Tipo não especificado. Não use. |
TEXT
|
Texto normal que aceita todos os caracteres. |
INTEGER
|
Um valor inteiro. |
FLOAT
|
Um valor flutuante. |
EMAIL
|
Um endereço de e-mail. |
EMOJI_PICKER
|
Um emoji no seletor fornecido pelo sistema. |
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 IU 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.
Representação JSON |
---|
{ "name": string, "label": string, "type": enum ( |
Campos | |
---|---|
name
|
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
|
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
|
O tipo de itens que são mostrados aos usuários em um widget |
items[]
|
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
|
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
|
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
|
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. |
validation
|
Nos menus suspensos, a validação deste campo de entrada de seleção.
Disponível para apps do Google Chat e complementos do Google Workspace. |
Campo de união
Disponível para apps do Google Chat e indisponível para complementos do Google Workspace.
|
|
externalDataSource
|
Uma fonte de dados externa, como um banco de dados relacional. |
platformDataSource
|
Uma fonte de dados do Google Workspace. |
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:
Para conferir exemplos de como implementar menus de seleção múltipla, consulte 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. |
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.
Representação JSON |
---|
{ "text": string, "value": string, "selected": boolean, "startIconUri": string, "bottomText": string } |
Campos | |
---|---|
text
|
É o texto que identifica ou descreve o item para os usuários. |
value
|
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
|
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
|
Para menus de seleção múltipla, o URL do ícone exibido ao lado do campo
|
bottomText
|
Para menus de seleção múltipla, uma descrição ou rótulo de texto que é exibido abaixo do campo
|
PlatformDataSource
Para um widget
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.
SelectionInput
Disponível para apps do Google Chat e indisponível para complementos do Google Workspace.
Representação JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de união data_source . A fonte de dados.
data_source
pode ser apenas de um dos tipos a seguir:
|
|
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
|
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 aplicativos do Google Workspace.
Disponível para apps do Google Chat e indisponível para complementos do Google Workspace.
Enums | |
---|---|
UNKNOWN
|
Valor padrão. Não use. |
USER
|
usuários do Google Workspace. O usuário só pode ver e selecionar usuários da organização do Google Workspace. |
HostAppDataSourceMarkup
Para um widget
que usa um menu de seleção múltipla, uma fonte de dados de um aplicativo do Google Workspace. A fonte de dados preenche os itens de seleção do menu de seleção múltipla.
SelectionInput
Disponível para apps do Google Chat e indisponível para complementos do Google Workspace.
Representação JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de união data_source . O app Google Workspace que preenche itens para um menu de seleção múltipla.
data_source
pode ser apenas de um dos tipos a seguir:
|
|
chatDataSource
|
Uma fonte de dados do Google Chat. |
ChatClientDataSourceMarkup
Para um widget
que usa um menu de seleção múltipla, uma fonte de dados do Google Chat. A fonte de dados preenche os itens de seleção do menu de seleção múltipla. Por exemplo, os usuários podem selecionar espaços do Google Chat de que participam.
SelectionInput
Disponível para apps do Google Chat e indisponível para complementos do Google Workspace.
Representação JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de união source . A fonte de dados do Google Chat.
source
pode ser apenas de um dos tipos a seguir:
|
|
spaceDataSource
|
Espaços do Google Chat de que o usuário participa. |
SpaceDataSource
Uma fonte de dados que preenche os espaços do Google Chat como itens de seleção para um menu de seleção múltipla. Só preenche os espaços de que o usuário participa.
Disponível para apps do Google Chat e indisponível para complementos do Google Workspace.
Representação JSON |
---|
{ "defaultToCurrentSpace": boolean } |
Campos | |
---|---|
defaultToCurrentSpace
|
Se definido como
|
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.
Representação JSON |
---|
{ "name": string, "label": string, "type": enum ( |
Campos | |
---|---|
name
|
O nome pelo qual o Para detalhes sobre como trabalhar com entradas de formulário, consulte Receber dados de formulário. |
label
|
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 rótulo como
|
type
|
Define se o widget é compatível com a inserção de uma data, hora ou data e hora. |
valueMsEpoch
|
O valor padrão exibido no widget, em milissegundos, a partir do horário da era Unix (link em inglês).
Especifique o valor com base no tipo de seletor (
|
timezoneOffsetDate
|
O número que representa a diferença do fuso horário em relação ao UTC, em minutos. Se definido, o
|
onChangeAction
|
Acionado quando o usuário clica em Salvar ou Limpar na interface |
validation
|
Opcional. Especifique a validação necessária para este seletor de datetimer.
Disponível para apps do Google Chat e complementos do Google Workspace. |
DateTimePickerType
Formato da data e 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. |
Separador
Esse tipo não tem campos.
Mostra um divisor entre widgets como uma linha horizontal. Para conferir um exemplo em apps do Google Chat, consulte Adicionar um divisor horizontal entre widgets.
Disponível para apps do Google Chat e complementos do Google Workspace.
Por exemplo, o JSON a seguir cria um divisor:
"divider": {}
Grade
Mostra uma grade com uma coleção de itens. Os itens só podem incluir texto ou imagens. Para colunas responsivas ou incluir mais do que texto ou imagens, use
. Para conferir um exemplo nos apps do Google Chat, consulte
Mostrar uma grade com uma coleção de itens.
Columns
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"
}
}
}
Representação JSON |
---|
{ "title": string, "items": [ { object ( |
Campos | |
---|---|
title
|
O texto que aparece no cabeçalho da grade. |
items[]
|
Os itens a serem exibidos na grade. |
borderStyle
|
O estilo de borda a ser aplicado a cada item da grade. |
columnCount
|
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
|
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.
Representação JSON |
---|
{ "id": string, "image": { object ( |
Campos | |
---|---|
id
|
Um identificador especificado pelo usuário para esse item da grade. Esse identificador é retornado nos parâmetros de callback |
image
|
A imagem que é exibida no item da grade. |
title
|
O título do item da grade. |
subtitle
|
O subtítulo do item da grade. |
layout
|
O layout a ser usado para o item da grade. |
ImageComponent
Representa uma imagem.
Disponível para apps do Google Chat e complementos do Google Workspace.
Representação JSON |
---|
{ "imageUri": string, "altText": string, "cropStyle": { object ( |
Campos | |
---|---|
imageUri
|
O URL da imagem. |
altText
|
O rótulo de acessibilidade da imagem. |
cropStyle
|
O estilo de corte a ser aplicado à imagem. |
borderStyle
|
O estilo de borda a ser aplicado à imagem. |
ImageCropStyle
Representa o estilo de corte aplicado a uma imagem.
Disponível para apps do Google Chat e complementos do Google Workspace.
Por exemplo, veja como aplicar uma proporção de 16:9:
cropStyle {
"type": "RECTANGLE_CUSTOM",
"aspectRatio": 16/9
}
Representação JSON |
---|
{
"type": enum (
|
Campos | |
---|---|
type
|
O tipo de corte. |
aspectRatio
|
A proporção a ser usada se o tipo de corte for
Por exemplo, veja como aplicar uma proporção de 16:9:
|
ImageCropType
Representa o estilo de corte aplicado a uma imagem.
Disponível para apps do Google Chat e complementos do Google Workspace.
Enums | |
---|---|
IMAGE_CROP_TYPE_UNSPECIFIED
|
Não use. Não especificado. |
SQUARE
|
Valor padrão. Aplica um corte quadrado. |
CIRCLE
|
Aplica um corte circular. |
RECTANGLE_CUSTOM
|
Aplica um corte retangular com uma proporção personalizada. Defina a proporção personalizada com
aspectRatio .
|
RECTANGLE_4_3
|
Aplica um corte retangular com uma proporção de 4:3. |
BorderStyle
As opções de estilo para a borda de um card ou widget, incluindo o tipo e a cor da borda.
Disponível para apps do Google Chat e complementos do Google Workspace.
Representação JSON |
---|
{ "type": enum ( |
Campos | |
---|---|
type
|
O tipo de borda. |
strokeColor
|
As cores a serem usadas quando o tipo for
|
cornerRadius
|
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. |
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. |
Coluna
O widget
Columns
exibe 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 conferir 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. Você pode 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.
Representação JSON |
---|
{
"columnItems": [
{
object (
|
Campos | |
---|---|
columnItems[]
|
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.
Representação JSON |
---|
{ "horizontalSizeStyle": enum ( |
Campos | |
---|---|
horizontalSizeStyle
|
Especifica como uma coluna preenche a largura do card. |
horizontalAlignment
|
Especifica se os widgets são alinhados à esquerda, à direita ou no centro de uma coluna. |
verticalAlignment
|
Especifica se os widgets são alinhados na parte superior, inferior ou no centro de uma coluna. |
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 do
HorizontalSizeStyle
e da largura dos widgets dentro da 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 | |
---|---|
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 estiverem 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. |
HorizontalAlignment
Especifica se os widgets são alinhados à esquerda, à direita ou no centro de uma coluna.
Disponível para apps do Google Chat e indisponível para complementos do Google Workspace.
Enums | |
---|---|
HORIZONTAL_ALIGNMENT_UNSPECIFIED
|
Não use. Não especificado. |
START
|
Valor padrão. Alinha 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. |
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.
Representação JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de união
|
|
textParagraph
|
|
image
|
|
decoratedText
|
|
buttonList
|
|
textInput
|
|
selectionInput
|
|
dateTimePicker
|
|
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. |
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.
Representação JSON |
---|
{
"actionLabel": string,
"onClick": {
object (
|
Campos | |
---|---|
actionLabel
|
O rótulo exibido como o item do menu de ações. |
onClick
|
A
ação
|
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. |