Package google.apps.card.v1

Índice

Ação

Uma ação que descreve o comportamento quando o formulário é enviado. Por exemplo, você pode invocar um script do Apps Script para processar o formulário. Se a ação for acionada, os valores do formulário serão enviados ao servidor.

Disponível para apps do Google Chat e complementos do Google Workspace.

Campos
function

string

Uma função personalizada a ser invocada quando o elemento contido for clicado ou ativado de outra forma.

Para exemplos de uso, consulte Ler dados de formulário.
parameters[]

ActionParameter

Lista de parâmetros de ação.
load_indicator

LoadIndicator

Especifica o indicador de carregamento que a ação mostra ao fazer a chamada.
persist_values

bool

Indica se os valores do formulário permanecem após a ação. O valor padrão é false.

Se true, os valores do formulário vão permanecer depois que a ação for acionada. Para permitir que o usuário faça mudanças enquanto a ação está sendo processada, defina LoadIndicator como NONE. Para mensagens de card em apps de chat, defina o ResponseType da ação como UPDATE_MESSAGE e use o mesmo card_id do card que continha a ação.

Se false, os valores do formulário serão limpos quando a ação for acionada. Para impedir que o usuário faça mudanças enquanto a ação está sendo processada, defina LoadIndicator como SPINNER.
interaction

Interaction

Opcional. Obrigatório ao abrir uma caixa de diálogo.

O que fazer em resposta a uma interação com um usuário, como clicar em um botão em uma mensagem de card.

Se não for especificado, o app vai responder executando um action, como abrir um link ou executar uma função, normalmente.

Ao especificar um interaction, o app pode responder de maneiras interativas especiais. Por exemplo, ao definir interaction como OPEN_DIALOG, o app pode abrir uma caixa de diálogo. Quando especificado, um indicador de carregamento não é mostrado. Se especificado para um complemento, todo o card será removido e nada será mostrado no cliente.

Disponível para apps do Google Chat e indisponível para complementos do Google Workspace.
required_widgets[]

string

Opcional. Preencha esta lista com os nomes dos widgets que essa ação precisa para um envio válido.

Se os widgets listados aqui não tiverem um valor quando essa ação for invocada, o envio do formulário será cancelado.

Disponível para apps do Google Chat e complementos do Google Workspace.
all_widgets_are_required

bool

Opcional. Se for verdadeiro, todos os widgets serão considerados obrigatórios por essa ação.

Disponível para apps do Google Chat e complementos do Google Workspace.

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

Para saber mais, consulte CommonEventObject.

Disponível para apps do Google Chat e complementos do Google Workspace.

Campos
key

string

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

string

O valor do parâmetro.

Interação

Opcional. Obrigatório ao abrir uma caixa de diálogo.

O que fazer em resposta a uma interação com um usuário, como clicar em um botão em uma mensagem de card.

Se não for especificado, o app vai responder executando um action, como abrir um link ou executar uma função, normalmente.

Ao especificar um interaction, o app pode responder de maneiras interativas especiais. Por exemplo, ao definir interaction como OPEN_DIALOG, o app pode abrir uma caixa de diálogo.

Quando especificado, um indicador de carregamento não é mostrado. Se especificado para um complemento, todo o card será removido e nada será mostrado no cliente.

Disponível para apps do Google Chat e indisponível para complementos do Google Workspace.

Tipos enumerados
INTERACTION_UNSPECIFIED Valor padrão. O action é executado normalmente.
OPEN_DIALOG

Abre uma caixa de diálogo, uma interface baseada em cards e janelas que os apps do Google Chat usam para interagir com os usuários.

Compatível apenas com apps de chat em resposta a cliques de botão em mensagens de card. Se especificado para um complemento, todo o card será removido e nada será mostrado no cliente.

Disponível para apps do Google Chat e indisponível para complementos do Google Workspace.

LoadIndicator

Especifica o indicador de carregamento que a ação mostra ao fazer a chamada.

Disponível para apps do Google Chat e complementos do Google Workspace.

Tipos enumerados
SPINNER Mostra um ícone de carregamento para indicar que o conteúdo está sendo carregado.
NONE Nada é exibido.

BorderStyle

As opções de estilo para a borda de um card ou widget, incluindo o tipo e a cor da borda.

Disponível para apps do Google Chat e complementos do Google Workspace.

Campos
type

BorderType

O tipo de borda.
stroke_color

Color

As cores a serem usadas quando o tipo for BORDER_TYPE_STROKE.

Para definir a cor do traço, especifique um valor para os campos red, green e blue. O valor precisa ser um número de ponto flutuante entre 0 e 1 com base no valor da cor RGB, em que 0 (0/255) representa a ausência de cor e 1 (255/255) representa a intensidade máxima da cor.

Por exemplo, o comando a seguir define a cor como vermelho na intensidade máxima:

"color": {
   "red": 1,
   "green": 0,
   "blue": 0,
}

O campo alpha não está disponível para a cor do traço. Se especificado, esse campo será ignorado.
corner_radius

int32

O raio do canto da borda.

BorderType

Representa os tipos de borda aplicados aos widgets.

Disponível para apps do Google Chat e complementos do Google Workspace.

Tipos enumerados
BORDER_TYPE_UNSPECIFIED Não use. Não especificado.
NO_BORDER Sem borda.
STROKE Valor padrão. Contorno.

Botão

Um botão de texto, ícone ou texto e ícone em que os usuários podem clicar. Para um exemplo em apps do Google Chat, consulte Adicionar um botão.

Para transformar uma imagem em um botão clicável, especifique um Image (não um ImageComponent) e defina uma ação onClick.

Disponível para apps do Google Chat e complementos do Google Workspace.

Campos
text

string

O texto exibido dentro do botão.
icon

Icon

Um ícone exibido dentro do botão. Se icon e text estiverem definidos, o ícone vai aparecer antes do texto.
color

Color

Opcional. É a cor do botão. Se definido, o botão type será definido como FILLED, e a cor dos campos text e icon será definida como uma cor contrastante para facilitar a leitura. Por exemplo, se a cor do botão for azul, qualquer texto ou ícone nele será branco.

Para definir a cor do botão, especifique um valor para os campos red, green e blue. O valor precisa ser um número de ponto flutuante entre 0 e 1 com base no valor da cor RGB, em que 0 (0/255) representa a ausência de cor e 1 (255/255) representa a intensidade máxima da cor.

Por exemplo, o comando a seguir define a cor como vermelho na intensidade máxima:

"color": {
   "red": 1,
   "green": 0,
   "blue": 0,
}

O campo alpha não está disponível para a cor do botão. Se especificado, esse campo será ignorado.
on_click

OnClick

Obrigatório. A ação a ser realizada quando um usuário clica no botão, como abrir um hiperlink ou executar uma função personalizada.
disabled

bool

Se true, o botão será mostrado em um estado inativo e não vai responder às ações do usuário.
alt_text

string

O texto alternativo usado para acessibilidade.

Defina um texto descritivo que informe aos usuários o que o botão faz. Por exemplo, se um botão abrir um hiperlink, você pode escrever: "Abre uma nova guia do navegador e navega até a documentação para desenvolvedores do Google Chat em https://developers.google.com/workspace/chat".
type

Type

Opcional. O tipo de um botão. Se não for definido, o tipo de botão será OUTLINED por padrão. Se o campo color estiver definido, o tipo de botão será forçado a FILLED e qualquer valor definido para esse campo será ignorado.

Tipo

Opcional. O tipo de um botão. Se o campo color estiver definido, o type será forçado a FILLED.

Disponível para apps do Google Chat e indisponível para complementos do Google Workspace.

Tipos enumerados
TYPE_UNSPECIFIED Não use. Não especificado.
OUTLINED Os botões circunscritos são de ênfase média. Geralmente, eles contêm ações importantes, mas não são a principal ação em um app do Chat ou um complemento.
FILLED Um botão preenchido tem um contêiner com uma cor sólida. Ele tem o maior impacto visual e é recomendado para a ação principal e importante em um app do Chat ou complemento.
FILLED_TONAL Um botão tonal preenchido é uma alternativa intermediária entre botões preenchidos e com contorno. Eles são úteis em contextos em que um botão de prioridade mais baixa precisa de um pouco mais de ênfase do que um botão de contorno.
BORDERLESS Um botão não tem um contêiner invisível no estado padrão. Geralmente, ele é usado para ações de menor prioridade, principalmente ao apresentar várias opções.

ButtonList

Uma lista de botões dispostos horizontalmente. Para um exemplo em apps do Google Chat, consulte Adicionar um botão.

Disponível para apps do Google Chat e complementos do Google Workspace.

Campos
buttons[]

Button

Uma matriz de botões.

Cartas

Uma interface de card exibida em uma mensagem do Google Chat ou em um complemento do Google Workspace.

Os cards oferecem suporte a um layout definido, elementos interativos da interface, como botões, e rich media, como imagens. Use cards para apresentar informações detalhadas, coletar informações dos usuários e orientá-los a seguir para a próxima etapa.

Crie e visualize cards com o Card Builder.

Abrir o Criador de cards

Para saber como criar cards, consulte a seguinte documentação:

Observação: é possível adicionar até 100 widgets por card. Os widgets além desse limite são ignorados. Esse limite se aplica a mensagens de card e caixas de diálogo em apps do Google Chat, além de cards em complementos do Google Workspace.

Exemplo: mensagem de card para um app do Google Chat

Exemplo de card de contato

Para criar a mensagem de card de exemplo no Google Chat, use o seguinte JSON:

{
  "cardsV2": [
    {
      "cardId": "unique-card-id",
      "card": {
        "header": {
           "title": "Sasha",
           "subtitle": "Software Engineer",
           "imageUrl":
           "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png",
           "imageType": "CIRCLE",
           "imageAltText": "Avatar for Sasha"
         },
         "sections": [
           {
             "header": "Contact Info",
             "collapsible": true,
             "uncollapsibleWidgetsCount": 1,
             "widgets": [
               {
                 "decoratedText": {
                   "startIcon": {
                     "knownIcon": "EMAIL"
                   },
                   "text": "[email protected]"
                 }
               },
               {
                 "decoratedText": {
                   "startIcon": {
                     "knownIcon": "PERSON"
                   },
                   "text": "<font color=\"#80e27e\">Online</font>"
                 }
               },
               {
                 "decoratedText": {
                   "startIcon": {
                     "knownIcon": "PHONE"
                   },
                   "text": "+1 (555) 555-1234"
                 }
               },
               {
                 "buttonList": {
                   "buttons": [
                     {
                       "text": "Share",
                       "onClick": {
                        "openLink": {
                           "url": "https://example.com/share"
                         }
                       }
                     },
                     {
                       "text": "Edit",
                       "onClick": {
                         "action": {
                           "function": "goToView",
                           "parameters": [
                             {
                               "key": "viewType",
                               "value": "EDIT"
                             }
                           ]
                         }
                       }
                     }
                   ]
                 }
               }
             ]
           }
         ]
       }
    }
  ]
}
Campos
header

CardHeader

O cabeçalho do card. Um cabeçalho geralmente contém uma imagem inicial e um título. Os cabeçalhos sempre aparecem na parte de cima de um card.
sections[]

Section

Contém uma coleção de widgets. Cada seção tem um cabeçalho opcional. As seções são separadas visualmente por um divisor de linha. Para ver um exemplo em apps do Google Chat, consulte Definir uma seção de um card.
section_divider_style

DividerStyle

O estilo do divisor entre o cabeçalho, as seções e o rodapé.
card_actions[]

CardAction

As ações do card. As ações são adicionadas ao menu da barra de ferramentas do card.

Disponível para complementos do Google Workspace e indisponível para apps do Google Chat.

Por exemplo, o JSON a seguir cria um menu de ações do card com as opções Settings e Send Feedback:

"card_actions": [
  {
    "actionLabel": "Settings",
    "onClick": {
      "action": {
        "functionName": "goToView",
        "parameters": [
          {
            "key": "viewType",
            "value": "SETTING"
         }
        ],
        "loadIndicator": "LoadIndicator.SPINNER"
      }
    }
  },
  {
    "actionLabel": "Send Feedback",
    "onClick": {
      "openLink": {
        "url": "https://example.com/feedback"
      }
    }
  }
]
name

string

Nome do card. Usado como um identificador de card na navegação por cards.

Disponível para complementos do Google Workspace e indisponível para apps do Google Chat.
display_style

DisplayStyle

Nos complementos do Google Workspace, define as propriedades de exibição do peekCardHeader.

Disponível para complementos do Google Workspace e indisponível para apps do Google Chat.
peek_card_header

CardHeader

Ao mostrar conteúdo contextual, o cabeçalho do card de visualização funciona como um marcador de posição para que o usuário possa navegar entre os cards da página inicial e os contextuais.

Disponível para complementos do Google Workspace e indisponível para apps do Google Chat.

CardAction

Uma ação do card é a ação associada a ele. Por exemplo, um card de fatura pode incluir ações como excluir, enviar por e-mail ou abrir a fatura em um navegador.

Disponível para complementos do Google Workspace e indisponível para apps do Google Chat.

Campos
action_label

string

O rótulo que aparece como o item do menu de ação.
on_click

OnClick

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

CardFixedFooter

Um rodapé fixo que aparece na parte de baixo do card.

Definir fixedFooter sem especificar um primaryButton ou um secondaryButton causa um erro.

Para apps do Chat, você pode usar rodapés fixos em caixas de diálogo, mas não em mensagens de card. Para um exemplo em apps do Google Chat, consulte Adicionar um rodapé permanente.

Disponível para apps do Google Chat e complementos do Google Workspace.

Campos
primary_button

Button

O botão principal do rodapé fixo. O botão precisa ser um botão de texto com texto e cor definidos.
secondary_button

Button

O botão secundário do rodapé fixo. O botão precisa ser um botão de texto com texto e cor definidos. Se secondaryButton estiver definido, você também precisará definir primaryButton.

CardHeader

Representa um cabeçalho de card. Para um exemplo em apps do Google Chat, consulte Adicionar um cabeçalho.

Disponível para apps do Google Chat e complementos do Google Workspace.

Campos
title

string

Obrigatório. O título do cabeçalho do card. 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 vai ocupar as duas linhas.
subtitle

string

O subtítulo do cabeçalho do card. Se especificado, aparece em uma linha separada abaixo do title.
image_type

ImageType

A forma usada para cortar a imagem.

Disponível para apps do Google Chat e complementos do Google Workspace.
image_url

string

O URL HTTPS da imagem no cabeçalho do card.
image_alt_text

string

O texto alternativo da imagem usado para acessibilidade.

DisplayStyle

Nos complementos do Google Workspace, determina como um card é exibido.

Disponível para complementos do Google Workspace e indisponível para apps do Google Chat.

Tipos enumerados
DISPLAY_STYLE_UNSPECIFIED Não use. Não especificado.
PEEK O cabeçalho do card aparece na parte de baixo da barra lateral, cobrindo parcialmente o card superior atual da pilha. Ao clicar no cabeçalho, o card aparece na pilha. Se o card não tiver um cabeçalho, um cabeçalho gerado será usado.
REPLACE Valor padrão. O card é mostrado substituindo a visualização do card superior na pilha.

DividerStyle

O estilo do divisor de um card. No momento, usado apenas para divisores entre seções de cards.

Disponível para apps do Google Chat e complementos do Google Workspace.

Tipos enumerados
DIVIDER_STYLE_UNSPECIFIED Não use. Não especificado.
SOLID_DIVIDER Opção padrão. Renderiza um divisor sólido.
NO_DIVIDER Se definido, nenhum divisor será renderizado. Esse estilo remove completamente o divisor do layout. O resultado é equivalente a não adicionar um divisor.

NestedWidget

Uma lista de widgets que podem ser mostrados em um layout de contêiner, como um CarouselCard. Disponível para apps do Google Chat e indisponível para complementos do Google Workspace.

Campos

Campo de união data.

data pode ser apenas de um dos tipos a seguir:
text_paragraph

TextParagraph

Um widget de parágrafo de texto.
button_list

ButtonList

Um widget de lista de botões.
image

Image

Um widget de imagem.

Seção

Uma seção contém uma coleção de widgets renderizados verticalmente na ordem em que são especificados.

Disponível para apps do Google Chat e complementos do Google Workspace.

Campos
header

string

Texto que aparece na parte de cima de uma seção. Aceita texto formatado em HTML simples. Para mais informações sobre como formatar texto, consulte Formatar texto nos apps do Google Chat e Formatar texto nos complementos do Google Workspace.
widgets[]