Cards v1

Card

Um card é um elemento da IU que pode conter widgets de IU, como texto e imagens.

Representação JSON
{
  "header": {
    object (CardHeader)
  },
  "sections": [
    {
      object (Section)
    }
  ],
  "cardActions": [
    {
      object (CardAction)
    }
  ],
  "name": string
}
Campos
header

object (CardHeader)

O cabeçalho do card. Um cabeçalho geralmente contém um título e uma imagem.

sections[]

object (Section)

As seções são separadas por um divisor de linhas.

cardActions[]

object (CardAction)

As ações deste card.

name

string

Nome do cartão.

Cabeçalho do cartão

Representação JSON
{
  "title": string,
  "subtitle": string,
  "imageStyle": enum (ImageStyle),
  "imageUrl": string
}
Campos
title

string

O título deve ser especificado. O cabeçalho tem uma altura fixa: se for especificado um título e um subtítulo, cada um deles ocupará uma linha. Se apenas o título for especificado, as duas linhas serão usadas.

subtitle

string

O subtítulo do cabeçalho do cartão.

imageStyle

enum (ImageStyle)

O tipo da imagem (por exemplo, borda quadrada ou borda circular).

imageUrl

string

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

Estilo de imagem

Enums
IMAGE_STYLE_UNSPECIFIED
IMAGE Borda quadrada.
AVATAR Borda circular.

Seção

Uma seção contém uma coleção de widgets renderizados (verticalmente) na ordem em que são especificados. Em todas as plataformas, os cards têm uma largura fixa restrita. Portanto, não é necessário ter propriedades de layout no momento (por exemplo, float).

Representação JSON
{
  "header": string,
  "widgets": [
    {
      object (WidgetMarkup)
    }
  ]
}
Campos
header

string

O cabeçalho da seção. O texto formatado é compatível. Para mais informações sobre formatação de texto, consulte Como formatar texto em apps do Google Chat e Como formatar texto em complementos do Google Workspace.

widgets[]

object (WidgetMarkup)

Uma seção deve conter pelo menos um widget.

WidgetMarkup

Um widget é um elemento de IU que apresenta texto e imagens.

Representação JSON
{
  "buttons": [
    {
      object (Button)
    }
  ],

  // Union field data can be only one of the following:
  "textParagraph": {
    object (TextParagraph)
  },
  "image": {
    object (Image)
  },
  "keyValue": {
    object (KeyValue)
  }
  // End of list of possible types for union field data.
}
Campos
buttons[]

object (Button)

Uma lista de botões. Os botões também são oneof data, e apenas um desses campos precisa ser definido.

Campo de união data. Um WidgetMarkup pode ter apenas um dos seguintes itens. É possível usar vários campos WidgetMarkup para exibir mais itens. data pode ser apenas uma das seguintes opções:
textParagraph

object (TextParagraph)

Exibir um parágrafo de texto neste widget.

image

object (Image)

Exibir uma imagem neste widget.

keyValue

object (KeyValue)

Exibe um item de valor-chave neste widget.

Parágrafo do texto

Um parágrafo. Texto formatado compatível. Para mais informações sobre 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

string

Imagem

Uma imagem especificada por um URL e que pode ter uma ação onclick.

Representação JSON
{
  "imageUrl": string,
  "onClick": {
    object (OnClick)
  },
  "aspectRatio": number
}
Campos
imageUrl

string

É o URL da imagem.

onClick

object (OnClick)

A ação onclick.

aspectRatio

number

A proporção desta imagem (largura e altura). Esse campo permite que você reserve a altura certa para a imagem enquanto aguarda o carregamento. Ele não foi criado para substituir a proporção integrada da imagem. Se não definido, o servidor o preenche fazendo a pré-busca da imagem.

OnClick

Uma ação onclick (por exemplo, abrir um link).

Representação JSON
{

  // Union field data can be only one of the following:
  "action": {
    object (FormAction)
  },
  "openLink": {
    object (OpenLink)
  }
  // End of list of possible types for union field data.
}
Campos

Campo de união data.

data pode ser apenas uma das seguintes opções:

action

object (FormAction)

Se especificado, uma ação de formulário será acionada por esta ação onclick.

Ação de formulário

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 (ActionParameter)
    }
  ]
}
Campos
actionMethodName

string

O nome do método é usado para identificar qual parte do formulário acionou o envio do formulário. Essas informações aparecem no app Chat como parte do evento de clique no card. Você pode usar o mesmo nome de método para vários elementos que acionam um comportamento comum.

parameters[]

object (ActionParameter)

Lista de parâmetros de ação.

Parâmetro de ação

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 adiamento: "Adiar agora", "Adiar um dia" e "Adiar na próxima semana". É possível 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

string

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

value

string

O valor do parâmetro.

KeyValue

Um elemento da IU 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 (OnClick)
  },

  // Union field icons can be only one of the following:
  "icon": enum (Icon),
  "iconUrl": string
  // End of list of possible types for union field icons.

  // Union field control can be only one of the following:
  "button": {
    object (Button)
  }
  // End of list of possible types for union field control.
}
Campos
topLabel

string

O texto do rótulo superior. Texto formatado compatível. Para mais informações sobre formatação de texto, consulte Como formatar texto em apps do Google Chat e Como formatar texto em complementos do Google Workspace.

content

string

O texto do conteúdo. Texto formatado compatível e sempre exigido. Para mais informações sobre formatação de texto, consulte Como formatar texto em apps do Google Chat e Como formatar texto em complementos do Google Workspace.

contentMultiline

boolean

Se o conteúdo deve ser de várias linhas.

bottomLabel

string

O texto do rótulo inferior. Texto formatado compatível. Para mais informações sobre formatação de texto, consulte Como formatar texto em apps do Google Chat e Como formatar texto em complementos do Google Workspace.

onClick

object (OnClick)

A ação onclick. Somente os rótulos superiores, inferiores e regionais são clicáveis.

Campo de união icons. Pelo menos um dos ícones, top_label e bottom_label precisa ser definido. icons pode ser apenas uma das seguintes opções:
icon

enum (Icon)

Um valor enumerado que foi substituído pela API Chat pela imagem do ícone correspondente.

iconUrl

string

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 uma das seguintes opções:
button

object (Button)

Um botão que pode ser clicado para acionar uma ação.

Ícone

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 um botão de imagem.

Representação JSON
{

  // Union field type can be only one of the following:
  "textButton": {
    object (TextButton)
  },
  "imageButton": {
    object (ImageButton)
  }
  // End of list of possible types for union field type.
}
Campos

Campo de união type.

type pode ser apenas uma das seguintes opções:

textButton

object (TextButton)

Um botão com texto e ação onclick.

imageButton

object (ImageButton)

Um botão com imagem e ação onclick.

Botão de texto

Um botão com texto e ação onclick.

Representação JSON
{
  "text": string,
  "onClick": {
    object (OnClick)
  }
}
Campos
text

string

O texto do botão.

onClick

object (OnClick)

A ação onclick do botão.

Botão de imagem

Um botão de imagem com uma ação onclick.

Representação JSON
{
  "onClick": {
    object (OnClick)
  },
  "name": string,

  // Union field icons can be only one of the following:
  "icon": enum (Icon),
  "iconUrl": string
  // End of list of possible types for union field icons.
}
Campos
onClick

object (OnClick)

A ação onclick.

name

string

O nome do imageButton usado para acessibilidade. O valor padrão será fornecido se esse nome não for especificado.

Campo de união icons. O ícone pode ser especificado por um Icon enum ou um URL. icons pode ser apenas uma das seguintes opções:
icon

enum (Icon)

O ícone especificado por um enum que faz referência a um ícone fornecido pela API Chat.

iconUrl

string

O ícone especificado por um URL.

CardAction

Uma ação de cartão é 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.

Não é compatível com os apps do Google Chat.

Representação JSON
{
  "actionLabel": string,
  "onClick": {
    object (OnClick)
  }
}
Campos
actionLabel

string

O rótulo que era exibido no item do menu de ações.

onClick

object (OnClick)

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