Cards v2

{
  "header": {
    object (CardHeader)
  },
  "sections": [
    {
      object (Section)
    }
  ],
  "sectionDividerStyle": enum (DividerStyle),
  "cardActions": [
    {
      object (CardAction)
    }
  ],
  "name": string,
  "fixedFooter": {
    object (CardFixedFooter)
  },
  "displayStyle": enum (DisplayStyle),
  "peekCardHeader": {
    object (CardHeader)
  }
}

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.

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.

enum (DividerStyle)

O estilo do divisor entre as seções.

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"
      }
    }
  }
]

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.

object (CardFixedFooter)

O rodapé fixo mostrado na parte inferior deste card.

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.

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

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.

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.

{
  "title": string,
  "subtitle": string,
  "imageType": enum (ImageType),
  "imageUrl": string,
  "imageAltText": string
}

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.

string

O subtítulo do cabeçalho do cartão. Se especificado, aparece na própria linha abaixo do title:

enum (ImageType)

A forma usada para cortar a imagem.

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

string

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

string

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

{
  "header": string,
  "widgets": [
    {
      object (Widget)
    }
  ],
  "collapsible": boolean,
  "uncollapsibleWidgetsCount": integer,
  "collapseControl": {
    object (CollapseControl)
  }
}

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.

object (Widget)

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

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.

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

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.

{
  "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.
}

enum (HorizontalAlignment)

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

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

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

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

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"
        }
      }
    }
  ]
}

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"
      }
    ]
  }
}

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

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

object (Divider)

Mostra uma linha horizontal entre os widgets.

Por exemplo, o JSON abaixo cria um divisor:

"divider": {
}

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

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"
          }
        }
      ]
    }
  ]
}

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.

{
  "text": string,
  "maxLines": integer
}

string

O texto mostrado no widget.

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.

{
  "imageUrl": string,
  "onClick": {
    object (OnClick)
  },
  "altText": string
}

string

O URL HTTPS que hospeda a imagem.

Exemplo:

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

object (OnClick)

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

string

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

{

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

object (Action)

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

object (OpenLink)

Se especificado, esse onClick aciona uma ação de abrir link.

object (Action)

Um complemento aciona essa ação quando ela precisa abrir um link. Isso é diferente da openLink que precisa se comunicar com o servidor para conseguir o link. Portanto, é necessário algum trabalho de preparação para o cliente da Web antes que a resposta da ação de abrir link seja retornada.

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

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.

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.

{
  "function": string,
  "parameters": [
    {
      object (ActionParameter)
    }
  ],
  "loadIndicator": enum (LoadIndicator),
  "persistValues": boolean,
  "interaction": enum (Interaction),
  "requiredWidgets": [
    string
  ],
  "allWidgetsAreRequired": boolean
}

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.

object (ActionParameter)

Lista de parâmetros de ação.

enum (LoadIndicator)

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

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.

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.

string

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.

boolean

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

{
  "key": string,
  "value": string
}

string

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

string

O valor do parâmetro.

{
  "url": string,
  "openAs": enum (OpenAs),
  "onClose": enum (OnClose)
}

string

O URL a ser aberto.

enum (OpenAs)

Como abrir um link.

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

enum (OnClose)

Se o cliente esquece um link depois de abri-lo ou o observa até que a janela seja fechada.

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

{
  "items": [
    {
      object (OverflowMenuItem)
    }
  ]
}

object (OverflowMenuItem)

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

{
  "startIcon": {
    object (Icon)
  },
  "text": string,
  "onClick": {
    object (OnClick)
  },
  "disabled": boolean
}

object (Icon)

O ícone exibido na frente do texto.

string

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

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.

boolean

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

{
  "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.
}

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.

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.

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.

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.

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.

{
  "name": string,
  "fill": boolean,
  "weight": integer,
  "grade": integer
}

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.

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.

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.

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.

{
  "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.
}

object (Icon)

Descontinuado em favor de startIcon.

object (Icon)

O ícone exibido na frente do texto.

string

O texto que aparece acima text. Sempre trunca.

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.

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.

string

O texto que aparece abaixo text: Sempre encapsula.

object (OnClick)

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

object (Button)

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

object (SwitchControl)

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

object (Icon)

Um ícone exibido após o texto.

Oferece suporte integrado e personalizado ícones

{
  "text": string,
  "icon": {
    object (Icon)
  },
  "color": {
    object (Color)
  },
  "onClick": {
    object (OnClick)
  },
  "disabled": boolean,
  "altText": string,
  "type": enum (Type)
}

string

O texto exibido dentro do botão.

object (Icon)

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

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.

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.

boolean

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

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

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.

{
  "red": number,
  "green": number,
  "blue": number,
  "alpha": number
}

number

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

number

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

number

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

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

{
  "name": string,
  "value": string,
  "selected": boolean,
  "onChangeAction": {
    object (Action)
  },
  "controlType": enum (ControlType)
}

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.

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.

boolean

Quando true, a chave é selecionada.

object (Action)

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

enum (ControlType)

Como a chave aparece na interface do usuário.

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

{
  "buttons": [
    {
      object (Button)
    }
  ]
}

object (Button)

Uma matriz de botões.

{
  "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
}

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.

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.

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.

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.

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.

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.

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.

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.

object (Validation)

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

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.

Action

Navigation

Envie ou atualize os cards exibidos.

Card

A pilha de cards envia um cartão para a pilha.

Card

A pilha de cards atualiza o card superior com um novo card e preserva os valores dos campos preenchidos do formulário. Para um campo não equivalente, o valor é descartado.

{
  "items": [
    {
      object (SuggestionItem)
    }
  ]
}

object (SuggestionItem)

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

{

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

string

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

{
  "characterLimit": integer,
  "inputType": enum (InputType)
}

integer

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

enum (InputType)

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

{
  "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.
}

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.

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

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.

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.

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.

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.

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.

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.

object (Action)

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

object (PlatformDataSource)

Uma fonte de dados do Google Workspace.

{
  "text": string,
  "value": string,
  "selected": boolean,
  "startIconUri": string,
  "bottomText": string
}

string

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

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.

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.

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:

string

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

{

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

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.

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.

{

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

object (ChatClientDataSourceMarkup)

Uma fonte de dados do Google Chat.

{

  // Union field source can be only one of the following:
  "spaceDataSource": {
    object (SpaceDataSource)
  }
  // End of list of possible types for union field source.
}

object (SpaceDataSource)

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

{
  "defaultToCurrentSpace": boolean
}

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.

{
  "name": string,
  "label": string,
  "type": enum (DateTimePickerType),
  "valueMsEpoch": string,
  "timezoneOffsetDate": integer,
  "onChangeAction": {
    object (Action)
  },
  "validation": {
    object (Validation)
  }
}

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.

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.

enum (DateTimePickerType)

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

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

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.

object (Action)

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

object (Validation)

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

{
  "title": string,
  "items": [
    {
      object (GridItem)
    }
  ],
  "borderStyle": {
    object (BorderStyle)
  },
  "columnCount": integer,
  "onClick": {
    object (OnClick)
  }
}

string

O texto exibido no cabeçalho da grade.

object (GridItem)

Itens a serem exibidos na grade.

object (BorderStyle)

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

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

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.

{
  "id": string,
  "image": {
    object (ImageComponent)
  },
  "title": string,
  "subtitle": string,
  "layout": enum (GridItemLayout)
}

string

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

object (ImageComponent)

A imagem que aparece no item da grade.

string

O título do item da grade.

string

O subtítulo do item da grade.

enum (GridItemLayout)

O layout a ser usado para o item da grade.

{
  "imageUri": string,
  "altText": string,
  "cropStyle": {
    object (ImageCropStyle)
  },
  "borderStyle": {
    object (BorderStyle)
  }
}

string

O URL da imagem.

string

O rótulo de acessibilidade da imagem.

object (ImageCropStyle)

O estilo de corte a ser aplicado à imagem.

object (BorderStyle)

O estilo da borda que será aplicado à imagem.

{
  "type": enum (ImageCropType),
  "aspectRatio": number
}

enum (ImageCropType)

O tipo de corte.

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
}

{
  "type": enum (BorderType),
  "strokeColor": {
    object (Color)
  },
  "cornerRadius": integer
}

enum (BorderType)

O tipo de borda.

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.

integer

O raio do canto da borda.

{
  "columnItems": [
    {
      object (Column)
    }
  ]
}

object (Column)

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

{
  "horizontalSizeStyle": enum (HorizontalSizeStyle),
  "horizontalAlignment": enum (HorizontalAlignment),
  "verticalAlignment": enum (VerticalAlignment),
  "widgets": [
    {
      object (Widgets)
    }
  ]
}

enum (HorizontalSizeStyle)

Especifica como uma coluna preenche a largura do card.

enum (HorizontalAlignment)

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

enum (VerticalAlignment)

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

object (Widgets)

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

{

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

object (TextParagraph)

TextParagraph widget.

object (Image)

Image widget.

object (DecoratedText)

Widget DecoratedText.

object (ButtonList)

ButtonList widget.

object (TextInput)

TextInput widget.

object (SelectionInput)

SelectionInput widget.

object (DateTimePicker)

DateTimePicker widget.

object (ChipList)

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

{
  "layout": enum (Layout),
  "chips": [
    {
      object (Chip)
    }
  ]
}

enum (Layout)

Layout da lista de ícones especificado.

object (Chip)

Uma matriz de ícones.

{
  "icon": {
    object (Icon)
  },
  "label": string,
  "onClick": {
    object (OnClick)
  },
  "enabled": boolean,
  "disabled": boolean,
  "altText": string
}

object (Icon)

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

string

O texto exibido dentro do ícone.

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.

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.

boolean

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

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

{
  "horizontalAlignment": enum (HorizontalAlignment),
  "expandButton": {
    object (Button)
  },
  "collapseButton": {
    object (Button)
  }
}

enum (HorizontalAlignment)

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

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.

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.

{
  "actionLabel": string,
  "onClick": {
    object (OnClick)
  }
}

string

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

object (OnClick)

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

{
  "primaryButton": {
    object (Button)
  },
  "secondaryButton": {
    object (Button)
  }
}

object (Button)

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

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.