Card
Um card é um elemento da interface que pode conter widgets de interface, como texto e imagens.
Representação JSON |
---|
{ "header": { object ( |
Campos | |
---|---|
header
|
O cabeçalho do cartão. O cabeçalho geralmente contém um título e uma imagem. |
sections[]
|
As seções são separadas por um divisor de linhas. |
cardActions[]
|
As ações deste card. |
name
|
Nome do cartão. |
CardHeader
Representação JSON |
---|
{
"title": string,
"subtitle": string,
"imageStyle": enum (
|
Campos | |
---|---|
title
|
O título precisa ser especificado. 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. |
imageStyle
|
O tipo da imagem (por exemplo, borda quadrada ou circular). |
imageUrl
|
O URL da imagem no cabeçalho do cartão. |
ImageStyle
Enums | |
---|---|
IMAGE_STYLE_UNSPECIFIED
|
|
IMAGE
|
Borda quadrada. |
AVATAR
|
Borda circular. |
Seção
Uma seção contém uma coleção de widgets que são renderizados (verticalmente) na ordem em que são especificadas. Em todas as plataformas, os cards têm uma largura fixa. Por isso, não é necessário ter propriedades de layout (por exemplo, ponto flutuante).
Representação JSON |
---|
{
"header": string,
"widgets": [
{
object (
|
Campos | |
---|---|
header
|
O cabeçalho da seção. É possível usar 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. |
widgets[]
|
Uma seção precisa conter pelo menos um widget. |
WidgetMarkup
Um widget é um elemento de interface que apresenta texto e imagens.
Representação JSON |
---|
{ "buttons": [ { object ( |
Campos | |
---|---|
buttons[]
|
Uma lista de botões. Os botões também são
|
Campo de união data . Um
WidgetMarkup
só pode ter um dos itens a seguir. Você pode usar vários campos WidgetMarkup para exibir mais itens.
data
pode ser apenas de um dos tipos a seguir:
|
|
textParagraph
|
Exiba um parágrafo de texto neste widget. |
image
|
Mostre uma imagem neste widget. |
keyValue
|
Exiba um item de chave-valor neste widget. |
TextParagraph
Um parágrafo de texto. Compatível com 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.
Representação JSON |
---|
{ "text": string } |
Campos | |
---|---|
text
|
|
Imagem
Uma imagem especificada por um URL e que pode ter uma ação onclick
.
Representação JSON |
---|
{
"imageUrl": string,
"onClick": {
object (
|
Campos | |
---|---|
imageUrl
|
É o URL da imagem. |
onClick
|
A
ação
|
aspectRatio
|
É a proporção da imagem (largura e altura). Esse campo permite reservar a altura correta para a imagem enquanto aguarda o carregamento. Ele não substitui a proporção integrada da imagem. Se ela não for definida, o servidor a preencherá com uma pré-busca da imagem. |
OnClick
Uma
ação
onclick
(por exemplo, abrir um link).
Representação JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de união
|
|
action
|
Uma ação de formulário é acionada por esta ação |
openLink
|
Esta ação |
FormAction
Uma ação de formulário descreve o comportamento quando o formulário é enviado. Por exemplo, você pode invocar o Apps Script para processar o formulário.
Representação JSON |
---|
{
"actionMethodName": string,
"parameters": [
{
object (
|
Campos | |
---|---|
actionMethodName
|
O nome do método é usado para identificar qual parte do formulário acionou o envio. Essas informações são ecoadas no app do Chat como parte do evento de clique no cartão. Você pode usar o mesmo nome de método para vários elementos que acionam um comportamento comum. |
parameters[]
|
Lista de parâmetros de ação. |
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, soneca um dia, soneca próxima semana. Você pode usar action method = snooze()
, passando o tipo e o tempo de adiamento na lista de parâmetros de string.
Representação JSON |
---|
{ "key": string, "value": string } |
Campos | |
---|---|
key
|
Nome do parâmetro do script de ação. |
value
|
O valor do parâmetro. |
OpenLink
Um link que abre uma nova janela.
Representação JSON |
---|
{ "url": string } |
Campos | |
---|---|
url
|
O URL a ser aberto. |
KeyValue
Um elemento da interface contém uma chave (marcador) e um valor (conteúdo). Esse elemento também pode conter algumas ações, como o
botão
onclick
.
Representação JSON |
---|
{ "topLabel": string, "content": string, "contentMultiline": boolean, "bottomLabel": string, "onClick": { object ( |
Campos | |
---|---|
topLabel
|
O texto da etiqueta superior. Compatível com 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. |
content
|
O texto do conteúdo. O texto formatado é compatível e é sempre obrigatório. 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. |
contentMultiline
|
Se o conteúdo precisar ser multilinha. |
bottomLabel
|
O texto da etiqueta inferior. Compatível com 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. |
onClick
|
A
ação
|
Campo de união icons . Pelo menos um dos ícones,
top_label
e
bottom_label
precisa ser definido.
icons
pode ser apenas de um dos tipos a seguir:
|
|
icon
|
Um valor de enumeração que é substituído pela API do Chat pela imagem do ícone correspondente. |
iconUrl
|
O ícone especificado por um URL. |
Campo de união control . Um widget de controle. É possível definir button ou switch_widget , mas não ambos.
control
pode ser apenas de um dos tipos a seguir:
|
|
button
|
Um botão que pode ser clicado para acionar uma ação. |
Icon
O conjunto de ícones compatíveis.
Enums | |
---|---|
ICON_UNSPECIFIED
|
|
AIRPLANE
|
|
BOOKMARK
|
|
BUS
|
|
CAR
|
|
CLOCK
|
|
CONFIRMATION_NUMBER_ICON
|
|
DOLLAR
|
|
DESCRIPTION
|
|
EMAIL
|
|
EVENT_PERFORMER
|
|
EVENT_SEAT
|
|
FLIGHT_ARRIVAL
|
|
FLIGHT_DEPARTURE
|
|
HOTEL
|
|
HOTEL_ROOM_TYPE
|
|
INVITE
|
|
MAP_PIN
|
|
MEMBERSHIP
|
|
MULTIPLE_PEOPLE
|
|
OFFER
|
|
PERSON
|
|
PHONE
|
|
RESTAURANT_ICON
|
|
SHOPPING_CART
|
|
STAR
|
|
STORE
|
|
TICKET
|
|
TRAIN
|
|
VIDEO_CAMERA
|
|
VIDEO_PLAY
|
Botão
Um botão. Pode ser um botão de texto ou de imagem.
Representação JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de união
|
|
textButton
|
Um botão com texto e ação |
imageButton
|
Um botão com imagem e
|
TextButton
Um botão com texto e ação onclick
.
Representação JSON |
---|
{
"text": string,
"onClick": {
object (
|
Campos | |
---|---|
text
|
O texto do botão. |
onClick
|
A
ação
|
ImageButton
Um botão de imagem com uma ação onclick
.
Representação JSON |
---|
{ "onClick": { object ( |
Campos | |
---|---|
onClick
|
A
ação
|
name
|
O nome da
|
Campo de união icons . O ícone pode ser especificado por um Icon
enum ou um URL.
icons
pode ser apenas de um dos tipos a seguir:
|
|
icon
|
O ícone especificado por um
|
iconUrl
|
O ícone especificado por um URL. |
CardAction
Uma ação do card é a ação associada ao cartão. Para um cartão de fatura, uma ação típica seria: excluir a fatura, enviar a fatura por e-mail ou abrir a fatura no navegador.
Indisponível nos apps do Google Chat.
Representação JSON |
---|
{
"actionLabel": string,
"onClick": {
object (
|
Campos | |
---|---|
actionLabel
|
O rótulo usado para aparecer no item do menu de ações. |
onClick
|
A ação "onclick" para este item de ação. |