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. Os cabeçalhos geralmente contêm uma imagem inicial e um título. Os cabeçalhos sempre aparecem na parte superior de um cartão.

object (Section)

Contém uma coleção de widgets. Cada seção tem o próprio cabeçalho opcional. As seções são visualmente separadas por um divisor de linhas. Para ver um exemplo nos apps do Google Chat, consulte a seção "Card".

enum (DividerStyle)

O estilo de divisor entre seções.

object (CardAction)

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

Como os cards do app do Chat não têm barra de ferramentas, cardActions[] não é compatível com os apps do Chat.

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

"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 identificador do cartão na navegação.

Como os apps de chat não são compatíveis com a navegação por cards, eles ignoram esse campo.

object (CardFixedFooter)

O rodapé fixo mostrado na parte inferior deste card.

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

Com suporte nos complementos do Google Workspace e nos apps do Chat. Em apps de chat, você pode usar rodapés fixos em caixas de diálogo, mas não em mensagens com cards.

enum (DisplayStyle)

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

Indisponível nos apps de chat.

object (CardHeader)

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

Indisponível nos apps de 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 ocupa 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, ele aparece na própria linha abaixo de title.

enum (ImageType)

Forma usada para cortar a imagem.

string

O URL HTTPS da imagem no cabeçalho do cartão.

string

O texto alternativo desta imagem que é usado para acessibilidade.

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

string

Texto que aparece na parte superior de uma seção. Suporta texto formatado em HTML simples. Para mais informações sobre formatação de texto, consulte Formatar texto em apps do Google Chat e Formatar texto em complementos do Google Workspace.

object (Widget)

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

boolean

Indica se esta seção pode ser fechada.

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

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

integer

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

Por exemplo, quando uma seção contém cinco widgets e a uncollapsibleWidgetsCount está definida como 2, os dois primeiros widgets são sempre mostrados, e os três últimos ficam recolhidos por padrão. O uncollapsibleWidgetsCount é considerado apenas quando collapsible é true.

{
  "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)
  }
  // End of list of possible types for union field data.
}

enum (HorizontalAlignment)

Especifica se os widgets se alinham à esquerda, à direita ou ao centro de uma coluna.

object (TextParagraph)

Mostra um parágrafo de texto. Suporta texto formatado em HTML simples. Para mais informações sobre formatação de texto, consulte Formatar texto em apps do Google Chat e Formatar texto em complementos do Google Workspace.

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

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

object (Image)

Exibe uma imagem.

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

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

object (DecoratedText)

Exibe 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,
        "alpha": 1
      },
      "disabled": true,
    },
    {
      "icon": {
        "knownIcon": "INVITE",
        "altText": "check calendar"
      },
      "onClick": {
        "openLink": {
          "url": "https://example.com/calendar"
        }
      }
    }
  ]
}

object (TextInput)

Exibe uma caixa de texto em que 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, interruptores 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)

Exibe um widget que permite aos usuários inserir 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)

Exibe um divisor de linha horizontal entre os widgets.

Por exemplo, o JSON a seguir cria um divisor:

"divider": {
}

object (Grid)

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

Uma grade é compatível com várias colunas e itens. O número de linhas é determinado pelos limites superiores do número de itens divididos 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.

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 usar linhas, utilize o widget Grid.

Por exemplo, o JSON a seguir cria duas colunas, cada uma com 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"
          }
        }
      ]
    }
  ]
}

{
  "text": string
}

string

O texto que é mostrado no widget.

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

string

É o URL HTTPS que hospeda a imagem.

Por exemplo:

https://developers.google.com/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)
  }
  // End of list of possible types for union field data.
}

object (Action)

Se especificado, uma ação será acionada por este onClick.

object (OpenLink)

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

object (Action)

Um complemento aciona essa ação quando é necessário abrir um link. Ele é diferente do openLink acima, porque precisa se comunicar com o servidor para receber o link. Assim, é necessário algum trabalho de preparação para que o cliente Web faça antes que a resposta da ação de link aberto volte. Compatível com os complementos do Google Workspace, mas não com os apps do Google Chat.

object (Card)

Um novo cartão é enviado para a pilha de cartões após um clique, se especificado.

Compatível com os complementos do Google Workspace, mas não com os apps do Google Chat.

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

string

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

Para exemplo de uso, consulte Criar cards interativos.

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 após a ação ser acionada. Para permitir que o usuário faça mudanças enquanto a ação é processada, defina LoadIndicator como NONE. Para mensagens de cards em apps de chat, também é necessário definir o ResponseType da ação como UPDATE_MESSAGE e usar o mesmo cardId do card que continha a ação.

Se for false, os valores do formulário serão apagados quando a ação for acionada. Para evitar que o usuário faça mudanças enquanto a ação é 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 o usuário, como clicar em um botão em uma mensagem de card

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

Ao especificar uma interaction, o app pode responder de maneiras interativas especiais. Por exemplo, definindo interaction como OPEN_DIALOG, o app pode abrir uma caixa de diálogo. Quando especificado, um indicador de carregamento não é exibido.

Compatível com apps do Chat, mas não com complementos do Google Workspace. Se especificado para um complemento, o cartão inteiro será removido e nada será exibido no cliente.

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

string

Nome do parâmetro do 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. Indisponível nos apps de chat.

enum (OnClose)

Se o cliente se esquece de um link depois de abri-lo ou o observa até a janela ser fechada. Indisponível nos apps de chat.

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

O uso foi suspenso e substituído por startIcon.

object (Icon)

Ícone exibido na frente do texto.

string

O texto que aparece acima de text. Sempre trunca.

string

Obrigatório. O texto principal.

Compatível com formatação simples. Para mais informações sobre formatação de texto, consulte Formatar texto em apps do Google Chat e Formatar texto em complementos do Google Workspace.

boolean

A configuração de ajuste de texto. Se for true, o texto vai ser ajustado e exibido em várias linhas. Caso contrário, o texto fica truncado.

Só se aplica a text, não a topLabel e bottomLabel.

string

O texto que aparece abaixo de text. Sempre une.

object (OnClick)

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

object (Button)

Um botão em que um usuário pode clicar para acionar uma ação.

object (SwitchControl)

Um widget de alternância em que um usuário pode clicar para mudar o estado e acionar uma ação.

object (Icon)

Um ícone exibido após o texto.

Oferece suporte a ícones integrados e personalizados.

{
  "altText": string,
  "imageType": enum (ImageType),

  // Union field icons can be only one of the following:
  "knownIcon": string,
  "iconUrl": string
  // 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, será fornecido o valor padrão Button. Como prática recomendada, defina uma descrição útil para o que o ícone exibe e, se aplicável, para 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/chat.

Se o ícone estiver definido em um Button, o altText aparecerá como texto auxiliar quando o usuário passar o cursor sobre o botão. No entanto, se o botão também definir text, o altText do ícone será ignorado.

enum (ImageType)

O estilo de corte aplicado à imagem. Em alguns casos, aplicar um corte CIRCLE faz com que a imagem seja desenhada maior 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 uma lista completa de ícones compatíveis, consulte ícones integrados.

string

Mostre um ícone personalizado hospedado em um URL HTTPS.

Por exemplo:

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

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

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

string

O texto exibido dentro do botão.

object (Icon)

A imagem do ícone. Se icon e text estiverem definidos, o ícone vai aparecer antes do texto.

object (Color)

Se definido, o botão vai ser preenchido com uma cor de plano de fundo sólida, e a cor da fonte vai mudar para manter o contraste. Por exemplo, definir um plano de fundo azul provavelmente resulta em texto branco.

Se não for definido, o plano de fundo da imagem será branco e a cor da fonte será azul.

Para vermelho, verde e azul, o valor de cada campo é um número float que pode ser expresso de duas maneiras: como um número entre 0 e 255 dividido por 255 (153/255) ou como um valor entre 0 e 1 (0,6). Zero representa a ausência de uma cor e 1 ou 255/255 representa a presença total dessa cor na escala RGB.

Como opção, defina alpha, que define um nível de transparência usando esta equação:

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

Para alpha, um valor de 1 corresponde a uma cor sólida, e um valor de 0 corresponde a uma cor completamente transparente.

Por exemplo, a cor a seguir representa um vermelho meio transparente:

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

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 for true, o botão será exibido em um estado inativo e não 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, você pode escrever: "Abre uma nova guia do navegador e acessa a documentação do desenvolvedor do Google Chat em https://developers.google.com/chat".

{
  "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 um valor de 1,0).

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

string

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

Para detalhes sobre como trabalhar com entradas de formulário, consulte Receber dados de 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 de formulário.

boolean

Quando true, a chave será selecionada.

object (Action)

A ação a ser executada quando o estado da chave muda, como qual função será executada.

enum (ControlType)

Como a chave aparece na interface do usuário.

{
  "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)
  },
  "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 de 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 necessárias para o app. Por exemplo, se você estiver perguntando o nome de alguém, mas precisar especificamente do sobrenome, escreva surname em vez de name.

Obrigatório se hintText não for 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 fica sempre visível.

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

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 de formulário.

enum (Type)

Como um campo de entrada de texto aparece na interface do usuário. Por exemplo, se o campo é único ou de várias linhas.

object (Action)

O que fazer quando ocorre uma alteração no campo de entrada de texto. Por exemplo, um usuário adicionando algo ao campo 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 dentro do campo de entrada de texto. À medida que os usuários digitam, os valores sugeridos são filtrados dinamicamente para corresponder ao que os usuários 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 sugestões filtra para mostrar apenas Java e JavaScript.

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

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

object (Action)

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

Se não for especificada, as sugestões serão definidas por initialSuggestions e processadas pelo cliente.

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

Compatível com os complementos do Google Workspace, mas não com os apps do Google Chat.

string

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

Compatível com apps do Google Chat, mas não com complementos do Google Workspace.

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

object (SuggestionItem)

Uma lista de sugestões usadas para recomendações de preenchimento automático em 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

Valor de uma entrada sugerida para um campo de entrada de texto. Isso é equivalente ao que os usuários inserem.

{
  "name": string,
  "label": string,
  "type": enum (SelectionType),
  "items": [
    {
      object (SelectionItem)
    }
  ],
  "onChangeAction": {
    object (Action)
  },
  "multiSelectMaxSelectedItems": integer,
  "multiSelectMinQueryLength": integer,

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

Nome que identifica a entrada da seleção em um evento de entrada de formulário.

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

string

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 necessárias para o app. Por exemplo, se os usuários selecionarem a urgência de um tíquete de trabalho em um menu suspenso, o rótulo poderá ser "Urgência" ou "Selecionar urgência".

enum (SelectionType)

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

object (SelectionItem)

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

object (Action)

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

Para detalhes 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, defina como três itens.

integer

Nos menus de seleção múltipla, o número de caracteres de texto que um usuário insere antes do preenchimento automático da consulta do app do Chat e de itens sugeridos no card.

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

object (Action)

Uma fonte de dados externa, como uma base de dados relacional.

object (PlatformDataSource)

Uma fonte de dados de um aplicativo host 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

Valor associado ao item. O cliente deve usar isso como um valor de entrada de formulário.

Para detalhes sobre como trabalhar com entradas de formulário, consulte Receber dados de 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 apenas para um item.

string

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

string

Para menus de seleção múltipla, uma descrição ou rótulo de texto exibido abaixo do campo text do item.

{

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

Para um widget SelectionInput que usa um menu de seleção múltipla, uma fonte de dados compartilhada por todos os aplicativos host do Google Workspace, como usuários em uma organização do Google Workspace.

object (HostAppDataSourceMarkup)

Uma fonte de dados exclusiva de um aplicativo host do Google Workspace, como e-mails do Gmail, eventos do Google Agenda ou mensagens do Google Chat.

{

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

A fonte de dados é o 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)

Uma fonte de dados que representa um espaço do Google Chat.

Formato: espaços/{space}

{
  "defaultToCurrentSpace": boolean
}

boolean

Quando true, usa o espaço do Google Chat do card como seleção padrão. O valor padrão é false.

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

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 de 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 é compatível com a inserção de data, hora ou data e hora.

string (int64 format)

O valor padrão exibido no widget, em milissegundos, desde o horário da era Unix (link em inglês).

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

• DATE_AND_TIME: uma 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 do fuso horário em relação ao UTC, em minutos. Se definido, o valueMsEpoch vai ser mostrado no fuso horário especificado. Se ela não for definida, o valor padrão será a configuração de fuso horário do usuário.

object (Action)

Acionado quando o usuário clica em Salvar ou Limpar na interface DateTimePicker.

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

string

O texto que é exibido no cabeçalho da grade.

object (GridItem)

Itens a serem exibidos na grade.

object (BorderStyle)

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

integer

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

object (OnClick)

Esse callback é reutilizado por cada item 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

Um identificador especificado pelo usuário para este item da grade. Esse identificador é retornado nos parâmetros de callback onClick da grade pai.

object (ImageComponent)

É a imagem mostrada 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 de 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 de borda a 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, veja 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.

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 cartão.

enum (HorizontalAlignment)

Especifica se os widgets se alinham à esquerda, à direita ou ao centro de uma coluna.

enum (VerticalAlignment)

Especifica se os widgets são alinhados à parte superior, inferior ou ao 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)
  }
  // End of list of possible types for union field data.
}

object (TextParagraph)

Widget TextParagraph.

object (Image)

Widget Image.

object (DecoratedText)

Widget DecoratedText.

object (ButtonList)

Widget ButtonList.

object (TextInput)

Widget TextInput.

object (SelectionInput)

Widget SelectionInput.

object (DateTimePicker)

Widget DateTimePicker.

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

string

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

object (OnClick)

A ação onClick desse item de ação.

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

object (Button)

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

object (Button)

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