REST Resource: spaces.messages

Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

Recurso: Message

Uma mensagem no Google Chat.

Representação JSON
{
  "name": string,
  "sender": {
    object (User)
  },
  "createTime": string,
  "lastUpdateTime": string,
  "deleteTime": string,
  "text": string,
  "cards": [
    {
      object (Card)
    }
  ],
  "cardsV2": [
    {
      object (CardWithId)
    }
  ],
  "annotations": [
    {
      object (Annotation)
    }
  ],
  "thread": {
    object (Thread)
  },
  "space": {
    object (Space)
  },
  "fallbackText": string,
  "actionResponse": {
    object (ActionResponse)
  },
  "argumentText": string,
  "slashCommand": {
    object (SlashCommand)
  },
  "attachment": [
    {
      object (Attachment)
    }
  ],
  "matchedUrl": {
    object (MatchedUrl)
  },
  "threadReply": boolean,
  "clientAssignedMessageId": string,
  "emojiReactionSummaries": [
    {
      object (EmojiReactionSummary)
    }
  ],
  "deletionMetadata": {
    object (DeletionMetadata)
  }
}
Campos
name

string

Nome do recurso no formato spaces/*/messages/*.

Exemplo: spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB

sender

object (User)

Apenas saída. O usuário que criou a mensagem.

createTime

string (Timestamp format)

Apenas saída. O horário em que a mensagem foi criada no servidor do Google Chat.

lastUpdateTime

string (Timestamp format)

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 estará vazio.

deleteTime

string (Timestamp format)

Apenas saída. A hora em que a mensagem foi excluída no servidor do Google Chat. Se a mensagem nunca for excluída, esse campo estará vazio.

text

string

Corpo de texto simples da mensagem. O primeiro link para uma imagem, um vídeo, uma página da Web ou outro item que pode ser visualizado gera um ícone de visualização.

cards[]
(deprecated)

object (Card)

Obsoleto: use cardsV2

Cards avançados, formatados e interativos que podem ser usados para exibir elementos da IU, como textos formatados, botões e imagens clicáveis. Os cards normalmente aparecem abaixo do corpo da mensagem em texto simples.

cardsV2[]

object (CardWithId)

Cards interativos e com formatação avançada que exibem elementos da IU e widgets editáveis, como:

  • Texto formatado
  • Botões
  • Imagens clicáveis
  • Caixas de seleção
  • Botões de opção
  • Widgets de entrada.

Os cards geralmente aparecem abaixo do corpo do texto de uma mensagem do Chat, mas podem aparecer em outras situações, como as caixas de diálogo.

O cardId é um identificador exclusivo entre os cards na mesma mensagem e para identificar os valores de entrada do usuário.

Os widgets compatíveis no momento incluem:

  • TextParagraph
  • DecoratedText
  • Image
  • ButtonList
  • Divider
annotations[]

object (Annotation)

Apenas saída. Anotações associadas ao texto na mensagem.

thread

object (Thread)

A conversa a que a mensagem pertence. Para ver um exemplo de uso, consulte Iniciar ou responder a uma conversa.

space

object (Space)

O espaço a que a mensagem pertence. Quando acessado com a autenticação do usuário, apenas o nome do espaço é preenchido.

fallbackText

string

Uma descrição de texto simples dos cartões da mensagem, usada quando os cartões reais não podem ser exibidos (por exemplo, notificações móveis).

actionResponse

object (ActionResponse)

Apenas entrada. Parâmetros que um app de chat pode usar para configurar como a resposta é postada.

argumentText

string

O corpo da mensagem em texto simples com todas as menções do app Chat removidas.

slashCommand

object (SlashCommand)

Apenas saída. Informações de comando de barra, se aplicável.

attachment[]

object (Attachment)

Anexo enviado pelo usuário.

matchedUrl

object (MatchedUrl)

Apenas saída. Um URL em spaces.messages.text que corresponde a um padrão de visualização de link. Para mais informações, consulte Links de visualização.

threadReply

boolean

Apenas saída. Quando true, a mensagem é uma resposta em uma linha de execução de resposta. Quando false, a mensagem é visível na conversa de nível superior do espaço como a primeira mensagem de uma conversa ou uma mensagem sem respostas agrupadas.

Se o espaço não oferecer suporte à resposta em conversas, este campo será sempre false.

clientAssignedMessageId

string

Um nome personalizado para uma mensagem do Chat atribuída na criação. Precisa começar com client- e conter apenas letras minúsculas, números e hifens com até 63 caracteres. Especifique esse campo para receber, atualizar ou excluir a mensagem com o valor especificado. Para ver um exemplo de uso, consulte Nomear uma mensagem criada.

emojiReactionSummaries[]

object (EmojiReactionSummary)

Apenas saída. A lista de resumos de reação com emoji na mensagem.

deletionMetadata

object (DeletionMetadata)

Apenas saída. Informações sobre uma mensagem excluída. Uma mensagem é excluída quando deleteTime é definido.

CardWithId

Widgets para apps de chat especificar.

Representação JSON
{
  "cardId": string,
  "card": {
    object (Card)
  }
}
Campos
cardId

string

Obrigatório para cardsV2 mensagens. Identificador do app de chat para esse widget. Com escopo em uma mensagem.

card

object (Card)

Os cards oferecem suporte a layouts definidos, elementos interativos da IU, como botões, e rich media, como imagens. Use esse card para apresentar informações detalhadas, coletar informações dos usuários e orientá-los a avançar.

Annotation

Anotações associadas ao corpo da mensagem de texto simples.

Exemplo de corpo de mensagem de 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 (AnnotationType),
  "startIndex": integer,
  "length": integer,

  // Union field metadata can be only one of the following:
  "userMention": {
    object (UserMentionMetadata)
  },
  "slashCommand": {
    object (SlashCommandMetadata)
  }
  // End of list of possible types for union field metadata.
}
Campos
type

enum (AnnotationType)

Tipo de anotação.

startIndex

integer

Índice inicial (base 0, inclusive) no corpo da mensagem de texto simples a que esta anotação corresponde.

length

integer

Tamanho da substring no corpo da mensagem de texto simples a que esta anotação corresponde.

Campo de união metadata. Metadados adicionais sobre a anotação. metadata pode ser apenas de um dos tipos a seguir:
userMention

object (UserMentionMetadata)

Os metadados da menção do usuário.

slashCommand

object (SlashCommandMetadata)

Os metadados de um comando de barra.

AnnotationType

Tipo da anotação.

Enums
ANNOTATION_TYPE_UNSPECIFIED Valor padrão da enumeração. NÃO USE.
USER_MENTION Um usuário é mencionado.
SLASH_COMMAND Um comando de barra é invocado.

Metadados de usuário

Metadados de anotação para menções do usuário (@).

Representação JSON
{
  "user": {
    object (User)
  },
  "type": enum (Type)
}
Campos
user

object (User)

O usuário mencionou.

type

enum (Type)

O tipo de menção ao usuário.

Tipo

Enums
TYPE_UNSPECIFIED Valor padrão da enumeração. NÃO USE.
ADD Adicionar usuário ao espaço
MENTION Mencione o usuário no espaço.

SlashCommandMetadata

Metadados de anotação para comandos de barra (/).

Representação JSON
{
  "bot": {
    object (User)
  },
  "type": enum (Type),
  "commandName": string,
  "commandId": string,
  "triggersDialog": boolean
}
Campos
bot

object (User)

O app de chat cujo comando foi invocado

type

enum (Type)

O tipo de comando de barra.

commandName

string

O nome do comando de barra invocado.

commandId

string (int64 format)

O ID do comando de barra invocado.

triggersDialog

boolean

Indica se o comando de barra é para uma caixa de diálogo.

Tipo

Enums
TYPE_UNSPECIFIED Valor padrão da enumeração. NÃO USE.
ADD Adicionar o app Chat ao espaço
INVOKE Invoque um comando de barra no espaço.

Conversa

Uma conversa no Google Chat

Representação JSON
{
  "name": string,
  "threadKey": string
}
Campos
name

string

Nome do recurso da linha de execução.

Exemplo: space/{space}/threads/{thread}

threadKey

string

Opcional. Identificador de linha de execução opaca. Para iniciar ou adicionar a uma linha de execução, crie uma mensagem e especifique um threadKey ou thread.name. Para ver um exemplo de uso, consulte Iniciar ou responder a uma conversa.

Para outras solicitações, é um campo somente de saída.

Ação de resposta

Parâmetros que um app de chat pode usar para configurar como a resposta é postada.

Representação JSON
{
  "type": enum (ResponseType),
  "url": string,
  "dialogAction": {
    object (DialogAction)
  }
}
Campos
type

enum (ResponseType)

Apenas entrada. O tipo de resposta do app de chat.

url

string

Apenas entrada. URL para autenticação ou configuração dos usuários. Somente para os tipos de resposta REQUEST_CONFIG.

dialogAction

object (DialogAction)

Apenas entrada. Uma resposta a um evento relacionado a uma caixa de diálogo. Precisa ser acompanhado por ResponseType.Dialog.

Tipo de resposta

O tipo de resposta do app de chat.

Enums
TYPE_UNSPECIFIED Tipo padrão. Será processado como NEW_MESSAGE.
NEW_MESSAGE Postar como uma nova mensagem no tema.
UPDATE_MESSAGE Atualize a mensagem do app 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 um evento CARD_CLICKED em que o tipo de remetente da mensagem é HUMANO. O texto será ignorado.
REQUEST_CONFIG Solicitar ao usuário autenticação ou configuração adicional de forma particular.
DIALOG Apresenta uma caixa de diálogo.

Ação de diálogo

Contém uma caixa de diálogo e um código de status da solicitação.

Representação JSON
{
  "actionStatus": {
    object (ActionStatus)
  },

  // Union field action can be only one of the following:
  "dialog": {
    object (Dialog)
  }
  // End of list of possible types for union field action.
}
Campos
actionStatus

object (ActionStatus)

Apenas entrada. Status de uma solicitação para invocar ou enviar uma caixa de diálogo. Mostra um status e uma mensagem para os usuários, se necessário. Por exemplo, em caso de erro ou sucesso.

Campo de união action.

action pode ser apenas de um dos tipos a seguir:

dialog

object (Dialog)

Apenas entrada. Dialog para a solicitação.

Dialog

Wrapper ao redor do corpo do card da caixa de diálogo.

Representação JSON
{
  "body": {
    object (Card)
  }
}
Campos
body

object (Card)

Apenas 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 cartão: DateTimePicker e OnChangeAction.

Status da ação

Representa o status de uma solicitação para invocar ou enviar uma caixa de diálogo.

Representação JSON
{
  "statusCode": enum (Code),
  "userFacingMessage": string
}
Campos
statusCode

enum (Code)

O código de status.

userFacingMessage

string

A mensagem para enviar aos usuários o status da solicitação. Se não for definido, uma mensagem genérica baseada no statusCode será enviada.

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.

Enums
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 Status recebido de outro espaço de endereço pertence a um espaço de erro desconhecido nesse espaço de endereço. Além disso, os erros gerados por APIs que não retornam informações de erro suficientes podem ser convertidos neste erro.

Mapeamento HTTP: 500 Erro interno do servidor

INVALID_ARGUMENT

O cliente especificou um argumento inválido. Observe que isso é diferente de FAILED_PRECONDITION. INVALID_ARGUMENT indica argumentos problemáticos, independentemente do estado do sistema. Por exemplo, um nome de arquivo incorreto.

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, NOT_FOUND poderá ser usado. Se uma solicitação for negada para alguns usuários de uma classe, como o controle de acesso baseado em usuário, PERMISSION_DENIED precisará ser usado.

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. PERMISSION_DENIED não pode ser usado para rejeições causadas pelo esgotamento de algum recurso. Em vez dele, use RESOURCE_EXHAUSTED para esses erros. PERMISSION_DENIED não poderá ser usado se o autor da chamada não for identificado. Em vez dele, use UNAUTHENTICATED para esses erros. Esse código do erro não indica que a solicitação seja válida nem que a entidade solicitada exista ou satisfaça outras condições prévias.

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 FAILED_PRECONDITION, ABORTED e UNAVAILABLE: (a) usar UNAVAILABLE se o cliente puder repetir apenas a chamada com falha. (b) Use ABORTED se o cliente tentar novamente em um nível superior. Por exemplo, quando um teste e um conjunto especificados pelo cliente falham, indica que o cliente precisa reiniciar uma sequência de leitura-modificação-gravação. (c) Use FAILED_PRECONDITION se o cliente não tentar novamente até que o estado do sistema seja explicitamente corrigido. Por exemplo, se um "rmdir" falhar porque o diretório não está vazio, FAILED_PRECONDITION vai ser retornado, porque o cliente não vai tentar novamente, a menos que os arquivos sejam excluídos do diretório.

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 FAILED_PRECONDITION, ABORTED e UNAVAILABLE.

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 INVALID_ARGUMENT, este erro indica um problema que poderá ser corrigido se o estado do sistema mudar. Por exemplo, um sistema de arquivos de 32 bits gerará INVALID_ARGUMENT se for solicitado a ler em um deslocamento fora do intervalo [0,2^32-1], mas gerará OUT_OF_RANGE se for solicitado a ler um deslocamento que ultrapasse o tamanho do arquivo atual.

Há uma pequena sobreposição entre FAILED_PRECONDITION e OUT_OF_RANGE. Recomendamos usar OUT_OF_RANGE (o erro mais específico) quando aplicável para que os autores da chamada que estejam iterando por meio de um espaço possam procurar facilmente um erro OUT_OF_RANGE a fim de detectar quando tiverem concluído.

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 FAILED_PRECONDITION, ABORTED e UNAVAILABLE.

Mapeamento HTTP: 503 Serviço indisponível

DATA_LOSS

Perda ou corrupção irrecuperável de dados.

Mapeamento HTTP: 500 Erro interno do servidor

Comando de barra

Um comando de barra no Google Chat.

Representação JSON
{
  "commandId": string
}
Campos
commandId

string (int64 format)

ID do comando de barra invocado.

URL correspondente

Um URL correspondente em uma mensagem do Chat. Os apps de chat podem visualizar os URLs correspondentes. Veja mais informações em Visualizar links.

Representação JSON
{
  "url": string
}
Campos
url

string

Apenas saída. O URL correspondente.

ResumodeEmojiReação

O número de pessoas que reagiram a uma mensagem com um emoji específico.

Representação JSON
{
  "emoji": {
    object (Emoji)
  },

  // Union field _reaction_count can be only one of the following:
  "reactionCount": integer
  // End of list of possible types for union field _reaction_count.
}
Campos
emoji

object (Emoji)

Emoji associado às reações.

Campo de união _reaction_count.

_reaction_count pode ser apenas de um dos tipos a seguir:

reactionCount

integer

O número total de reações usando o emoji associado.

MetadataMetadata

Informações sobre uma mensagem excluída. Uma mensagem é excluída quando deleteTime é definido.

Representação JSON
{
  "deletionType": enum (DeletionType)
}
Campos
deletionType

enum (DeletionType)

Indica quem excluiu a mensagem.

Tipo de exclusão

Quem excluiu a mensagem e como ela foi excluída.

Enums
DELETION_TYPE_UNSPECIFIED Esse valor não é usado.
CREATOR O usuário excluiu a própria mensagem.
SPACE_OWNER O proprietário do espaço excluiu a mensagem.
ADMIN Um administrador do Google Workspace excluiu a mensagem.
APP_MESSAGE_EXPIRY Um app de chat excluiu a própria mensagem quando ela expirou.
CREATOR_VIA_APP Um app de chat excluiu a mensagem em nome do usuário.
SPACE_OWNER_VIA_APP Um app de chat excluiu a mensagem em nome do proprietário do espaço.

Métodos

create

Cria uma mensagem.

delete

Exclui uma mensagem.

get

Retorna uma mensagem.

list

Lista as mensagens em um espaço de que o autor da chamada participa, incluindo as mensagens de participantes e espaços bloqueados.

update

Atualiza uma mensagem.