Cards v1

Cartas

Um card é um elemento da interface que pode conter widgets de interface, 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 cartão. Geralmente, um cabeçalho 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 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 deles 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 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

Cabeçalho da seção. É possível usar texto formatado. Para mais informações sobre formatação de texto, consulte Formatar texto nos apps do Google Chat e Como 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 deve ser definido.

Campo de união data: Um WidgetMarkup só pode ter um dos itens a seguir. É possível usar vários 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)

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 formatação de texto, consulte Formatar texto nos apps do Google Chat e Como formatar texto nos complementos do Google Workspace.

Representação JSON 
{
  "text": string
}
Campos
text

string

Imagem

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

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

string

É o URL da imagem.

onClick

object (OnClick)

A onclick à ação.

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 ela não for definida, o servidor vai preenchê-la fazendo uma pré-busca da imagem.

OnClick

Um onclick ação (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)

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

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 (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 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 soneca: soneca agora, soneca um dia e soneca 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 para o 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 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 formatação de texto, consulte Formatar texto nos apps do Google Chat e Como formatar texto nos complementos do Google Workspace.

content

string

O texto do conteúdo. Texto formatado é permitido e sempre obrigatório. Para mais informações sobre formatação de texto, consulte Formatar texto nos apps do Google Chat e Como formatar texto nos complementos do Google Workspace.

contentMultiline

boolean

Se o conteúdo precisar ser multilinha.

bottomLabel

string

O texto do marcador inferior. Suporte a texto formatado. Para mais informações sobre formatação de texto, consulte Formatar texto nos apps do Google Chat e Como formatar texto nos complementos do Google Workspace.

onClick

object (OnClick)

A onclick à ação. Somente o marcador superior, o marcador inferior e a região do conteúdo são clicáveis.

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

enum (Icon)

Um valor de enumeração 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 os dois. 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 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 onclick à ação.

imageButton

object (ImageButton)

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

TextButton

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

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

string

O texto do botão.

onClick

object (OnClick)

A onclick ação do botão.

ImageButton

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

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 onclick à ação.

name

string

O nome deste imageButton que é 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 indica um ícone fornecido pela API Chat.

iconUrl

string

O ícone especificado por um URL.

CardAction

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

Indisponível nos apps do Google Chat.

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

string

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

onClick

object (OnClick)

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