Cards v2

Cartas

Interface de card mostrada em uma mensagem do Google Chat ou um complemento do Google Workspace.

Os cartões suportam um layout definido, elementos interativos da IU, como botões, e rich media, como imagens. Use cards para apresentar informações detalhadas, coletar dados dos usuários e orientá-los sobre o que fazer em seguida.

Elabore e visualize cards com o Criador de cartões.

Abrir o Card Builder

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

Exemplo: mensagem de card para um app do Google Chat

Exemplo de card de contato

Para criar a mensagem de card de amostra 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": "sasha@example.com"
                 }
               },
               {
                 "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"
                             }
                           ]
                         }
                       }
                     }
                   ]
                 }
               }
             ]
           }
         ]
       }
    }
  ]
}
Representação JSON
{
  "header": {
    object (CardHeader)
  },
  "sections": [
    {
      object (Section)
    }
  ],
  "sectionDividerStyle": enum (DividerStyle),
  "cardActions": [
    {
      object (CardAction)
    }
  ],
  "name": string,
  "fixedFooter": {
    object (CardFixedFooter)
  },
  "displayStyle": enum (DisplayStyle),
  "peekCardHeader": {
    object (CardHeader)
  }
}
Campos
header

object (CardHeader)

O cabeçalho do cartão. O cabeçalho geralmente contém uma imagem inicial e um título. O cabeçalho sempre aparece na parte de cima do card.

sections[]

object (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 um exemplo nos apps do Google Chat, consulte Definir uma seção de um card.

sectionDividerStyle

enum (DividerStyle)

O estilo do divisor entre as seções.

cardActions[]

object (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 constrói um menu de ações de card com Settings e Send Feedback opções:

"cardActions": [
  {
    "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 cartão. Usado como um identificador de cartão na navegação de cards.

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

displayStyle

enum (DisplayStyle)

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

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

peekCardHeader

object (CardHeader)

Ao exibir conteúdo contextual, o cabeçalho do card de exibição serve como um marcador para que o usuário possa avançar entre os cards da página inicial e os de contexto.

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

CardHeader

Representa um cabeçalho de cartão. Para um exemplo nos apps do Google Chat, consulte Adicionar um cabeçalho.

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

Representação JSON
{
  "title": string,
  "subtitle": string,
  "imageType": enum (ImageType),
  "imageUrl": string,
  "imageAltText": string
}
Campos
title

string

Obrigatório. O título do cabeçalho do cartão. 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. Se especificado, aparece na própria linha abaixo do title:

imageType

enum (ImageType)

A forma usada para cortar a imagem.

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

imageUrl

string

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

imageAltText

string

É o texto alternativo desta imagem que é usado para acessibilidade.

ImageType

A forma usada para cortar a imagem.

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

Enums
SQUARE Valor padrão. Aplica uma máscara quadrada à imagem. Por exemplo, uma imagem de 4x3 se torna 3x3.
CIRCLE Aplica uma máscara circular à imagem. Por exemplo, uma imagem 4x3 se torna um círculo com um diâmetro de 3.

Seção

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

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

Representação JSON
{
  "header": string,
  "widgets": [
    {
      object (Widget)
    }
  ],
  "collapsible": boolean,
  "uncollapsibleWidgetsCount": integer,
  "collapseControl": {
    object (CollapseControl)
  }
}
Campos
header

string

Texto que aparece na parte superior de uma seção. Compatível com texto formatado em HTML simples. 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 (Widget)

Todos os widgets da seção. Deve conter pelo menos um widget.

collapsible

boolean

Indica se essa seção pode ser fechada.

As seções recolhíveis ocultam alguns ou todos os widgets, mas os usuários podem expandir a seção para revelar os widgets ocultos clicando em Mostrar mais. Os usuários podem ocultar os widgets novamente clicando Mostrar menos.

Para determinar quais widgets estão ocultos, especifique uncollapsibleWidgetsCount.

uncollapsibleWidgetsCount

integer

O número de widgets não recolhíveis que permanecem visíveis mesmo quando uma seção é recolhida.

Por exemplo, quando uma seção contém cinco widgets e o uncollapsibleWidgetsCount está definido como 2, os dois primeiros widgets são sempre mostrados e os três últimos são recolhidos por padrão. O uncollapsibleWidgetsCount é levada em conta somente quando collapsible é true

collapseControl

object (CollapseControl)

Opcional. Defina os botões de expansão e recolhimento da seção. Esse botão só vai aparecer se a seção puder ser recolhida. Se esse campo não for definido, o botão padrão será usado. Disponível nos apps do Google Chat e indisponível para os complementos do Google Workspace.

Widget

Cada card é composto por widgets.

Um widget é um objeto composto que pode representar texto, imagens, botões e outros tipos de objetos.

Representação JSON
{
  "horizontalAlignment": enum (HorizontalAlignment),

  // Union field data can be only one of the following:
  "textParagraph": {
    object (TextParagraph)
  },
  "image": {
    object (Image)
  },
  "decoratedText": {
    object (DecoratedText)
  },
  "buttonList": {
    object (ButtonList)
  },
  "textInput": {
    object (TextInput)
  },
  "selectionInput": {
    object (SelectionInput)
  },
  "dateTimePicker": {
    object (DateTimePicker)
  },
  "divider": {
    object (Divider)
  },
  "grid": {
    object (Grid)
  },
  "columns": {
    object (Columns)
  },
  "chipList": {
    object (ChipList)
  }
  // End of list of possible types for union field data.
}
Campos
horizontalAlignment

enum (HorizontalAlignment)

Especifica se os widgets estão alinhados à esquerda, à direita ou no centro de uma coluna.

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

object (TextParagraph)

Mostra um parágrafo de texto. Compatível com texto formatado em HTML simples. 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.

Por exemplo, o JSON a seguir cria um texto em negrito:

"textParagraph": {
  "text": "  <b>bold text</b>"
}
image

object (Image)

Mostra uma imagem.

Por exemplo, o JSON a seguir cria uma imagem com texto alternativo:

"image": {
  "imageUrl":
  "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png",
  "altText": "Chat app avatar"
}
decoratedText

object (DecoratedText)

Mostra um item de texto decorado.

Por exemplo, o JSON a seguir cria um widget de texto decorado mostrando o endereço de e-mail:

"decoratedText": {
  "icon": {
    "knownIcon": "EMAIL"
  },
  "topLabel": "Email Address",
  "text": "sasha@example.com",
  "bottomLabel": "This is a new Email address!",
  "switchControl": {
    "name": "has_send_welcome_email_to_sasha",
    "selected": false,
    "controlType": "CHECKBOX"
  }
}
buttonList

object (ButtonList)

Uma lista de botões.

Por exemplo, o JSON a seguir cria dois botões. O primeiro é um botão de texto azul e o segundo é um botão de imagem que abre um link:

"buttonList": {
  "buttons": [
    {
      "text": "Edit",
      "color": {
        "red": 0,
        "green": 0,
        "blue": 1,
      },
      "disabled": true,
    },
    {
      "icon": {
        "knownIcon": "INVITE",
        "altText": "check calendar"
      },
      "onClick": {
        "openLink": {
          "url": "https://example.com/calendar"
        }
      }
    }
  ]
}
textInput

object (TextInput)

Mostra uma caixa de texto na qual os usuários podem digitar.

Por exemplo, o JSON a seguir cria uma entrada de texto para um endereço de e-mail:

"textInput": {
  "name": "mailing_address",
  "label": "Mailing Address"
}

Como outro exemplo, o JSON abaixo cria uma entrada de texto para uma linguagem de programação com sugestões estáticas:

"textInput": {
  "name": "preferred_programing_language",
  "label": "Preferred Language",
  "initialSuggestions": {
    "items": [
      {
        "text": "C++"
      },
      {
        "text": "Java"
      },
      {
        "text": "JavaScript"
      },
      {
        "text": "Python"
      }
    ]
  }
}
selectionInput

object (SelectionInput)

Exibe um controle de seleção que permite aos usuários selecionar itens. Os controles de seleção podem ser caixas de seleção, botões de opção, chaves ou menus suspensos.

Por exemplo, o JSON a seguir cria um menu suspenso que permite aos usuários escolher um tamanho:

"selectionInput": {
  "name": "size",
  "label": "Size"
  "type": "DROPDOWN",
  "items": [
    {
      "text": "S",
      "value": "small",
      "selected": false
    },
    {
      "text": "M",
      "value": "medium",
      "selected": true
    },
    {
      "text": "L",
      "value": "large",
      "selected": false
    },
    {
      "text": "XL",
      "value": "extra_large",
      "selected": false
    }
  ]
}
dateTimePicker

object (DateTimePicker)

Mostra um widget que permite que os usuários insiram uma data, hora ou data e hora.

Por exemplo, o JSON a seguir cria um seletor de data e hora para agendar um horário:

"dateTimePicker": {
  "name": "appointment_time",
  "label": "Book your appointment at:",
  "type": "DATE_AND_TIME",
  "valueMsEpoch": "796435200000"
}
divider

object (Divider)

Mostra uma linha horizontal entre os widgets.

Por exemplo, o JSON abaixo cria um divisor:

"divider": {
}
grid

object (Grid)

Mostra uma grade com uma coleção de itens.

Uma grade suporta qualquer número de colunas e itens. O número de linhas é determinado pelos limites superiores do número de itens dividido pelo número de colunas. Uma grade com 10 itens e 2 colunas tem 5 linhas. Uma grade com 11 itens e 2 colunas tem 6 linhas.

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

Por exemplo, o JSON a seguir cria uma grade de duas colunas com um único item:

"grid": {
  "title": "A fine collection of items",
  "columnCount": 2,
  "borderStyle": {
    "type": "STROKE",
    "cornerRadius": 4
  },
  "items": [
    {
      "image": {
        "imageUri": "https://www.example.com/image.png",
        "cropStyle": {
          "type": "SQUARE"
        },
        "borderStyle": {
          "type": "STROKE"
        }
      },
      "title": "An item",
      "textAlignment": "CENTER"
    }
  ],
  "onClick": {
    "openLink": {
      "url": "https://www.example.com"
    }
  }
}
columns

object (Columns)

Exibe até duas colunas.

Para incluir mais de duas colunas ou para usar linhas, use o método Grid widget.

Por exemplo, o JSON a seguir cria duas colunas, cada uma contendo parágrafos de texto:

"columns": {
  "columnItems": [
    {
      "horizontalSizeStyle": "FILL_AVAILABLE_SPACE",
      "horizontalAlignment": "CENTER",
      "verticalAlignment": "CENTER",
      "widgets": [
        {
          "textParagraph": {
            "text": "First column text paragraph"
          }
        }
      ]
    },
    {
      "horizontalSizeStyle": "FILL_AVAILABLE_SPACE",
      "horizontalAlignment": "CENTER",
      "verticalAlignment": "CENTER",
      "widgets": [
        {
          "textParagraph": {
            "text": "Second column text paragraph"
          }
        }
      ]
    }
  ]
}
chipList

object (ChipList)

Uma lista de ícones.

Por exemplo, o JSON a seguir cria dois ícones. O primeiro é um ícone de texto, e o segundo é um ícone que abre um link:

"chipList": {
  "chips": [
    {
      "text": "Edit",
      "disabled": true,
    },
    {
      "icon": {
        "knownIcon": "INVITE",
        "altText": "check calendar"
      },
      "onClick": {
        "openLink": {
          "url": "https://example.com/calendar"
        }
      }
    }
  ]
}

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

TextParagraph

Um parágrafo de texto compatível com formatação. Para um exemplo nos apps do Google Chat, consulte Adicione um parágrafo de 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.

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

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

string

O texto mostrado no widget.

maxLines

integer

O número máximo de linhas de texto exibidas no widget. Se o texto exceder o número máximo de linhas especificado, o excesso de conteúdo ficará oculto atrás de mostrar mais . Se o texto for igual ou menor que o número máximo especificado de linhas, um mostrar mais não é exibido.

O valor padrão é 0. Nesse caso, todo o contexto é mostrado. Valores negativos são ignorados. Disponível nos apps do Google Chat e indisponível para os complementos do Google Workspace.

Imagem

Uma imagem que é especificada por um URL e pode ter onClick à ação. Para conferir um exemplo, consulte Adicione uma imagem.

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

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

string

O URL HTTPS que hospeda a imagem.

Exemplo:

https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png
onClick

object (OnClick)

Quando um usuário clica na imagem, o clique aciona essa ação.

altText

string

É o texto alternativo desta imagem que é usado para acessibilidade.

OnClick

Representa como responder quando os usuários clicam em um elemento interativo em um card, como um botão.

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

Representação JSON
{

  // Union field data can be only one of the following:
  "action": {
    object (Action)
  },
  "openLink": {
    object (OpenLink)
  },
  "openDynamicLinkAction": {
    object (Action)
  },
  "card": {
    object (Card)
  },
  "overflowMenu": {
    object (OverflowMenu)
  }
  // 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 (Action)

Se especificada, esta ação aciona uma ação onClick:

card

object (Card)

Se especificado, um novo card é enviado para a pilha de cards após um clique.

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

overflowMenu

object (OverflowMenu)

Se especificado, este onClick abre um menu flutuante. Disponível nos apps do Google Chat e indisponível para os complementos do Google Workspace.

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 nos apps do Google Chat e nos complementos do Google Workspace.

Representação JSON
{
  "function": string,
  "parameters": [
    {
      object (ActionParameter)
    }
  ],
  "loadIndicator": enum (LoadIndicator),
  "persistValues": boolean,
  "interaction": enum (Interaction),
  "requiredWidgets": [
    string
  ],
  "allWidgetsAreRequired": boolean
}
Campos
function

string

Uma função personalizada para invocar quando o elemento que contém o elemento de destino for clicado ou ativado de outra forma.

Para conferir exemplos de uso, consulte Ler dados do formulário.

parameters[]

object (ActionParameter)

Lista de parâmetros de ação.

loadIndicator

enum (LoadIndicator)

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

persistValues

boolean

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

Se true, os valores do formulário permanecem depois que a ação é acionada. Para permitir que o usuário faça alterações enquanto a ação está sendo processada, defina LoadIndicator para NONE. Para mensagens de card em apps de chat, também é necessário definir a ResponseType da ação UPDATE_MESSAGE e usar o mesmo cardId do card que continha a ação.

Se false, os valores do formulário serão apagados quando a ação for acionada. Para impedir que o usuário faça alterações enquanto a ação está sendo processada, defina LoadIndicator como SPINNER.

interaction

enum (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 quando um usuário clica em um botão em uma mensagem em um card.

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

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

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

requiredWidgets[]

string

. Opcional. Preencha a 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á interrompido.

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

allWidgetsAreRequired

boolean

. Opcional. Se for o caso, 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 soneca: soneca agora, soneca um dia ou 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.

Para saber mais, consulte CommonEventObject

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

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.

LoadIndicator

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

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

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

Interação

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

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

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

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

Quando especificado, o indicador de carregamento não é mostrado. Se especificado para um complemento, o cartão inteiro é retirado e nada é mostrado no cliente.

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

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

Abre um dialog, uma interface em janela baseada em cards que os apps de chat usam para interagir com os usuários.

Compatível apenas com apps do Chat em resposta a cliques em botões nas mensagens do card. Se especificado para um complemento, o card inteiro é removido e nada é mostrado no cliente.

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

OpenAs

Quando um OnClick abre um link, o cliente pode abri-lo como uma janela no tamanho original (se esse for o frame usado pelo cliente) ou como uma sobreposição (como um pop-up). A implementação depende dos recursos da plataforma do cliente, e o valor selecionado pode ser ignorado se o cliente não oferecer suporte a ele. FULL_SIZE é suportado por todos os clientes.

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

Enums
FULL_SIZE O link é aberto como uma janela de tamanho original (se esse for o frame usado pelo cliente).
OVERLAY O link é aberto como uma sobreposição, como um pop-up.

OnClose

O que o cliente faz quando um link é aberto por uma OnClick ação está fechada.

A implementação depende dos recursos da plataforma do cliente. Por exemplo, um navegador da Web pode abrir um link em uma janela pop-up com uma OnClose .

Se os dois OnOpen e OnClose estão definidos e a plataforma do cliente não oferece suporte aos dois valores, OnClose tem prioridade.

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

Enums
NOTHING Valor padrão. O cartão não é atualizado.
RELOAD

Recarrega o card depois que a janela filha é fechada.

Se usado em conjunto com OpenAs.OVERLAY, a janela filha atua como uma caixa de diálogo modal, e o card principal é bloqueado até a janela filha ser fechada.

OverflowMenu

Um widget que apresenta um menu pop-up com uma ou mais ações que os usuários podem invocar. Por exemplo, mostrar ações não principais em um card. Você pode usar esse widget quando as ações não couberem no espaço disponível. Para usá-lo, especifique o widget nas OnClick dos widgets que a suportam. Por exemplo, em um Button.

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

Representação JSON
{
  "items": [
    {
      object (OverflowMenuItem)
    }
  ]
}
Campos
items[]

object (OverflowMenuItem)

Obrigatório. A lista de opções do menu.

OverflowMenuItem

. Uma opção que os usuários podem invocar em um menu flutuante.

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

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

object (Icon)

O ícone exibido na frente do texto.

text

string

Obrigatório. É o texto que identifica ou descreve o item para os usuários.

onClick

object (OnClick)

Obrigatório. A ação invocada quando uma opção de menu é selecionada. O OnClick não pode conter um OverflowMenu. Qualquer OverflowMenu especificado é descartado e o item de menu é desativado.

disabled

boolean

Indica se a opção de menu está desativada. O padrão é "false".

Ícone

Ícone exibido em um widget em um card. Para um exemplo nos apps do Google Chat, consulte Adicionar um ícone.

Oferece suporte integrado e personalizado ícones

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

Representação JSON
{
  "altText": string,
  "imageType": enum (ImageType),

  // Union field icons can be only one of the following:
  "knownIcon": string,
  "iconUrl": string,
  "materialIcon": {
    object (MaterialIcon)
  }
  // End of list of possible types for union field icons.
}
Campos
altText

string

Opcional. Uma descrição do ícone usado para acessibilidade. Se não for especificado, o valor padrão Button é fornecido. Como prática recomendada, defina uma descrição útil do que o ícone mostra e, se aplicável, o que ele faz. Por exemplo: A user's account portrait ou Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat.

Se o ícone for definido em um Button, o altText aparece como texto auxiliar quando o usuário passa o mouse sobre o botão. No entanto, se o botão também definir text, o valor altText é ignorado.

imageType

enum (ImageType)

O estilo de corte aplicado à imagem. Em alguns casos, aplicar uma CIRCLE Cortar faz com que a imagem seja desenhada em um tamanho maior do que um ícone integrado.

Campo de união icons: O ícone exibido no widget do card. icons pode ser apenas uma das seguintes opções:
knownIcon

string

Mostre um dos ícones integrados fornecidos pelo Google Workspace.

Por exemplo, para exibir um ícone de avião, especifique AIRPLANE: Para ônibus, especifique BUS:

Para conferir uma lista completa de ícones compatíveis, consulte Ícones integrados.

iconUrl

string

Mostre um ícone personalizado hospedado em um URL HTTPS.

Exemplo:

"iconUrl":
"https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png"

Os tipos de arquivo aceitos incluem .png e .jpg.

materialIcon

object (MaterialIcon)

Mostre um dos ícones do Google Material Design.

Por exemplo, para exibir ícone de caixa de seleção, use

"materialIcon": {
  "name": "check_box"
}

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

MaterialIcon

Um Ícone do Material Design do Google, que inclui mais de 2.500 opções.

Por exemplo, para exibir ícone de caixa de seleção com peso e nota personalizados, escreva o seguinte:

{
  "name": "check_box",
  "fill": true,
  "weight": 300,
  "grade": -25
}

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

Representação JSON
{
  "name": string,
  "fill": boolean,
  "weight": integer,
  "grade": integer
}
Campos
name

string

O nome do ícone definido no Ícone do Material Design do Google, por exemplo, check_box Todos os nomes inválidos são abandonados e substituídos por uma string vazia, o que resulta na falha da renderização do ícone.

fill

boolean

Indica se o ícone é renderizado como preenchido. O valor padrão é “false”.

Para conferir as diferentes configurações de ícones, acesse Ícones de fonte do Google e ajuste as configurações em Personalizar.

weight

integer

A espessura do traço do ícone. Escolha entre {100, 200, 300, 400, 500, 600, 700}. Se ausente, o valor padrão será 400. Se outro valor for especificado, o valor padrão será usado.

Para visualizar diferentes configurações de ícones, acesse Ícones de fonte do Google e ajuste as configurações em Personalizar.

grade

integer

O peso e o grau afetam a espessura de um símbolo. Ajustes na classificação são mais granulares do que ajustes no peso e têm um pequeno impacto no tamanho do símbolo. Escolha entre {-25, 0, 200}. Se ausente, o valor padrão será 0. Se qualquer outro valor for especificado, o padrão será usado.

Para visualizar diferentes configurações de ícones, acesse Ícones de fonte do Google e ajuste as configurações em Personalizar.

DecoratedText

Um widget que mostra texto com decorações opcionais, como um rótulo acima ou abaixo do texto, um ícone na frente do texto, um widget de seleção ou um botão após o texto. Para um exemplo nos apps do Google Chat, consulte Mostrar texto com texto decorativo.

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

Representação JSON
{
  "icon": {
    object (Icon)
  },
  "startIcon": {
    object (Icon)
  },
  "topLabel": string,
  "text": string,
  "wrapText": boolean,
  "bottomLabel": string,
  "onClick": {
    object (OnClick)
  },

  // Union field control can be only one of the following:
  "button": {
    object (Button)
  },
  "switchControl": {
    object (SwitchControl)
  },
  "endIcon": {
    object (Icon)
  }
  // End of list of possible types for union field control.
}
Campos
icon
(deprecated)

object (Icon)

Descontinuado em favor de startIcon.

startIcon

object (Icon)

O ícone exibido na frente do texto.

topLabel

string

O texto que aparece acima text. Sempre trunca.

text

string

Obrigatório. O texto principal.

Compatível com formatação simples. 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.

wrapText

boolean

A configuração "Ajustar texto". Se true, o texto é ajustado e exibido em várias linhas. Caso contrário, o texto ficará truncado.

Aplicável apenas a text, não topLabel e bottomLabel.

bottomLabel

string

O texto que aparece abaixo text: Sempre encapsula.

onClick

object (OnClick)

Esta ação é acionada quando os usuários clicam topLabel ou bottomLabel.

Campo de união control. Um botão, botão, caixa de seleção ou imagem que aparece à direita do texto na decoratedText widget. control pode ser apenas uma das seguintes opções:
button

object (Button)

Um botão no qual um usuário pode clicar para iniciar uma ação.

switchControl

object (SwitchControl)

Um widget de interruptor em que o usuário pode clicar para alterar o estado e acionar uma ação.

endIcon

object (Icon)

Um ícone exibido após o texto.

Oferece suporte integrado e personalizado ícones

Botão

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

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

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

Representação JSON
{
  "text": string,
  "icon": {
    object (Icon)
  },
  "color": {
    object (Color)
  },
  "onClick": {
    object (OnClick)
  },
  "disabled": boolean,
  "altText": string,
  "type": enum (Type)
}
Campos
text

string

O texto exibido dentro do botão.

icon

object (Icon)

Um ícone exibido dentro do botão. Se os dois icon e text estiver definido, o ícone aparecerá antes do texto.

color

object (Color)

Opcional. A cor do botão. Se definido, o botão type está definido como FILLED e a cor do text e icon são definidos com uma cor contrastante para facilitar a leitura. Por exemplo, se a cor do botão estiver definida como azul, todos os textos ou ícones dele serão definidos como brancos.

Para definir a cor do botão, especifique um valor para o red, green e blue campos. O valor precisa ser um número 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 código a seguir define a cor como vermelho na intensidade máxima:

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

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

onClick

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

boolean

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

altText

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, escreva: "Abre uma nova guia do navegador e navega até a documentação do desenvolvedor do Google Chat em https://developers.google.com/workspace/chat&quot;.

type

enum (Type)

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

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

Cor

Representa uma cor no espaço de cores RGBA. Essa representação foi projetada para simplificar a conversão de e para representações de cores em vários idiomas em vez de compactação. Por exemplo, os campos dessa representação podem ser fornecidos de modo trivial ao construtor do java.awt.Color em Java. também pode ser fornecida de modo trivial aos atributos +colorWithRed:green:blue:alpha no iOS. e, com um pouco de trabalho, ele pode ser facilmente formatado em um CSS rgba() em JavaScript.

Esta página de referência não tem informações sobre o espaço de cor absoluto que deve ser usado para interpretar o valor RGB, por exemplo, sRGB, Adobe RGB, DCI-P3 e BT.2020. Por padrão, os aplicativos usam o espaço de cores sRGB.

Quando a igualdade de cores precisa ser decidida, as implementações, a menos que documentadas de outra forma, tratam duas cores como iguais se todos os valores de vermelho, verde, azul e alfa diferirem no máximo 1e-5.

Exemplo (Java):

 import com.google.type.Color;

 // ...
 public static java.awt.Color fromProto(Color protocolor) {
   float alpha = protocolor.hasAlpha()
       ? protocolor.getAlpha().getValue()
       : 1.0;

   return new java.awt.Color(
       protocolor.getRed(),
       protocolor.getGreen(),
       protocolor.getBlue(),
       alpha);
 }

 public static Color toProto(java.awt.Color color) {
   float red = (float) color.getRed();
   float green = (float) color.getGreen();
   float blue = (float) color.getBlue();
   float denominator = 255.0;
   Color.Builder resultBuilder =
       Color
           .newBuilder()
           .setRed(red / denominator)
           .setGreen(green / denominator)
           .setBlue(blue / denominator);
   int alpha = color.getAlpha();
   if (alpha != 255) {
     result.setAlpha(
         FloatValue
             .newBuilder()
             .setValue(((float) alpha) / denominator)
             .build());
   }
   return resultBuilder.build();
 }
 // ...

Exemplo (iOS/Obj-C):

 // ...
 static UIColor* fromProto(Color* protocolor) {
    float red = [protocolor red];
    float green = [protocolor green];
    float blue = [protocolor blue];
    FloatValue* alpha_wrapper = [protocolor alpha];
    float alpha = 1.0;
    if (alpha_wrapper != nil) {
      alpha = [alpha_wrapper value];
    }
    return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
 }

 static Color* toProto(UIColor* color) {
     CGFloat red, green, blue, alpha;
     if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
       return nil;
     }
     Color* result = [[Color alloc] init];
     [result setRed:red];
     [result setGreen:green];
     [result setBlue:blue];
     if (alpha <= 0.9999) {
       [result setAlpha:floatWrapperWithValue(alpha)];
     }
     [result autorelease];
     return result;
}
// ...

Exemplo (JavaScript):

// ...

var protoToCssColor = function(rgb_color) {
   var redFrac = rgb_color.red || 0.0;
   var greenFrac = rgb_color.green || 0.0;
   var blueFrac = rgb_color.blue || 0.0;
   var red = Math.floor(redFrac * 255);
   var green = Math.floor(greenFrac * 255);
   var blue = Math.floor(blueFrac * 255);

   if (!('alpha' in rgb_color)) {
      return rgbToCssColor(red, green, blue);
   }

   var alphaFrac = rgb_color.alpha.value || 0.0;
   var rgbParams = [red, green, blue].join(',');
   return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
};

var rgbToCssColor = function(red, green, blue) {
  var rgbNumber = new Number((red << 16) | (green << 8) | blue);
  var hexString = rgbNumber.toString(16);
  var missingZeros = 6 - hexString.length;
  var resultBuilder = ['#'];
  for (var i = 0; i < missingZeros; i++) {
     resultBuilder.push('0');
  }
  resultBuilder.push(hexString);
  return resultBuilder.join('');
};

// ...
Representação JSON
{
  "red": number,
  "green": number,
  "blue": number,
  "alpha": number
}
Campos
red

number

A quantidade de vermelho na cor como um valor no intervalo [0, 1].

green

number

A quantidade de verde na cor como um valor no intervalo [0, 1].

blue

number

A quantidade de azul na cor como um valor no intervalo [0, 1].

alpha

number

A fração desta cor que deve ser aplicada ao pixel. Ou seja, a cor final do pixel é definida pela equação:

pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

Isto significa que um valor de 1,0 corresponde a uma cor sólida, enquanto um valor de 0,0 corresponde a uma cor completamente transparente. Esse recurso usa uma mensagem de wrapper, em vez de um escalar flutuante simples, para que seja possível distinguir entre um valor padrão e o valor que está sendo desativado. Se omitido, esse objeto de cor é renderizado como uma cor sólida (como se o valor alfa tivesse recebido explicitamente o valor 1,0).

Tipo

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

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

Enums
TYPE_UNSPECIFIED Não use. Não especificado.
OUTLINED Botões contornados são botões de ênfase média. Geralmente, eles contêm ações importantes, mas que não são a principal 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 em um app do Chat ou um complemento.
FILLED_TONAL Um botão tonal preenchido é um meio-termo alternativo entre botões preenchidos e contornados. Eles são úteis em contextos em que um botão de menor prioridade requer um pouco mais de ênfase do que um botão de estrutura de tópicos.
BORDERLESS Um botão não tem um contêiner invisível no estado padrão. Ele é frequentemente usado para as ações de menor prioridade, especialmente ao apresentar várias opções.

SwitchControl

Um botão de alternância ou uma caixa de seleção dentro de um decoratedText widget.

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

Compatível apenas com o decoratedText widget.

Representação JSON
{
  "name": string,
  "value": string,
  "selected": boolean,
  "onChangeAction": {
    object (Action)
  },
  "controlType": enum (ControlType)
}
Campos
name

string

O nome pelo qual o widget de alternância é identificado em um evento de entrada de formulário.

Para detalhes sobre como trabalhar com entradas de formulário, consulte Receber dados do formulário.

value

string

O valor inserido por um usuário, retornado como parte de um evento de entrada de formulário.

Para detalhes sobre como trabalhar com entradas de formulário, consulte Receber dados do formulário.

selected

boolean

Quando true, a chave é selecionada.

onChangeAction

object (Action)

A ação a ser realizada quando o estado da chave é alterado, como qual função executar.

controlType

enum (ControlType)

Como a chave aparece na interface do usuário.

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

ControlType

Como a chave aparece na interface do usuário.

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

Enums
SWITCH Um interruptor de estilo de alternância.
CHECKBOX Descontinuado em favor de CHECK_BOX:
CHECK_BOX Uma caixa de seleção.

ButtonList

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

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

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

object (Button)

Uma matriz de botões.

TextInput

Um campo em que os usuários podem inserir texto. Suporte a sugestões e ações de alteração. Para um exemplo nos apps do Google Chat, consulte Adicione um campo em que o usuário pode inserir texto.

Os apps de chat recebem e podem processar o valor do texto inserido durante os eventos de entrada no formulário. Para detalhes sobre como trabalhar com entradas de formulário, consulte Receber dados do formulário.

Quando precisar coletar dados indefinidos ou abstratos dos usuários, use uma entrada de texto. Para coletar dados definidos ou enumerados de usuários, utilize o método SelectionInput widget.

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

Representação JSON
{
  "name": string,
  "label": string,
  "hintText": string,
  "value": string,
  "type": enum (Type),
  "onChangeAction": {
    object (Action)
  },
  "initialSuggestions": {
    object (Suggestions)
  },
  "autoCompleteAction": {
    object (Action)
  },
  "validation": {
    object (Validation)
  },
  "placeholderText": string
}
Campos
name

string

O nome pelo qual a entrada de texto é identificada em um evento de entrada de formulário.

Para detalhes sobre como trabalhar com entradas de formulário, consulte Receber dados do formulário.

label

string

O texto que aparece acima do campo de entrada de texto na interface do usuário.

Especifique um texto que ajude o usuário a inserir as informações de que o app precisa. Por exemplo, se você perguntar o nome de alguém, mas precisar especificamente do sobrenome, escreva surname em vez de name.

Obrigatório se hintText não foi especificado. Caso contrário, é opcional.

hintText

string

Texto que aparece abaixo do campo de entrada de texto para ajudar os usuários a inserir um determinado valor. Esse texto está sempre visível.

Obrigatório se label não estiver especificado. Caso contrário, é opcional.

value

string

O valor inserido por um usuário, retornado como parte de um evento de entrada do formulário.

Para detalhes sobre como trabalhar com entradas de formulário, consulte Receber dados do formulário.

type

enum (Type)

Como um campo de entrada de texto aparece na interface do usuário. Por exemplo, se o campo é de linha única ou múltipla.

onChangeAction

object (Action)

O que fazer quando uma mudança ocorre no campo de entrada de texto. Por exemplo, um usuário adicionando texto ou excluindo texto.

Exemplos de ações a serem realizadas incluem executar uma função personalizada ou abrir uma caixa de diálogo no Google Chat.

initialSuggestions

object (Suggestions)

Valores sugeridos que os usuários podem inserir. Esses valores aparecem quando os usuários clicam no campo de entrada de texto. À medida que os usuários digitam, os valores sugeridos são filtrados dinamicamente para corresponder ao que eles digitaram.

Por exemplo, um campo de entrada de texto para linguagem de programação pode sugerir Java, JavaScript, Python e C++. Quando os usuários começam a digitar Jav, a lista de filtros de sugestões para mostrar apenas Java e JavaScript

Os valores sugeridos ajudam a orientar os usuários a inserir valores que seu app possa entender. Ao se referir a JavaScript, alguns usuários podem inserir javascript e outros java script. Sugerir JavaScript pode padronizar a interação dos usuários com seu app.

Quando especificado, TextInput.type é sempre SINGLE_LINE, mesmo que ela esteja definida como MULTIPLE_LINE

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

autoCompleteAction

object (Action)

Opcional. Especifique a ação a ser tomada quando o campo de entrada de texto oferecer sugestões aos usuários que interagem com ele.

Se não for especificado, as sugestões serão definidas por initialSuggestions e são processados pelo cliente.

Se especificado, o app realiza a ação definida aqui, como executar uma função personalizada.

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

validation

object (Validation)

Especifique a validação necessária para esse campo de entrada de texto.

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

placeholderText

string

Texto que aparece no campo de entrada de texto quando ele está vazio. Use esse texto para solicitar que os usuários insiram um valor. Por exemplo: Enter a number from 0 to 100

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

Tipo

Como um campo de entrada de texto aparece na interface do usuário. Por exemplo, seja um campo de entrada de linha única ou uma entrada de várias linhas. Se initialSuggestions for especificado, type será sempre SINGLE_LINE, mesmo que seja definido como MULTIPLE_LINE.

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

Enums
SINGLE_LINE O campo de entrada de texto tem uma altura fixa de uma linha.
MULTIPLE_LINE O campo de entrada de texto tem uma altura fixa de várias linhas.

RenderActions

Um conjunto de instruções de renderização que instrui um card a realizar uma ação ou instrui o app de hospedagem de complementos ou o app de chat a realizar uma ação específica do app.

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

Campos
action

Action

Ação

Campos
navigations[]

Navigation

Envie ou atualize os cards exibidos.

Adicionar um novo cartão à pilha (navegar para frente). Para apps do Chat, disponível apenas na página inicial do app.

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

navigations: {
  pushCard: CARD
}

Substitua o cartão superior por um novo. Para apps do Chat, disponível apenas na página inicial do app.

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

navigations: {
  updateCard: CARD
}

Sugestões

Valores sugeridos que os usuários podem inserir. Esses valores aparecem quando os usuários clicam no campo de entrada de texto. À medida que os usuários digitam, os valores sugeridos são filtrados dinamicamente para corresponder ao que eles digitaram.

Por exemplo, um campo de entrada de texto para linguagem de programação pode sugerir Java, JavaScript, Python e C++. Quando os usuários começam a digitar Jav, a lista de filtros de sugestões para mostrar Java e JavaScript

Os valores sugeridos ajudam a orientar os usuários a inserir valores que seu app possa entender. Ao se referir a JavaScript, alguns usuários podem inserir javascript e outros java script. Sugestão JavaScript padronize a interação dos usuários com o app.

Quando especificado, TextInput.type é sempre SINGLE_LINE, mesmo que ela esteja definida como MULTIPLE_LINE

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

Representação JSON
{
  "items": [
    {
      object (SuggestionItem)
    }
  ]
}
Campos
items[]

object (SuggestionItem)

Uma lista de sugestões usadas para recomendações de preenchimento automático nos campos de entrada de texto.

SuggestionItem

Um valor sugerido que os usuários podem inserir em um campo de entrada de texto.

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

Representação JSON
{

  // Union field content can be only one of the following:
  "text": string
  // End of list of possible types for union field content.
}
Campos

Campo de união content:

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

text

string

O valor de uma entrada sugerida para um campo de entrada de texto. Isso equivale ao que os próprios usuários inserem.

Validação

. Representa os dados necessários para validar o widget ao qual está anexado.

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

Representação JSON
{
  "characterLimit": integer,
  "inputType": enum (InputType)
}
Campos
characterLimit

integer

Especifique o limite de caracteres para widgets de entrada de texto. Ele é usado apenas para entrada de texto e é ignorado para outros widgets.

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

inputType

enum (InputType)

. Especifique o tipo dos widgets de entrada.

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

InputType

O tipo do widget de entrada.

Enums
INPUT_TYPE_UNSPECIFIED Tipo não especificado. Não use.
TEXT Texto normal que aceita todos os caracteres.
INTEGER Um valor inteiro.
FLOAT Um valor flutuante.
EMAIL Um endereço de e-mail.
EMOJI_PICKER Um emoji selecionado no seletor de emojis fornecido pelo sistema.

SelectionInput

Um widget que cria um ou mais itens de interface que os usuários podem selecionar. Por exemplo, um menu suspenso ou caixas de seleção. Você pode usar esse widget para coletar dados que podem ser previstos ou enumerados. Para um exemplo nos apps do Google Chat, consulte Adicione elementos selecionáveis de interface.

Os apps de chat podem processar o valor de itens selecionados ou inseridos pelos usuários. Para detalhes sobre como trabalhar com entradas de formulário, consulte Receber dados do formulário.

Para coletar dados indefinidos ou abstratos dos usuários, use o TextInput widget.

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

Representação JSON
{
  "name": string,
  "label": string,
  "type": enum (SelectionType),
  "items": [
    {
      object (SelectionItem)
    }
  ],
  "onChangeAction": {
    object (Action)
  },
  "multiSelectMaxSelectedItems": integer,
  "multiSelectMinQueryLength": integer,
  "validation": {
    object (Validation)
  },

  // Union field multi_select_data_source can be only one of the following:
  "externalDataSource": {
    object (Action)
  },
  "platformDataSource": {
    object (PlatformDataSource)
  }
  // End of list of possible types for union field multi_select_data_source.
}
Campos
name

string

Obrigatório. O nome que identifica a entrada de seleção em um evento de entrada de formulário.

Para detalhes sobre como trabalhar com entradas de formulário, consulte Receber dados do formulário.

label

string

O texto que aparece acima do campo de entrada de seleção na interface do usuário.

Especifique um texto que ajude o usuário a inserir as informações de que o app precisa. Por exemplo, se os usuários selecionarem a urgência de um tíquete de trabalho em um menu suspenso, o marcador poderá ser "Urgência". ou "Selecione a urgência".

type

enum (SelectionType)

O tipo de itens que são mostrados aos usuários em um widget SelectionInput. Os tipos de seleção oferecem suporte a diferentes tipos de interações. Por exemplo, os usuários podem selecionar uma ou mais caixas de seleção, mas só podem selecionar um valor em um menu suspenso.

items[]

object (SelectionItem)

Matriz de itens selecionáveis. Por exemplo, uma matriz de botões de opção ou caixas de seleção. Suporta até 100 itens.

onChangeAction

object (Action)

Se especificado, o formulário é enviado quando a seleção é alterada. Se não for especificado, será necessário especificar um botão separado para enviar o formulário.

Para saber mais sobre como trabalhar com entradas de formulário, consulte Receber dados de formulário.

multiSelectMaxSelectedItems

integer

Para menus de seleção múltipla, o número máximo de itens que um usuário pode selecionar. O valor mínimo é 1 item. Se não for especificado, o padrão será de três itens.

multiSelectMinQueryLength

integer

Para menus de seleção múltipla, o número de caracteres de texto que um usuário insere antes de as consultas do app serem preenchidas automaticamente e exibir itens sugeridos no menu.

Se não for especificado, o padrão será 0 caracteres para fontes de dados estáticas e 3 caracteres para fontes externas.

validation

object (Validation)

Para menus suspensos, a validação para este campo de entrada de seleção.

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

Campo de união multi_select_data_source: Para um menu de múltipla escolha, a fonte de dados que preenche os itens de seleção.

Disponível nos apps do Google Chat e indisponível para os complementos do Google Workspace. multi_select_data_source pode ser apenas um dos seguintes:

externalDataSource

object (Action)

Uma fonte de dados externa, como um banco de dados relacional.

platformDataSource

object (PlatformDataSource)

Uma fonte de dados do Google Workspace.

SelectionType

O formato dos itens que os usuários podem selecionar. Opções diferentes oferecem suporte a tipos diferentes de interações. Por exemplo, os usuários podem selecionar várias caixas de seleção, mas apenas um item de um menu suspenso.

Cada entrada de seleção é compatível com um tipo de seleção. Por exemplo, não é possível misturar caixas de seleção e botões de alternância.

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

Enums
CHECK_BOX Um conjunto de caixas de seleção. Os usuários podem marcar uma ou mais caixas de seleção.
RADIO_BUTTON Um conjunto de botões de opção. Os usuários podem selecionar um botão de opção.
SWITCH Um conjunto de chaves. Os usuários podem ativar um ou mais interruptores.
DROPDOWN Um menu suspenso. Os usuários podem selecionar um item do menu.
MULTI_SELECT

Um menu de múltipla seleção para dados estáticos ou dinâmicos. Na barra de menus, os usuários selecionam um ou mais itens. Os usuários também podem inserir valores para preencher dados dinâmicos. Por exemplo, se os usuários começarem a digitar o nome de um espaço do Google Chat, ele será sugerido automaticamente pelo widget.

Para preencher itens de um menu de seleção múltipla, use um dos seguintes tipos de fontes de dados:

  • Dados estáticos: os itens são especificados como SelectionItem no widget. Até 100 itens.
  • Dados do Google Workspace: os itens são preenchidos com dados do Google Workspace, como usuários do Workspace ou espaços do Google Chat.
  • Dados externos: os itens são preenchidos de uma fonte de dados externa fora do Google Workspace.

Para conferir exemplos de como implementar menus de múltipla seleção, consulte Adicionar um menu de múltipla seleção.

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

SelectionItem

Um item que os usuários podem escolher em uma entrada de seleção, como uma caixa de seleção ou um interruptor.

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

Representação JSON
{
  "text": string,
  "value": string,
  "selected": boolean,
  "startIconUri": string,
  "bottomText": string
}
Campos
text

string

O texto que identifica ou descreve o item para os usuários.

value

string

O valor associado a esse item. O cliente deve usá-lo como um valor de entrada de formulário.

Para detalhes sobre como trabalhar com entradas de formulário, consulte Receber dados do formulário.

selected

boolean

Indica se o item está selecionado por padrão. Se a entrada de seleção aceitar apenas um valor (como para botões de opção ou um menu suspenso), defina esse campo para apenas um item.

startIconUri

string

Para menus de seleção múltipla, o URL do ícone exibido ao lado do atributo text . Compatível com arquivos PNG e JPEG. Precisa ser um HTTPS URL. Por exemplo: https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png:

bottomText

string

Para menus de seleção múltipla, um rótulo ou descrição de texto que é exibido abaixo do rótulo text .

PlatformDataSource

Para um SelectionInput widget que usa um menu de seleção múltipla, uma fonte de dados do Google Workspace. Usado para preencher itens em um menu de seleção múltipla.

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

Representação JSON
{

  // Union field data_source can be only one of the following:
  "commonDataSource": enum (CommonDataSource),
  "hostAppDataSource": {
    object (HostAppDataSourceMarkup)
  }
  // End of list of possible types for union field data_source.
}
Campos
Campo de união data_source: A fonte de dados. data_source pode ser apenas uma das seguintes opções:
commonDataSource

enum (CommonDataSource)

Uma fonte de dados compartilhada por todos os aplicativos do Google Workspace, como os usuários em uma organização do Google Workspace.

hostAppDataSource

object (HostAppDataSourceMarkup)

Uma fonte de dados exclusiva de um aplicativo host do Google Workspace, como os espaços do Google Chat.

Esse campo oferece suporte às bibliotecas de cliente da API do Google, mas não está disponível nas bibliotecas de cliente do Cloud. Para saber mais, consulte Instale as bibliotecas de cliente.

CommonDataSource

Uma fonte de dados compartilhada por todos aplicativos do Google Workspace.

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

Enums
UNKNOWN Valor padrão. Não use.
USER Usuários do Google Workspace. O usuário só pode ver e selecionar usuários da organização do Google Workspace.

HostAppDataSourceMarkup

Para um SelectionInput widget que usa um menu de seleção múltipla, uma fonte de dados de um aplicativo do Google Workspace. A origem de dados preenche os itens de seleção do menu de múltipla seleção.

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

Representação JSON
{

  // Union field data_source can be only one of the following:
  "chatDataSource": {
    object (ChatClientDataSourceMarkup)
  }
  // End of list of possible types for union field data_source.
}
Campos
Campo de união data_source: O aplicativo do Google Workspace que preenche itens para um menu de múltipla seleção. data_source pode ser apenas uma das seguintes opções:
chatDataSource

object (ChatClientDataSourceMarkup)

Uma fonte de dados do Google Chat.

ChatClientDataSourceMarkup

Para um widget SelectionInput que usa um menu de múltipla seleção, uma origem de dados do Google Chat. A fonte de dados preenche os itens de seleção do menu de seleção múltipla. Por exemplo, os usuários podem selecionar espaços do Google Chat de que participam.

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

Representação JSON
{

  // Union field source can be only one of the following:
  "spaceDataSource": {
    object (SpaceDataSource)
  }
  // End of list of possible types for union field source.
}
Campos
Campo de união source: A fonte de dados do Google Chat. source pode ser apenas uma das seguintes opções:
spaceDataSource

object (SpaceDataSource)

Espaços do Google Chat em que o usuário é membro.

SpaceDataSource

Uma fonte de dados que preenche os espaços do Google Chat como itens de seleção para um menu de seleção múltipla. Preenche apenas os espaços de que o usuário participa.

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

Representação JSON
{
  "defaultToCurrentSpace": boolean
}
Campos
defaultToCurrentSpace

boolean

Se for definido como true, o menu de seleção múltipla seleciona o espaço atual do Google Chat como um item por padrão.

DateTimePicker

Permite que os usuários insiram uma data, hora ou ambos. Para um exemplo nos apps do Google Chat, consulte Permita que um usuário escolha uma data e uma hora.

Os usuários podem inserir texto ou usar o seletor para selecionar datas e horas. Se os usuários inserirem uma data ou hora inválida, o seletor mostrará um erro que solicita que os usuários insiram as informações corretamente.

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

Representação JSON
{
  "name": string,
  "label": string,
  "type": enum (DateTimePickerType),
  "valueMsEpoch": string,
  "timezoneOffsetDate": integer,
  "onChangeAction": {
    object (Action)
  },
  "validation": {
    object (Validation)
  }
}
Campos
name

string

O nome pelo qual o DateTimePicker é identificado em um evento de entrada de formulário.

Para detalhes sobre como trabalhar com entradas de formulário, consulte Receber dados do formulário.

label

string

É o texto que solicita que os usuários insiram uma data, hora ou data e hora. Por exemplo, se os usuários estiverem agendando um horário, use um marcador como Appointment date ou Appointment date and time.

type

enum (DateTimePickerType)

Indica se o widget aceita a inserção de uma data, uma hora ou a data e a hora.

valueMsEpoch

string (int64 format)

O valor padrão exibido no widget, em milissegundos desde a época Unix.

Especifique o valor com base no tipo de seletor ( DateTimePickerType):

  • DATE_AND_TIME : data e hora do calendário em UTC. Por exemplo, para representar 1o de janeiro de 2023 às 12h UTC, use 1672574400000:
  • DATE_ONLY : uma data do calendário às 00:00:00 UTC. Por exemplo, para representar 1o de janeiro de 2023, use 1672531200000:
  • TIME_ONLY : um horário em UTC. Por exemplo, para representar 12h, use 43200000 (ou 12 * 60 * 60 * 1000).
timezoneOffsetDate

integer

O número que representa a diferença de fuso horário em relação ao UTC, em minutos. Se definido, o valueMsEpoch é exibido no fuso horário especificado. Se não for definido, o valor padrão será a configuração de fuso horário do usuário.

onChangeAction

object (Action)

Acionado quando o usuário clica Salvar ou Limpar do DateTimePicker interface gráfica do usuário.

validation

object (Validation)

Opcional. Especifique a validação necessária para este seletor de data e hora.

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

DateTimePickerType

O formato de data e hora no DateTimePicker widget. Determina se os usuários podem inserir uma data, hora ou ambos.

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

Enums
DATE_AND_TIME Os usuários inserem uma data e hora.
DATE_ONLY Os usuários inserem uma data.
TIME_ONLY Os usuários inserem um horário.

Separador

Esse tipo não tem campos.

Mostra um divisor entre widgets como uma linha horizontal. Para um exemplo nos apps do Google Chat, consulte Adicione um divisor horizontal entre widgets.

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

Por exemplo, o JSON abaixo cria um divisor:

"divider": {}

Grade

Mostra uma grade com uma coleção de itens. Os itens só podem incluir texto ou imagens. Para colunas responsivas ou para incluir mais do que texto ou imagens, use Columns: Para um exemplo nos apps do Google Chat, consulte Mostrar uma grade com uma coleção de itens.

Uma grade suporta qualquer número de colunas e itens. O número de linhas é determinado por itens divididos por colunas. Uma grade com 10 itens e 2 colunas tem 5 linhas. Uma grade com 11 itens e 2 colunas tem 6 linhas.

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

Por exemplo, o JSON a seguir cria uma grade de duas colunas com um único item:

"grid": {
  "title": "A fine collection of items",
  "columnCount": 2,
  "borderStyle": {
    "type": "STROKE",
    "cornerRadius": 4
  },
  "items": [
    {
      "image": {
        "imageUri": "https://www.example.com/image.png",
        "cropStyle": {
          "type": "SQUARE"
        },
        "borderStyle": {
          "type": "STROKE"
        }
      },
      "title": "An item",
      "textAlignment": "CENTER"
    }
  ],
  "onClick": {
    "openLink": {
      "url": "https://www.example.com"
    }
  }
}
Representação JSON
{
  "title": string,
  "items": [
    {
      object (GridItem)
    }
  ],
  "borderStyle": {
    object (BorderStyle)
  },
  "columnCount": integer,
  "onClick": {
    object (OnClick)
  }
}
Campos
title

string

O texto exibido no cabeçalho da grade.

items[]

object (GridItem)

Itens a serem exibidos na grade.

borderStyle

object (BorderStyle)

O estilo de borda a ser aplicado a cada item da grade.

columnCount

integer

O número de colunas a serem exibidas na grade. Um valor padrão é usado se este campo não é especificado, e esse valor padrão é diferente dependendo de onde a grade é mostrada (caixa de diálogo versus complementar).

onClick

object (OnClick)

Esse callback é reutilizado por cada item individual da grade, mas com o identificador e o índice do item na lista de itens adicionados aos parâmetros do callback.

GridItem

Representa um item em um layout de grade. Os itens podem conter texto, imagem ou ambos.

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

Representação JSON
{
  "id": string,
  "image": {
    object (ImageComponent)
  },
  "title": string,
  "subtitle": string,
  "layout": enum (GridItemLayout)
}
Campos
id

string

Identificador especificado pelo usuário para este item da grade. Esse identificador é retornado no bloco onClick parâmetros de callback.

image

object (ImageComponent)

A imagem que aparece no item da grade.

title

string

O título do item da grade.

subtitle

string

O subtítulo do item da grade.

layout

enum (GridItemLayout)

O layout a ser usado para o item da grade.

ImageComponent

Representa uma imagem.

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

Representação JSON
{
  "imageUri": string,
  "altText": string,
  "cropStyle": {
    object (ImageCropStyle)
  },
  "borderStyle": {
    object (BorderStyle)
  }
}
Campos
imageUri

string

O URL da imagem.

altText

string

O rótulo de acessibilidade da imagem.

cropStyle

object (ImageCropStyle)

O estilo de corte a ser aplicado à imagem.

borderStyle

object (BorderStyle)

O estilo da borda que será aplicado à imagem.

ImageCropStyle

Representa o estilo de corte aplicado a uma imagem.

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

Por exemplo, confira como aplicar uma proporção de 16:9:

cropStyle {
 "type": "RECTANGLE_CUSTOM",
 "aspectRatio": 16/9
}
Representação JSON
{
  "type": enum (ImageCropType),
  "aspectRatio": number
}
Campos
type

enum (ImageCropType)

O tipo de corte.

aspectRatio

number

A proporção a ser usada se o tipo de corte for RECTANGLE_CUSTOM:

Por exemplo, confira como aplicar uma proporção de 16:9:

cropStyle {
 "type": "RECTANGLE_CUSTOM",
 "aspectRatio": 16/9
}

ImageCropType

Representa o estilo de corte aplicado a uma imagem.

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

Enums
IMAGE_CROP_TYPE_UNSPECIFIED Não use. Não especificado.
SQUARE Valor padrão. Aplica um corte quadrado.
CIRCLE Aplica um corte circular.
RECTANGLE_CUSTOM Aplica um corte retangular com uma proporção personalizada. Defina a proporção personalizada com aspectRatio.
RECTANGLE_4_3 Aplica um corte retangular com uma proporção de 4:3.

BorderStyle

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

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

Representação JSON
{
  "type": enum (BorderType),
  "strokeColor": {
    object (Color)
  },
  "cornerRadius": integer
}
Campos
type

enum (BorderType)

O tipo de borda.

strokeColor

object (Color)

As cores a serem usadas quando o tipo for BORDER_TYPE_STROKE:

Para definir a cor do traço, especifique um valor para o red, green e blue campos. O valor precisa ser um número 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.

O exemplo 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, este campo é ignorado.

cornerRadius

integer

O raio do canto da borda.

BorderType

Representa os tipos de borda aplicados aos widgets.

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

Enums
BORDER_TYPE_UNSPECIFIED Não use. Não especificado.
NO_BORDER Valor padrão. Sem borda.
STROKE Esboço.

GridItemLayout

Representa as várias opções de layout disponíveis para um item da grade.

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

Enums
GRID_ITEM_LAYOUT_UNSPECIFIED Não use. Não especificado.
TEXT_BELOW O título e o subtítulo são mostrados abaixo da imagem do item da grade.
TEXT_ABOVE O título e o subtítulo são mostrados acima da imagem do item da grade.

Colunas

O Columns exibe até duas colunas em um card ou caixa de diálogo. É possível adicionar widgets a cada coluna, os widgets aparecem na ordem em que são especificados. Para um exemplo nos apps do Google Chat, consulte Exibir cards e caixas de diálogo em colunas.

A altura de cada coluna é determinada pela coluna mais alta. Por exemplo, se a primeira coluna for mais alta que a segunda, ambas terão a altura da primeira. Como cada coluna pode conter um número diferente de widgets, não é possível definir linhas ou alinhar widgets entre as colunas.

As colunas são exibidas lado a lado. Você pode personalizar a largura de cada coluna usando o HorizontalSizeStyle . Se a largura da tela do usuário for muito estreita, a segunda coluna vai aparecer abaixo da primeira:

  • Na Web, a segunda coluna é unida se a largura da tela é menor ou igual a 480 pixels.
  • Em dispositivos iOS, a segunda coluna será unida se a largura da tela for menor ou igual a 300 pt.
  • Em dispositivos Android, a segunda coluna será unida se a largura da tela for menor ou igual a 320 dp.

Para incluir mais de duas colunas ou para usar linhas, use o método Grid widget.

Disponível nos apps do Google Chat e nos complementos do Google Workspace. As IUs de complementos compatíveis com colunas incluem:

  • A caixa de diálogo exibida quando os usuários abrem o complemento em um rascunho de e-mail.
  • A caixa de diálogo exibida quando os usuários abrem o complemento no Adicionar anexo em um evento do Google Agenda.
Representação JSON
{
  "columnItems": [
    {
      object (Column)
    }
  ]
}
Campos
columnItems[]

object (Column)

Uma matriz de colunas. Você pode incluir até duas colunas em um card ou caixa de diálogo.

Coluna

Uma coluna.

Complementos do Google Workspace e apps do Chat

Representação JSON
{
  "horizontalSizeStyle": enum (HorizontalSizeStyle),
  "horizontalAlignment": enum (HorizontalAlignment),
  "verticalAlignment": enum (VerticalAlignment),
  "widgets": [
    {
      object (Widgets)
    }
  ]
}
Campos
horizontalSizeStyle

enum (HorizontalSizeStyle)

Especifica como uma coluna preenche a largura do card.

horizontalAlignment

enum (HorizontalAlignment)

Especifica se os widgets estão alinhados à esquerda, à direita ou no centro de uma coluna.

verticalAlignment

enum (VerticalAlignment)

Especifica se os widgets estão alinhados na parte superior, inferior ou no centro de uma coluna.

widgets[]

object (Widgets)

Uma matriz de widgets incluídos em uma coluna. Os widgets aparecem na ordem em que são especificados.

HorizontalSizeStyle

Especifica como uma coluna preenche a largura do card. A largura de cada coluna depende HorizontalSizeStyle e a largura dos widgets na coluna.

Complementos do Google Workspace e apps do Chat

Enums
HORIZONTAL_SIZE_STYLE_UNSPECIFIED Não use. Não especificado.
FILL_AVAILABLE_SPACE Valor padrão. A coluna preenche o espaço disponível, até 70% da largura do cartão. Se as duas colunas estiverem definidas como FILL_AVAILABLE_SPACE, cada coluna preenche 50% do espaço.
FILL_MINIMUM_SPACE A coluna preenche a menor quantidade de espaço possível e não mais que 30% da largura do cartão.

HorizontalAlignment

Especifica se os widgets estão alinhados à esquerda, à direita ou no centro de uma coluna.

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

Enums
HORIZONTAL_ALIGNMENT_UNSPECIFIED Não use. Não especificado.
START Valor padrão. Alinha os widgets à posição inicial da coluna. Para layouts da esquerda para a direita, faz o alinhamento à esquerda. Para layouts da direita para a esquerda, alinha-se à direita.
CENTER Alinha os widgets ao centro da coluna.
END Alinha os widgets à posição final da coluna. Em layouts da esquerda para a direita, alinha os widgets à direita. Para layouts da direita para a esquerda, alinha os widgets à esquerda.

VerticalAlignment

Especifica se os widgets estão alinhados na parte superior, inferior ou no centro de uma coluna.

Complementos do Google Workspace e apps do Chat

Enums
VERTICAL_ALIGNMENT_UNSPECIFIED Não use. Não especificado.
CENTER Valor padrão. Alinha os widgets ao centro de uma coluna.
TOP Alinha os widgets ao topo de uma coluna.
BOTTOM Alinha os widgets à parte inferior de uma coluna.

Widgets

Os widgets compatíveis que você pode incluir em uma coluna.

Complementos do Google Workspace e apps do Chat

Representação JSON
{

  // Union field data can be only one of the following:
  "textParagraph": {
    object (TextParagraph)
  },
  "image": {
    object (Image)
  },
  "decoratedText": {
    object (DecoratedText)
  },
  "buttonList": {
    object (ButtonList)
  },
  "textInput": {
    object (TextInput)
  },
  "selectionInput": {
    object (SelectionInput)
  },
  "dateTimePicker": {
    object (DateTimePicker)
  },
  "chipList": {
    object (ChipList)
  }
  // End of list of possible types for union field data.
}
Campos

Campo de união data:

data pode ser apenas um dos seguintes:

textParagraph

object (TextParagraph)

TextParagraph widget.

image

object (Image)

Image widget.

decoratedText

object (DecoratedText)

Widget DecoratedText.

buttonList

object (ButtonList)

ButtonList widget.

textInput

object (TextInput)

TextInput widget.

selectionInput

object (SelectionInput)

SelectionInput widget.

dateTimePicker

object (DateTimePicker)

DateTimePicker widget.

chipList

object (ChipList)

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

ChipList

Uma lista de ícones disposta horizontalmente, que pode rolar horizontalmente ou ser contornada para a próxima linha.

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

Representação JSON
{
  "layout": enum (Layout),
  "chips": [
    {
      object (Chip)
    }
  ]
}
Campos
layout

enum (Layout)

Layout da lista de ícones especificado.

chips[]

object (Chip)

Uma matriz de ícones.

Layout

O layout da lista de ícones.

Enums
LAYOUT_UNSPECIFIED Não use. Não especificado.
WRAPPED Valor padrão. A lista de ícones vai aparecer na próxima linha se não houver espaço horizontal suficiente.
HORIZONTAL_SCROLLABLE Os ícones rolam horizontalmente se não se encaixarem no espaço disponível.

Ícone

Um ícone de texto, ícone ou texto e ícone em que os usuários podem clicar.

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

Representação JSON
{
  "icon": {
    object (Icon)
  },
  "label": string,
  "onClick": {
    object (OnClick)
  },
  "enabled": boolean,
  "disabled": boolean,
  "altText": string
}
Campos
icon

object (Icon)

A imagem do ícone. Se os dois icon e text estiver definido, o ícone aparecerá antes do texto.

label

string

O texto exibido dentro do ícone.

onClick

object (OnClick)

Opcional. A ação a ser realizada quando um usuário clica no ícone, como abrir um hiperlink ou executar uma função personalizada.

enabled
(deprecated)

boolean

Se o ícone está em um estado ativo e responde às ações do usuário. O padrão é true: Obsoleto. Usar disabled como alternativa.

disabled

boolean

Indica se o ícone está em um estado inativo e ignora as ações do usuário. O padrão é false:

altText

string

É o texto alternativo usado para acessibilidade.

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

CollapseControl

Representar um controle de abertura e fechamento. Disponível nos apps do Google Chat e indisponível para os complementos do Google Workspace.

Representação JSON
{
  "horizontalAlignment": enum (HorizontalAlignment),
  "expandButton": {
    object (Button)
  },
  "collapseButton": {
    object (Button)
  }
}
Campos
horizontalAlignment

enum (HorizontalAlignment)

O alinhamento horizontal dos botões de expandir e recolher.

expandButton

object (Button)

Opcional. Defina um botão personalizável para expandir a seção. Os campos expandButton e collapseButton precisam ser definidos. Apenas um conjunto de campos não entrará em vigor. Se esse campo não for definido, o botão padrão será usado.

collapseButton

object (Button)

Opcional. Defina um botão personalizável para recolher a seção. O campo "expandButton" e o " imagem" do botão do botão precisam ser definidos. Apenas um conjunto de campos não entrará em vigor. Se esse campo não for definido, o botão padrão será usado.

DividerStyle

O estilo do divisor de um card. No momento, essa opção é usada apenas para divisores entre as seções do cartão.

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

Enums
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 é renderizado. Esse estilo remove completamente o divisor do layout. O resultado é equivalente a não adicionar um divisor.

CardAction

Uma ação de card é a ação associada ao card. Por exemplo, um card de fatura pode incluir ações como excluir fatura, enviar fatura 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.

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

string

Rótulo exibido como o item do menu de ações.

onClick

object (OnClick)

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

CardFixedFooter

Um rodapé permanente (fixo) que aparece na parte inferior do cartão.

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

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

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

Representação JSON
{
  "primaryButton": {
    object (Button)
  },
  "secondaryButton": {
    object (Button)
  }
}
Campos
primaryButton

object (Button)

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

secondaryButton

object (Button)

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

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.

Enums
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 é exibido na pilha de cards. Se o cartão 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.