Cards v1

Cartas

Um card é um elemento da interface que pode conter widgets, 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 uma linha divisória.

cardActions[]

object (CardAction)

As ações deste card.

name

string

Nome do card.

CardHeader

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

string

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 vai ocupar uma linha. Se apenas o título for especificado, ele vai ocupar as duas linhas.

subtitle

string

O subtítulo do cabeçalho do card.

imageStyle

enum (ImageStyle)

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

imageUrl

string

O URL da imagem no cabeçalho do card.

ImageStyle

Tipos enumerados
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, então não é necessário usar propriedades de layout (por exemplo, float).

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

string

O cabeçalho da seção. O texto formatado é aceito. 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 precisa conter pelo menos um widget.

WidgetMarkup

Um widget é um elemento da interface que apresenta texto e imagens.

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

  "textParagraph": {
    object (TextParagraph)
  },
  "image": {
    object (Image)
  },
  "keyValue": {
    object (KeyValue)
  }
}
Campos
buttons[]

object (Button)

Uma lista de botões. Botões também é oneof data e apenas um desses campos deve ser definido.

Um WidgetMarkup só pode ter um dos itens a seguir. É possível usar vários campos WidgetMarkup para exibir mais itens. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
textParagraph

object (TextParagraph)

Mostra um parágrafo de texto neste widget.

image

object (Image)

Mostre uma imagem neste widget.

keyValue

object (KeyValue)

Mostra um item de chave-valor neste widget.

Fim dos campos mutuamente exclusivos.

TextParagraph

Um parágrafo de texto. Texto formatado aceito. Para mais informações sobre como formatar 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 da imagem (largura e altura). Esse campo permite reservar a altura certa para a imagem enquanto ela é carregada. Ele não serve para substituir a proporção integrada da imagem. Se não for definido, o servidor vai preencher o campo ao pré-buscar a imagem.

OnClick

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

Representação JSON 
{

  "action": {
    object (FormAction)
  },
  "openLink": {
    object (OpenLink)
  }
}
Campos
Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
action

object (FormAction)

Uma ação de formulário é acionada por esta ação onclick, se especificada.

Fim dos campos mutuamente exclusivos.

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

string

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 do 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[]

object (ActionParameter)

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 adiamento: adiar agora, adiar por um dia, adiar para a próxima semana. Você pode usar action method = snooze(), transmitindo o tipo e o tempo de adiamento 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 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 (OnClick)
  },

  "icon": enum (Icon),
  "iconUrl": string

  "button": {
    object (Button)
  }
}
Campos
topLabel

string

O texto do rótulo superior. Texto formatado aceito. 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. O texto formatado é aceito e sempre obrigatório. 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 multilinha.

bottomLabel

string

O texto do rótulo inferior. Texto formatado aceito. 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 o rótulo superior, o rótulo inferior e a região de conteúdo são clicáveis.

É necessário definir pelo menos um dos ícones, top_label e bottom_label. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
icon

enum (Icon)

Um valor de tipo enumerado que é substituído pela API Chat pela imagem do ícone correspondente.

iconUrl

string

O ícone especificado por um URL.

Fim dos campos mutuamente exclusivos.
Um widget de controle. É possível definir button ou switch_widget, mas não ambos. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
button

object (Button)

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

Fim dos campos mutuamente exclusivos.

Ícone

O conjunto de ícones compatíveis.

Tipos enumerados
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 
{

  "textButton": {
    object (TextButton)
  },
  "imageButton": {
    object (ImageButton)
  }
}
Campos
Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
textButton

object (TextButton)

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

imageButton

object (ImageButton)

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

Fim dos campos mutuamente exclusivos.

TextButton

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.

ImageButton

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

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

  "icon": enum (Icon),
  "iconUrl": string
}
Campos
onClick

object (OnClick)

A ação onclick.

name

string

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

O ícone pode ser especificado por um Icon enum ou um URL. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
icon

enum (Icon)

O ícone especificado por um enum que indexa um ícone fornecido pela API Chat.

iconUrl

string

O ícone especificado por um URL.

Fim dos campos mutuamente exclusivos.

CardAction

Uma ação de card é a ação associada ao card. Para um card de fatura, uma ação típica seria: excluir, enviar por e-mail ou abrir a fatura no navegador.

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

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

string

O rótulo usado para ser exibido no item do menu de ações.

onClick

object (OnClick)

A ação onclick para essa ação necessária.