- Recurso: Message
- Representação JSON
- Card
- CardHeader
- ImageStyle
- Seção
- WidgetMarkup
- TextParagraph
- Imagem
- OnClick
- FormAction
- ActionParameter
- OpenLink
- KeyValue
- Ícone
- Botão
- TextButton
- ImageButton
- CardAction
- CardWithId
- Cartão
- CardHeader
- ImageType
- Seção
- Widget
- TextParagraph
- TextSyntax
- Imagem
- OnClick
- Ação
- ActionParameter
- LoadIndicator
- Interação
- OpenLink
- OpenAs
- OnClose
- OverflowMenu
- OverflowMenuItem
- Ícone
- MaterialIcon
- DecoratedText
- VerticalAlignment
- Botão
- Cor
- Tipo
- SwitchControl
- ControlType
- ButtonList
- TextInput
- Tipo
- Sugestões
- SuggestionItem
- Validação
- InputType
- HostAppDataSourceMarkup
- ChatClientDataSourceMarkup
- SpaceDataSource
- WorkflowDataSourceMarkup
- Tipo
- SelectionInput
- SelectionType
- SelectionItem
- PlatformDataSource
- CommonDataSource
- DataSourceConfig
- DateTimePicker
- DateTimePickerType
- Divider
- Grade
- GridItem
- ImageComponent
- ImageCropStyle
- ImageCropType
- BorderStyle
- BorderType
- GridItemLayout
- Colunas
- Coluna
- HorizontalSizeStyle
- HorizontalAlignment
- VerticalAlignment
- Widgets
- ChipList
- Layout
- Ícone
- Carrossel
- CarouselCard
- NestedWidget
- Visibilidade
- EventAction
- Acionador
- CommonWidgetAction
- UpdateVisibilityAction
- CollapseControl
- DividerStyle
- CardAction
- CardFixedFooter
- DisplayStyle
- ExpressionData
- Condição
- ExpressionDataCondition
- ConditionType
- Anotação
- AnnotationType
- UserMentionMetadata
- Tipo
- SlashCommandMetadata
- Tipo
- RichLinkMetadata
- RichLinkType
- DriveLinkData
- ChatSpaceLinkData
- MeetSpaceLinkData
- Tipo
- HuddleStatus
- CalendarEventLinkData
- CustomEmojiMetadata
- Thread
- ActionResponse
- ResponseType
- DialogAction
- Caixa de diálogo
- ActionStatus
- Código
- UpdatedWidget
- SelectionItems
- SlashCommand
- MatchedUrl
- EmojiReactionSummary
- DeletionMetadata
- DeletionType
- QuotedMessageMetadata
- QuoteType
- QuotedMessageSnapshot
- ForwardedMetadata
- AttachedGif
- AccessoryWidget
- Elementos
- CitedSource
- Snippet
- ElementsImage
- Rodapé
- Citação
- MarkupSyntax
- Métodos
Recurso: Message
Uma mensagem em um espaço do Google Chat.
| Representação JSON |
|---|
{ "name": string, "sender": { object ( |
| Campos | |
|---|---|
name |
Identificador. Nome do recurso da mensagem. Formato: Em que Se você definir um código personalizado ao criar uma mensagem, poderá usá-lo para especificar a mensagem em uma solicitação, substituindo |
sender |
Apenas saída. O usuário que criou a mensagem. Se o app do Chat for autenticado como um usuário, a saída vai preencher apenas os campos |
createTime |
Opcional. Imutável. Para espaços criados no Chat, o horário em que a mensagem foi criada. Este campo é somente saída, exceto quando usado em espaços do modo de importação. Para espaços no modo de importação, defina esse campo como o carimbo de data/hora histórico em que a mensagem foi criada na origem para preservar o horário de criação original. |
lastUpdateTime |
Apenas saída. A hora em que a mensagem foi editada pela última vez por um usuário. Se a mensagem nunca tiver sido editada, esse campo vai ficar vazio. |
deleteTime |
Apenas saída. O horário em que a mensagem foi excluída no Google Chat. Se a mensagem nunca for excluída, esse campo ficará vazio. |
text |
Opcional. Corpo de texto simples da mensagem. O primeiro link para uma imagem, vídeo ou página da Web gera um ícone de visualização. Você também pode @mencionar um usuário do Google Chat ou todos no espaço. Para saber como criar mensagens de texto, consulte Enviar uma mensagem. |
formattedText |
Apenas saída. Contém a mensagem
Para mais informações, consulte Ver a formatação de texto enviada em uma mensagem. |
cards[] |
Descontinuado: use Cards avançados, formatados e interativos que podem ser usados para mostrar elementos da interface, como textos formatados, botões e imagens clicáveis. Os cards normalmente aparecem abaixo do corpo de texto simples da mensagem. |
cardsV2[] |
Opcional. Uma matriz de cards. Os apps do Chat podem criar cards com a autenticação de apps. Como parte do Programa de prévia para desenvolvedores, se o app do Chat se autenticar como usuário, ele poderá criar mensagens de card. Se o app do Chat não fizer parte do Programa de Prévia para Desenvolvedores, ele não poderá criar cards com autenticação de usuário. Para saber como criar uma mensagem que contém cards, consulte Enviar uma mensagem. Crie e visualize cards com o Criador de cards. Abra o Criador de Cards |
annotations[] |
Apenas saída. As anotações podem ser associadas ao corpo de texto simples da mensagem ou a ícones que levam a recursos do Google Workspace, como o Google Docs ou as Planilhas, com |
thread |
A conversa a que a mensagem pertence. Para ver um exemplo de uso, consulte Iniciar ou responder a uma conversa de mensagem. |
space |
Apenas saída. Se o app do Chat for autenticado como um usuário, a saída vai preencher apenas o |
fallbackText |
Opcional. Uma descrição em texto simples dos cards da mensagem, usada quando os cards reais não podem ser exibidos, por exemplo, em notificações no dispositivo móvel. |
actionResponse |
Somente entrada. Parâmetros que um app do Chat pode usar para configurar como a resposta é postada. |
argumentText |
Apenas saída. Corpo de texto simples da mensagem sem as menções ao app do Chat. |
slashCommand |
Apenas saída. Informações sobre o comando de barra, se aplicável. |
attachment[] |
Opcional. Anexo enviado pelo usuário. |
matchedUrl |
Apenas saída. Um URL no campo |
threadReply |
Apenas saída. Quando Se o espaço não for compatível com respostas em conversas, esse campo será sempre |
silent |
Apenas saída. Se esta é uma mensagem silenciosa. As mensagens silenciosas são aquelas em que o Chat suprime as notificações push para os destinatários. |
clientAssignedMessageId |
Opcional. Um código personalizado para a mensagem. Você pode usar o campo para identificar, receber, excluir ou atualizar uma mensagem. Para definir um código personalizado, especifique o campo |
emojiReactionSummaries[] |
Apenas saída. A lista de resumos de reações com emoji na mensagem. |
privateMessageViewer |
Opcional. Imutável. Entrada para criar uma mensagem, caso contrário, somente saída. O usuário que pode ver a mensagem. Quando definido, a mensagem é particular e fica visível apenas para o usuário especificado e o app do Chat. Para incluir esse campo na solicitação, chame a API Chat usando a autenticação do app e omita o seguinte: Para mais detalhes, consulte Enviar uma mensagem particular. |
deletionMetadata |
Apenas saída. Informações sobre uma mensagem excluída. Uma mensagem é excluída quando |
quotedMessageMetadata |
Opcional. Informações sobre uma mensagem que outra mensagem cita. Ao criar uma mensagem, você pode citar mensagens na mesma conversa ou citar uma mensagem raiz para criar outra. No entanto, não é possível citar uma resposta de mensagem de uma conversa diferente. Ao atualizar uma mensagem, não é possível adicionar ou substituir o campo Para ver um exemplo de uso, consulte Citar outra mensagem. |
attachedGifs[] |
Apenas saída. Imagens GIF anexadas à mensagem. |
accessoryWidgets[] |
Opcional. Um ou mais widgets interativos que aparecem na parte de baixo de uma mensagem. É possível adicionar widgets de acessório a mensagens que contêm texto, cards ou ambos. Não há suporte para mensagens que contêm caixas de diálogo. Para mais detalhes, consulte Adicionar widgets interativos na parte de baixo de uma mensagem. Para criar uma mensagem com widgets acessórios, é necessário fazer a autenticação do app. |
elements |
Opcional. Os elementos são componentes adicionais fornecidos durante a criação da mensagem que podem ou não estar associados a partes específicas do texto da mensagem. Elas são diferentes das anotações, que são somente de saída e oferecem informações complementares vinculadas a fragmentos de mensagens ou ao texto inteiro da mensagem. |
markupSyntax |
Opcional. Especifica como o servidor interpreta o conteúdo do campo |
CardWithId
Uma ficha de informações em uma mensagem de chat do Google Chat.
Os apps do Chat podem criar cards com a autenticação de apps. Como parte do Programa de prévia para desenvolvedores, se o app do Chat se autenticar como usuário, ele poderá criar mensagens de card. Se o app do Chat não fizer parte do Programa de Prévia para Desenvolvedores, ele não poderá criar cards com autenticação de usuário.
Para saber como criar uma mensagem que contém cards, consulte Enviar uma mensagem.
Crie e visualize cards com o Criador de cards.
Abra o Criador de Cards| Representação JSON |
|---|
{ "cardId": string, "card": { object ( |
| Campos | |
|---|---|
cardId |
Obrigatório se a mensagem tiver vários cards. Um identificador exclusivo de um card em uma mensagem. |
card |
Um cartão. O tamanho máximo é de 32 KB. |
ownerUser |
Apenas saída. O app proprietário do cartão. |
Annotation
As anotações podem ser associadas ao corpo de texto simples da mensagem ou a ícones que levam a recursos do Google Workspace, como o Google Docs ou as Planilhas, com startIndex e length de 0. Para adicionar formatação básica a uma mensagem de texto, consulte Formatar mensagens de texto.
Exemplo de corpo da mensagem em texto simples:
Hello @FooBot how are you!"
Os metadados de anotações correspondentes:
"annotations":[{
"type":"USER_MENTION",
"startIndex":6,
"length":7,
"userMention": {
"user": {
"name":"users/{user}",
"displayName":"FooBot",
"avatarUrl":"https://goo.gl/aeDtrS",
"type":"BOT"
},
"type":"MENTION"
}
}]
| Representação JSON |
|---|
{ "type": enum ( |
| Campos | |
|---|---|
type |
O tipo da anotação. |
length |
Comprimento da substring no corpo da mensagem de texto simples a que essa anotação corresponde. Se não estiver presente, indica um comprimento de 0. |
startIndex |
Índice inicial (baseado em 0, inclusive) no corpo da mensagem de texto simples a que essa anotação corresponde. |
| Metadados adicionais sobre a anotação. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta: | |
userMention |
Os metadados da menção ao usuário. |
slashCommand |
Os metadados de um comando de barra. |
richLinkMetadata |
Os metadados de um link avançado. |
customEmojiMetadata |
Os metadados de um emoji personalizado. |
| Fim dos campos mutuamente exclusivos. | |
AnnotationType
Tipo da anotação.
| Tipos enumerados | |
|---|---|
ANNOTATION_TYPE_UNSPECIFIED |
Valor padrão do tipo enumerado. Não use. |
USER_MENTION |
Um usuário é mencionado. |
SLASH_COMMAND |
Um comando de barra é invocado. |
RICH_LINK |
Uma anotação de link avançado. |
CUSTOM_EMOJI |
Uma anotação de emoji personalizado. |
UserMentionMetadata
Metadados de anotação para menções de usuários (@).
| Representação JSON |
|---|
{ "user": { object ( |
| Campos | |
|---|---|
user |
O usuário mencionado. |
type |
O tipo de menção ao usuário. |
Tipo
| Tipos enumerados | |
|---|---|
TYPE_UNSPECIFIED |
Valor padrão do tipo enumerado. Não use. |
ADD |
Adicionar usuário ao espaço. |
MENTION |
Mencionar usuário no espaço. |
SlashCommandMetadata
Metadados de anotação para comandos de barra (/).
| Representação JSON |
|---|
{ "bot": { object ( |
| Campos | |
|---|---|
bot |
O app do Chat que teve o comando invocado. |
type |
O tipo de comando de barra. |
commandName |
O nome do comando de barra invocado. |
commandId |
O ID do comando de barra invocado. |
triggersDialog |
Indica se o comando de barra é para uma caixa de diálogo. |
Tipo
| Tipos enumerados | |
|---|---|
TYPE_UNSPECIFIED |
Valor padrão do tipo enumerado. Não use. |
ADD |
Adicionar o app do Chat ao espaço. |
INVOKE |
Invoque o comando de barra no espaço. |
RichLinkMetadata
Um link avançado para um recurso. Os links avançados podem ser associados ao corpo de texto simples da mensagem ou representar ícones que levam a recursos do Google Workspace, como o Google Docs ou as Planilhas, com startIndex e length de 0.
| Representação JSON |
|---|
{ "uri": string, "richLinkType": enum ( |
| Campos | |
|---|---|
uri |
O URI desse link. |
richLinkType |
O tipo de link avançado. |
| Dados do recurso vinculado. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta: | |
driveLinkData |
Dados de um link do Drive. |
chatSpaceLinkData |
Dados de um link de espaço do Chat. |
meetSpaceLinkData |
Dados de um link de espaço para reuniões. |
calendarEventLinkData |
Dados de um link de evento da agenda. |
| Fim dos campos mutuamente exclusivos. | |
RichLinkType
O tipo de link avançado. Mais tipos podem ser adicionados no futuro.
| Tipos enumerados | |
|---|---|
RICH_LINK_TYPE_UNSPECIFIED |
Valor padrão do tipo enumerado. Não use. |
DRIVE_FILE |
Um tipo de link avançado do Google Drive. |
CHAT_SPACE |
Um tipo de link avançado de espaço do Chat. Por exemplo, um ícone inteligente de espaço. |
GMAIL_MESSAGE |
Um tipo de link avançado de mensagem do Gmail. Especificamente, um ícone do Gmail de Compartilhar no Chat. A API só é compatível com a leitura de mensagens com links diretos GMAIL_MESSAGE. |
MEET_SPACE |
Um tipo de link avançado de mensagem do Meet. Por exemplo, um ícone do Meet. |
CALENDAR_EVENT |
Um tipo de link de mensagem da Agenda. Por exemplo, um ícone da Agenda. |
DriveLinkData
Dados para links do Google Drive.
| Representação JSON |
|---|
{
"driveDataRef": {
object ( |
| Campos | |
|---|---|
driveDataRef |
Uma DriveDataRef que faz referência a um arquivo do Google Drive. |
mimeType |
O tipo MIME do recurso vinculado do Google Drive. |
ChatSpaceLinkData
Dados para links de espaços do Chat.
| Representação JSON |
|---|
{ "space": string, "thread": string, "message": string } |
| Campos | |
|---|---|
space |
O espaço do recurso de espaço do Chat vinculado. Formato: |
thread |
A conversa do recurso de espaço do Chat vinculado. Formato: |
message |
A mensagem do recurso de espaço do Chat vinculado. Formato: |
MeetSpaceLinkData
Dados dos links de espaços para reuniões.
| Representação JSON |
|---|
{ "meetingCode": string, "type": enum ( |
| Campos | |
|---|---|
meetingCode |
Código da reunião do espaço do Meet vinculado. |
type |
Indica o tipo de espaço para reuniões. |
huddleStatus |
Opcional. Apenas saída. Se o Meet for uma reunião rápida, indica o status dela. Caso contrário, ele não será definido. |
Tipo
O tipo de espaço para reuniões.
| Tipos enumerados | |
|---|---|
TYPE_UNSPECIFIED |
Valor padrão do tipo enumerado. Não use. |
MEETING |
O espaço para reuniões do Meet é uma reunião. |
HUDDLE |
O espaço para reuniões do Meet é uma reunião rápida. |
HuddleStatus
O status da reunião
| Tipos enumerados | |
|---|---|
HUDDLE_STATUS_UNSPECIFIED |
Valor padrão do tipo enumerado. Não use. |
STARTED |
A reunião rápida começou. |
ENDED |
A reunião rápida foi encerrada. Nesse caso, o URI e os identificadores do espaço para reuniões não serão mais válidos. |
MISSED |
A reunião rápida foi perdida. Nesse caso, o URI e os identificadores do espaço para reuniões não serão mais válidos. |
CalendarEventLinkData
Dados para links de eventos da Agenda.
| Representação JSON |
|---|
{ "calendarId": string, "eventId": string } |
| Campos | |
|---|---|
calendarId |
O identificador da agenda vinculada. |
eventId |
O identificador do evento do evento da agenda vinculado. |
CustomEmojiMetadata
Metadados de anotação para emojis personalizados.
| Representação JSON |
|---|
{
"customEmoji": {
object ( |
| Campos | |
|---|---|
customEmoji |
O emoji personalizado. |
Conversa
Uma conversa em um espaço do Google Chat. Para ver um exemplo de uso, consulte Iniciar ou responder a uma conversa de mensagem.
Se você especificar uma conversa ao criar uma mensagem, poderá definir o campo messageReplyOption para determinar o que acontece se nenhuma conversa correspondente for encontrada.
| Representação JSON |
|---|
{ "name": string, "threadKey": string } |
| Campos | |
|---|---|
name |
Identificador. Nome do recurso da conversa. Exemplo: |
threadKey |
Opcional. Entrada para criar ou atualizar uma conversa. Caso contrário, somente saída. ID da conversa. Aceita até 4.000 caracteres. Esse ID é exclusivo do app do Chat que o define. Por exemplo, se vários apps do Chat criarem uma mensagem usando a mesma chave de conversa, as mensagens serão postadas em conversas diferentes. Para responder em uma conversa criada por uma pessoa ou outro app do Chat, especifique o campo |
ActionResponse
Parâmetros que um app do Chat pode usar para configurar como a resposta é postada.
| Representação JSON |
|---|
{ "type": enum ( |
| Campos | |
|---|---|
type |
Somente entrada. O tipo de resposta do app do Chat. |
url |
Somente entrada. URL para os usuários se autenticarem ou configurarem. (Somente para tipos de resposta |
dialogAction |
Somente entrada. Uma resposta a um evento de interação relacionado a uma caixa de diálogo. Precisa ser acompanhado por |
updatedWidget |
Somente entrada. A resposta do widget atualizado. |
ResponseType
O tipo de resposta do app do Chat.
| Tipos enumerados | |
|---|---|
TYPE_UNSPECIFIED |
Tipo padrão que é processado como NEW_MESSAGE. |
NEW_MESSAGE |
Postar como uma nova mensagem no tópico. |
UPDATE_MESSAGE |
Atualize a mensagem do app do Chat. Isso só é permitido em um evento CARD_CLICKED em que o tipo de remetente da mensagem é BOT. |
UPDATE_USER_MESSAGE_CARDS |
Atualizar os cards na mensagem de um usuário. Isso só é permitido como resposta a um evento MESSAGE com um URL correspondente ou a um evento CARD_CLICKED em que o tipo de remetente da mensagem é HUMAN. O texto é ignorado. |
REQUEST_CONFIG |
Peça ao usuário, de forma particular, mais autenticação ou configuração. |
DIALOG |
Apresenta uma caixa de diálogo. |
UPDATE_WIDGET |
Consulta de opções de preenchimento automático de texto do widget. |
DialogAction
Contém uma caixa de diálogo e um código de status da solicitação.
| Representação JSON |
|---|
{ "actionStatus": { object ( |
| Campos | |
|---|---|
actionStatus |
Somente entrada. Status de uma solicitação para invocar ou enviar uma caixa de diálogo. Mostra um status e uma mensagem aos usuários, se necessário. Por exemplo, em caso de erro ou sucesso. |
| Ação a ser realizada. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta: | |
dialog |
Somente entrada. Caixa de diálogo da solicitação. |
| Fim dos campos mutuamente exclusivos. | |
Dialog
Wrapper ao redor do corpo do card da caixa de diálogo.
| Representação JSON |
|---|
{
"body": {
object ( |
| Campos | |
|---|---|
body |
Somente entrada. Corpo da caixa de diálogo, que é renderizado em um modal. Os apps do Google Chat não são compatíveis com as seguintes entidades de card: |
ActionStatus
Representa o status de uma solicitação para invocar ou enviar uma caixa de diálogo.
| Representação JSON |
|---|
{
"statusCode": enum ( |
| Campos | |
|---|---|
statusCode |
O código de status. |
userFacingMessage |
A mensagem que será enviada aos usuários sobre o status da solicitação. Se não for definida, uma mensagem genérica com base no |
Código
Códigos de erros canônicos para APIs gRPC.
Às vezes, vários códigos de erros podem ser aplicados. Os serviços retornam o código do erro mais específico aplicável. Por exemplo, dê preferência a OUT_OF_RANGE em vez de FAILED_PRECONDITION, se ambos os códigos se aplicarem. Da mesma maneira, dê preferência a NOT_FOUND ou ALREADY_EXISTS em vez de FAILED_PRECONDITION.
| Tipos enumerados | |
|---|---|
OK |
Não é um erro. Retornado quando bem-sucedido. Mapeamento HTTP: 200 OK |
CANCELLED |
A operação foi cancelada, geralmente pelo chamador Mapeamento HTTP: 499 Solicitação fechada pelo cliente |
UNKNOWN |
Erro desconhecido. Por exemplo, esse erro pode ser retornado quando um valor Mapeamento HTTP: 500 Erro interno do servidor |
INVALID_ARGUMENT |
O cliente especificou um argumento inválido. Observe que isso é diferente de Mapeamento HTTP: 400 Solicitação inválida |
DEADLINE_EXCEEDED |
O prazo expirou antes do término da operação. Para operações que alteram o estado do sistema, este erro pode ser retornado mesmo que a operação tenha sido concluída com sucesso. Por exemplo, uma resposta bem-sucedida de um servidor pode ter atrasado tempo suficiente para que o prazo expirasse. Mapeamento HTTP: 504 Tempo limite do gateway |
NOT_FOUND |
Alguma entidade solicitada não foi encontrada. Por exemplo, arquivo ou diretório. Observação para desenvolvedores de servidor: se uma solicitação for negada para uma classe inteira de usuários, como a implementação gradual de recursos ou a lista de permissões não documentada de permissões, Mapeamento HTTP: 404 Não encontrado |
ALREADY_EXISTS |
A entidade que um cliente tentou criar já existe. Por exemplo, arquivo ou diretório. Mapeamento HTTP: 409 Conflito |
PERMISSION_DENIED |
O autor da chamada não tem permissão para executar a operação especificada. Mapeamento HTTP: 403 Proibido |
UNAUTHENTICATED |
A solicitação não tem credenciais válidas de autenticação para a operação. Mapeamento HTTP: 401 Não autorizado |
RESOURCE_EXHAUSTED |
Houve o esgotamento de algum recurso, como uma cota por usuário. Também é possível que todo sistema de arquivos esteja sem espaço. Mapeamento HTTP: 429 Há muitas solicitações |
FAILED_PRECONDITION |
A operação foi rejeitada porque o estado do sistema não é o necessário para a execução dela. Por exemplo, o diretório a ser excluído não está vazio, uma operação "rmdir" foi aplicada a um elemento que não é um diretório etc. Os implementadores de serviços podem usar as diretrizes a seguir para decidir entre Mapeamento HTTP: 400 Solicitação inválida |
ABORTED |
A operação foi cancelada. Isso ocorre normalmente devido a um problema de simultaneidade, como falha na verificação do sequenciador ou cancelamento da transação. Consulte as diretrizes acima para decidir entre Mapeamento HTTP: 409 Conflito |
OUT_OF_RANGE |
Houve uma tentativa da operação depois do intervalo válido. Por exemplo, busca ou leitura após o fim do arquivo. Diferentemente de Há alguma sobreposição entre Mapeamento HTTP: 400 Solicitação inválida |
UNIMPLEMENTED |
A operação não foi implementada ou não é compatível nem está ativada neste serviço. Mapeamento HTTP: 501 Não implementado |
INTERNAL |
Erros internos. Significa que algumas invariantes esperadas pelo sistema subjacente foram corrompidas. Este código do erro é reservado para erros graves. Mapeamento HTTP: 500 Erro interno do servidor |
UNAVAILABLE |
Atualmente, o serviço não está disponível. Muito provavelmente, trata-se de uma condição temporária, que pode ser corrigida ao tentar novamente com uma retirada. Nem sempre é seguro repetir operações não idempotentes. Consulte as diretrizes acima para decidir entre Mapeamento HTTP: 503 Serviço indisponível |
DATA_LOSS |
Perda ou corrupção irrecuperável de dados. Mapeamento HTTP: 500 Erro interno do servidor |
UpdatedWidget
Para widgets selectionInput, retorna sugestões de preenchimento automático para um menu de seleção múltipla.
| Representação JSON |
|---|
{
"widget": string,
// The following is a list of mutually exclusive fields. At most one of the
// fields will be set in a response:
"suggestions": {
object ( |
| Campos | |
|---|---|
widget |
O ID do widget atualizado. O ID precisa corresponder ao do widget que acionou a solicitação de atualização. |
| O widget foi atualizado em resposta a uma ação do usuário. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta: | |
suggestions |
Lista de resultados de preenchimento automático do widget |
| Fim dos campos mutuamente exclusivos. | |
SelectionItems
Lista de resultados de preenchimento automático do widget.
| Representação JSON |
|---|
{
"items": [
{
object ( |
| Campos | |
|---|---|
items[] |
Uma matriz de objetos SelectionItem. |
SlashCommand
Metadados sobre um comando de barra no Google Chat.
| Representação JSON |
|---|
{ "commandId": string } |
| Campos | |
|---|---|
commandId |
O ID do comando de barra. |
MatchedUrl
Um URL correspondente em uma mensagem de chat. Os apps do Chat podem mostrar uma prévia dos URLs correspondentes. Para mais informações, consulte Visualizar links.
| Representação JSON |
|---|
{ "url": string } |
| Campos | |
|---|---|
url |
Apenas saída. O URL que foi correspondido. |
EmojiReactionSummary
O número de pessoas que reagiram a uma mensagem com um emoji específico.
| Representação JSON |
|---|
{
"emoji": {
object ( |
| Campos | |
|---|---|
emoji |
Apenas saída. Emoji associado às reações. |
reactionCount |
Apenas saída. O número total de reações usando o emoji associado. |
DeletionMetadata
Informações sobre uma mensagem excluída. Uma mensagem é excluída quando deleteTime é definido.
| Representação JSON |
|---|
{
"deletionType": enum ( |
| Campos | |
|---|---|
deletionType |
Indica quem excluiu a mensagem. |
DeletionType
Quem excluiu a mensagem e como ela foi excluída. Mais valores podem ser adicionados no futuro. Consulte Editar ou excluir uma mensagem no Google Chat para saber quando as mensagens podem ser excluídas.
| Tipos enumerados | |
|---|---|
DELETION_TYPE_UNSPECIFIED |
Esse valor não é usado. |
CREATOR |
O usuário excluiu a própria mensagem. |
SPACE_OWNER |
Um proprietário ou administrador excluiu a mensagem. |
ADMIN |
Um administrador do Google Workspace excluiu a mensagem. Os administradores podem excluir qualquer mensagem no espaço, incluindo as enviadas por qualquer participante ou app do Chat. |
APP_MESSAGE_EXPIRY |
Um app do Chat excluiu a própria mensagem quando ela expirou. |
CREATOR_VIA_APP |
Um app do Chat excluiu a mensagem em nome do criador (usando a autenticação do usuário). |
SPACE_OWNER_VIA_APP |
Um app do Chat excluiu a mensagem em nome de um administrador do espaço (usando a autenticação do usuário). |
SPACE_MEMBER |
Um participante do espaço excluiu a mensagem. Os usuários podem excluir mensagens enviadas por apps. |
QuotedMessageMetadata
Informações sobre uma mensagem que outra mensagem cita.
Ao atualizar uma mensagem, não é possível adicionar ou substituir o campo quotedMessageMetadata, mas é possível removê-lo.
Para ver um exemplo de uso, consulte Citar outra mensagem.
| Representação JSON |
|---|
{ "name": string, "lastUpdateTime": string, "quoteType": enum ( |
| Campos | |
|---|---|
name |
Obrigatório. Nome do recurso da mensagem citada. Formato: |
lastUpdateTime |
Obrigatório. O carimbo de data/hora de quando a mensagem citada foi criada ou atualizada pela última vez. Se a mensagem foi editada, use este campo, Se |
quoteType |
Opcional. Especifica o tipo de citação. Se não for definido, o padrão será REPLY no caminho de leitura/gravação da mensagem para compatibilidade com versões anteriores. |
quotedMessageSnapshot |
Apenas saída. Um resumo do conteúdo da mensagem citada. |
forwardedMetadata |
Apenas saída. Metadados sobre o espaço de origem da mensagem citada. Preenchido apenas para o tipo de cotação FORWARD. |
QuoteType
O tipo de citação da mensagem citada.
| Tipos enumerados | |
|---|---|
QUOTE_TYPE_UNSPECIFIED |
Reservado. Esse valor não é usado. |
REPLY |
Quando
|
FORWARD |
Quando
|
QuotedMessageSnapshot
Mostra uma captura de tela do conteúdo da mensagem citada no momento da citação ou do encaminhamento.
| Representação JSON |
|---|
{ "sender": string, "text": string, "formattedText": string, "annotations": [ { object ( |
| Campos | |
|---|---|
sender |
Apenas saída. O nome do autor da mensagem citada. Preenchido para os tipos de citação REPLY e FORWARD. |
text |
Apenas saída. Captura de tela do conteúdo de texto da mensagem citada. |
formattedText |
Apenas saída. Contém a mensagem citada |
annotations[] |
Apenas saída. Anotações analisadas do corpo de texto da mensagem citada. Preenchido apenas para o tipo de cotação FORWARD. |
attachments[] |
Apenas saída. Anexos que faziam parte da mensagem citada. São cópias dos metadados do anexo da mensagem citada. Preenchido apenas para o tipo de cotação FORWARD. |
ForwardedMetadata
Metadados sobre o espaço de origem de onde uma mensagem foi encaminhada.
| Representação JSON |
|---|
{ "space": string, "spaceDisplayName": string } |
| Campos | |
|---|---|
space |
Apenas saída. O nome do recurso do espaço de origem. Formato: spaces/{space} |
spaceDisplayName |
Apenas saída. O nome de exibição do espaço ou da mensagem direta de origem no momento do encaminhamento. Para |
AttachedGif
Uma imagem GIF especificada por um URL.
| Representação JSON |
|---|
{ "uri": string } |
| Campos | |
|---|---|
uri |
Apenas saída. O URL que hospeda a imagem GIF. |
AccessoryWidget
Um ou mais widgets interativos que aparecem na parte de baixo de uma mensagem. Para mais detalhes, consulte Adicionar widgets interativos na parte de baixo de uma mensagem.
| Representação JSON |
|---|
{
// The following is a list of mutually exclusive fields. At most one of the
// fields will be set in a response:
"buttonList": {
object ( |
| Campos | |
|---|---|
| O tipo de ação. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta: | |
buttonList |
Uma lista de botões. |
| Fim dos campos mutuamente exclusivos. | |
Elementos
| Representação JSON |
|---|
{ "citedSources": [ { object ( |
| Campos | |
|---|---|
citedSources[] |
Uma lista de fontes que serão mostradas abaixo da mensagem como links de rodapé. Eles não são referenciados inline. Para referências inline, use |
citations[] |
Uma lista de citações inline referenciadas no texto da mensagem (com tags |
CitedSource
| Representação JSON |
|---|
{ "title": string, "uri": string, "snippet": { object ( |
| Campos | |
|---|---|
title |
Obrigatório. O título em texto simples do |
uri |
Obrigatório. O URI que aponta para o recurso referenciado por este |
snippet |
Opcional. Snippet com informações diretamente da fonte. |
footer |
Opcional. Informações adicionais para mostrar ao lado do snippet na forma de um rodapé. |
Snippet
| Representação JSON |
|---|
{
"text": string,
"imagePreview": {
object ( |
| Campos | |
|---|---|
text |
Opcional. Um trecho curto de texto simples diretamente do corpus que pode ser renderizado no Chat. Não é compatível com o formato Markdown. |
imagePreview |
Opcional. Prévia da imagem do snippet fornecido como entrada ao criar a citação. |
ElementsImage
| Representação JSON |
|---|
{ "imageUri": string } |
| Campos | |
|---|---|
| Obrigatório. Uma das representações de imagem compatíveis. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta: | |
imageUri |
Obrigatório. Um URI acessível publicamente para uma imagem. |
| Fim dos campos mutuamente exclusivos. | |
Citação
<chat-citation data-id="{id}">{text}</chat-citation>. As citações só são aceitas quando o markupSyntax da mensagem está definido como MARKDOWN.As citações não referenciadas em Elements.citations (aquelas sem uma tag <chat-citation> correspondente no texto da mensagem) são ignoradas e não fazem com que a mensagem seja rejeitada.
| Representação JSON |
|---|
{
"id": string,
"citedSources": [
{
object ( |
| Campos | |
|---|---|
id |
Obrigatório. ID definido pelo app. Precisa conter apenas letras e números ASCII e ter menos de 63 caracteres. |
citedSources[] |
Opcional. Uma lista de fontes relevantes para a citação. As fontes são mostradas no card de informações da citação. |
MarkupSyntax
Especifica a sintaxe de marcação usada para formatar o texto da mensagem de chat. Aplica-se ao campo text do recurso Message.
| Tipos enumerados | |
|---|---|
MARKUP_SYNTAX_UNSPECIFIED |
Representa o valor não especificado. |
MARKUP_SYNTAX_CHAT |
Usa a sintaxe de marcação do Google Chat. Consulte https://developers.google.com/workspace/chat/format-messages#format-texts para mais informações. |
MARKUP_SYNTAX_MARKDOWN |
Usa a sintaxe de Markdown. Essa sintaxe é baseada na especificação CommonMark, com extensões adicionais. Consulte https://developers.google.com/workspace/chat/format-messages#format-texts para mais informações. |
Métodos |
|
|---|---|
|
Cria uma mensagem em um espaço do Google Chat. |
|
Exclui uma mensagem. |
|
Retorna detalhes sobre uma mensagem. |
|
Lista as mensagens em um espaço em que o autor da chamada é um participante, incluindo mensagens de participantes e espaços bloqueados. |
|
Atualiza uma mensagem. |
|
Substitui os cards incluídos em uma mensagem. |
|
Pesquisa mensagens no Google Chat que o usuário que está fazendo a chamada pode acessar. |
|
Atualiza uma mensagem. |