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. Geralmente, um cabeçalho contém um título e uma imagem.

sections[]

object (Section)

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

cardActions[]

object (CardAction)

As ações deste card.

name

string

Nome do cartão.

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

subtitle

string

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

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

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 (WidgetMarkup)
    }
  ]
}
Campos
header

string

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

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)
    }
  ],

  // 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. 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:
textParagraph

object (TextParagraph)

Exibir um parágrafo de texto neste widget.

image

object (Image)

Mostre uma imagem neste widget.

keyValue

object (KeyValue)

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

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 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 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 um dos seguintes:

action

object (FormAction)

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

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 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 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

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)
  },

  // 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 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

string

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.

contentMultiline

boolean

Se o conteúdo precisa ser multilinha.

bottomLabel

string

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.

onClick

object (OnClick)

A ação onclick. Somente o rótulo de cima, o rótulo de baixo e a região de conteúdo 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 um dos seguintes:
icon

enum (Icon)

Um valor de tipo enumerado que é substituído pela API Chat pela imagem de í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 de um dos tipos a seguir:
button

object (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 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 um dos seguintes:

textButton

object (TextButton)

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

imageButton

object (ImageButton)

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

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,

  // 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 um dos seguintes:
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.

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 (OnClick)
  }
}
Campos
actionLabel

string

O rótulo usado para mostrar o item do menu de ações.

onClick

object (OnClick)

A ação "onclick" deste item de ação.