Cartas
Um card é um elemento da interface que pode conter widgets, como texto e imagens.
Representação JSON |
---|
{ "header": { object ( |
Campos | |
---|---|
header
|
O cabeçalho do card. Geralmente, um cabeçalho contém um título e uma imagem. |
sections[]
|
As seções são separadas por um divisor de linha. |
card
|
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 ocupará uma linha. Se apenas o título for especificado, ele ocupará as duas linhas. |
subtitle
|
O subtítulo do cabeçalho do cartão. |
image
|
O tipo da imagem (por exemplo, borda quadrada ou circular). |
image
|
O URL da imagem no cabeçalho do card. |
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 especificados. Em todas as plataformas, os cards têm uma largura fixa estreita. Por isso, no momento não é necessário usar propriedades de layout (por exemplo, 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 nos apps do Google Chat e Formatar texto nos complementos do Google Workspace. |
widgets[]
|
Uma seção precisa conter pelo menos um widget. |
WidgetMarkup
Um widget é um elemento da 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 . Uma
WidgetMarkup
só pode ter um dos seguintes itens. É possível usar vários campos
WidgetMarkup
para mostrar mais itens.
data
pode ser apenas de um dos tipos a seguir:
|
|
text
|
Exibir um parágrafo de texto neste widget. |
image
|
Mostre uma imagem neste widget. |
key
|
Exiba um item de chave-valor neste widget. |
TextParagraph
Um parágrafo de texto. Suporte a texto formatado. Para mais informações sobre a formatação de texto, consulte Como formatar texto em apps do Google Chat e Como 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 | |
---|---|
image
|
É o URL da imagem. |
on
|
A
ação
|
aspect
|
A proporção da imagem (largura e altura). Esse campo permite reservar a altura correta para a imagem enquanto ela é carregada. Ela não substitui a proporção integrada da imagem. Se não for definido, o servidor vai preencher o campo com a 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 |
open
|
Essa ação
|
FormAction
Uma ação de formulário descreve o comportamento quando o formulário é enviado. Por exemplo, é possível invocar o Apps Script para processar o formulário.
Representação JSON |
---|
{
"actionMethodName": string,
"parameters": [
{
object ( |
Campos | |
---|---|
action
|
O nome do método é usado para identificar qual parte do formulário acionou o envio. Essas informações são enviadas de volta ao app Chat como parte do evento de clique no card. É possível 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 for invocado. Por exemplo, considere três botões de soneca: soneca agora, soneca um dia e soneca próxima semana. Você pode usar
action method = snooze()
, transmitindo o tipo e o tempo de suspensão na lista de parâmetros de string.
Representação JSON |
---|
{ "key": string, "value": string } |
Campos | |
---|---|
key
|
O 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 (rótulo) 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 | |
---|---|
top
|
O texto do marcador superior. Suporte a texto formatado. Para mais informações sobre a formatação de texto, consulte Como formatar texto em apps do Google Chat e Como formatar texto em complementos do Google Workspace. |
content
|
O texto do conteúdo. Texto formatado é permitido e sempre obrigatório. Para mais informações sobre a formatação de texto, consulte Como formatar texto em apps do Google Chat e Como formatar texto em complementos do Google Workspace. |
content
|
Se o conteúdo precisa ser multilinha. |
bottom
|
O texto do rótulo de baixo. Suporte a texto formatado. Para mais informações sobre a formatação de texto, consulte Como formatar texto em apps do Google Chat e Como formatar texto em complementos do Google Workspace. |
on
|
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 um dos seguintes:
|
|
icon
|
Um valor de tipo enumerado que é substituído pela API Chat pela imagem de ícone correspondente. |
icon
|
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. |
Ícone
O conjunto de ícones aceitos.
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
|
|
text
|
Um botão com texto e
ação
|
image
|
Um botão com imagem e
ação
|
TextButton
Um botão com texto e
ação
onclick
.
Representação JSON |
---|
{
"text": string,
"onClick": {
object ( |
Campos | |
---|---|
text
|
O texto do botão. |
on
|
A ação
|
ImageButton
Um botão de imagem com uma
ação
onclick
.
Representação JSON |
---|
{ "onClick": { object ( |
Campos | |
---|---|
on
|
A
ação
|
name
|
O nome do
|
Campo de união
icons . O ícone pode ser especificado por um
Icon
enum
ou um URL.
icons
pode ser apenas um dos seguintes:
|
|
icon
|
O ícone especificado por um
|
icon
|
O ícone especificado por um URL. |
CardAction
A ação do card é a ação associada a ele. Para um card de fatura, uma ação típica seria: excluir a fatura, enviar a fatura por e-mail ou abrir a fatura no navegador.
Não é compatível com os apps do Google Chat.
Representação JSON |
---|
{
"actionLabel": string,
"onClick": {
object ( |
Campos | |
---|---|
action
|
O rótulo usado para mostrar o item do menu de ações. |
on
|
A ação "onclick" deste item de ação. |