- Recurso: message
- Card
- CardHeader
- ImageStyle (em inglês)
- Seção
- WidgetMarkup
- TextParagraph
- Imagem
- OnClick
- FormAction
- ActionParameter
- OpenLink
- Valor-chave
- Ícone
- Botão
- Botão de texto
- ImageButton
- CardAction
- CardWithId
- Card
- CardHeader
- ImageType (link em inglês)
- Seção
- Widget
- TextParagraph
- Imagem
- OnClick
- Ação
- ActionParameter
- LoadIndicator
- Interação
- OpenLink
- Abrir como
- OnClose (em inglês)
- DecoratedText
- Ícone
- Botão
- Cor
- SwitchControl
- Tipo de controle
- Listadebotões
- TextInput
- Tipo
- Sugestões
- SuggestionItem
- SelectionInput
- Tipo de seleção
- SelectionItem
- DateTimePicker
- DateTimePickerType.
- Divider
- Grade
- GridItem
- ImageComponent
- ImageCropStyle
- ImageCropType (em inglês)
- BorderStyle
- BorderType (em inglês)
- GridItemLayout (link em inglês)
- Colunas
- Coluna
- HorizontalSizeStyle (em inglês)
- HorizontalAlignment
- VerticalAlignment
- Widgets
- CardAction
- CardFixedFooter
- FooterWidget
- DisplayStyle
- Anotação
- AnnotationType
- UserReferenceMetadata
- Tipo
- SlashCommandMetadata
- Tipo
- Conversa
- ActionResponse
- ResponseType (link em inglês)
- DialogAction
- Caixa de diálogo
- ActionStatus
- Code
- SlashCommand
- MatchedUrl
- EmojiReactionSummary
- DeletionMetadata
- DeletionType
- Métodos
Recurso: message
Uma mensagem no Google Chat.
Representação JSON |
---|
{ "name": string, "sender": { object ( |
Campos | |
---|---|
name |
Nome do recurso no formato Exemplo: |
sender |
Apenas saída. O usuário que criou a mensagem. Se o app Chat for autenticado como usuário, a saída vai preencher o usuário |
createTime |
Apenas saída. A hora em que a mensagem foi criada no Google Chat. |
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 estará vazio. |
deleteTime |
Apenas saída. A hora em que a mensagem foi excluída no Google Chat. Se a mensagem nunca for excluída, esse campo estará vazio. |
text |
Corpo de texto simples da mensagem. O primeiro link para uma imagem, vídeo, página da Web ou outro item que pode ser visualizado gera um ícone de visualização. |
cards[] |
Obsoleto: use Cards ricos, formatados e interativos que você pode usar para exibir elementos da IU, como textos formatados, botões e imagens clicáveis. Os cartões normalmente são exibidos abaixo do corpo de texto simples da mensagem. |
cardsV2[] |
Cards interativos e bem formatados que exibem elementos de IU e widgets editáveis, como:
Os cards costumam aparecer abaixo do corpo de uma mensagem do Chat, mas podem aparecer em outras situações, como caixas de diálogo. Cada cartão pode ter um tamanho máximo de 32 KB. O Os widgets compatíveis no momento incluem:
|
annotations[] |
Apenas saída. Anotações associadas ao |
thread |
A sequência à qual a mensagem pertence. Para ver um exemplo de uso, consulte Iniciar ou responder a uma conversa. |
space |
Se o app Chat tiver a autenticação como usuário, a saída preencherá o espaço |
fallbackText |
Uma descrição em texto simples dos cartões da mensagem, usada quando os cartões não podem ser exibidos. Por exemplo, notificações para dispositivos móveis. |
actionResponse |
Apenas entrada. Parâmetros que um app de chat pode usar para configurar como a resposta é postada. |
argumentText |
Apenas saída. Corpo em texto simples da mensagem com todas as menções do app Chat removidas. |
slashCommand |
Apenas saída. Informações do comando de barra, se aplicável. |
attachment[] |
Anexo enviado pelo usuário. |
matchedUrl |
Apenas saída. Um URL em |
threadReply |
Apenas saída. Quando Se o espaço não for compatível com a resposta em conversas, este campo será sempre |
clientAssignedMessageId |
Um nome personalizado para uma mensagem do Chat atribuída na criação. Precisa começar com |
emojiReactionSummaries[] |
Apenas saída. A lista de resumos de reação com emoji na mensagem. |
deletionMetadata |
Apenas saída. Informações sobre uma mensagem excluída. Uma mensagem é excluída quando |
ID do cartão
Widgets para apps de chat especificar.
Representação JSON |
---|
{
"cardId": string,
"card": {
object ( |
Campos | |
---|---|
cardId |
Obrigatório para |
card |
Os cards são compatíveis com um layout definido, elementos interativos de IU, como botões, e rich media, como imagens. Use este cartão para apresentar informações detalhadas, coletar informações dos usuários e orientá-los a dar o próximo passo. |
Nota
Anotações associadas ao corpo da mensagem em 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 ( |
Campos | |
---|---|
type |
O tipo dessa anotação. |
length |
Comprimento da substring no corpo da mensagem de texto simples a que esta anotação corresponde. |
startIndex |
Índice inicial (base 0, inclusive) no corpo da mensagem em 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 |
Os metadados da menção do usuário. |
slashCommand |
Os metadados de um comando de barra. |
AnnotationType
Tipo da anotação.
Enums | |
---|---|
ANNOTATION_TYPE_UNSPECIFIED |
Valor padrão do enum. Não use. |
USER_MENTION |
Um usuário é mencionado. |
SLASH_COMMAND |
Um comando de barra é invocado. |
Metadados de referência do usuário
Metadados de anotação para menções de usuários (@).
Representação JSON |
---|
{ "user": { object ( |
Campos | |
---|---|
user |
O usuário mencionou. |
type |
O tipo de referência do usuário. |
Tipo
Enums | |
---|---|
TYPE_UNSPECIFIED |
Valor padrão do enum. 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 ( |
Campos | |
---|---|
bot |
O app Chat cujo comando foi 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
Enums | |
---|---|
TYPE_UNSPECIFIED |
Valor padrão do enum. Não use. |
ADD |
Adicione o app Chat ao espaço. |
INVOKE |
Invoque o comando de barra no espaço. |
Conversa
Uma conversa no Google Chat.
Representação JSON |
---|
{ "name": string, "threadKey": string } |
Campos | |
---|---|
name |
Nome do recurso da linha de execução. Exemplo: |
threadKey |
Opcional. Identificador de thread opaco. Para iniciar ou adicionar a uma linha de execução, crie uma mensagem e especifique um Para outras solicitações, esse é um campo somente de saída. |
Resposta de ação
Parâmetros que um app de chat pode usar para configurar como a resposta é postada.
Representação JSON |
---|
{ "type": enum ( |
Campos | |
---|---|
type |
Apenas entrada. É o tipo de resposta do app Chat. |
url |
Apenas entrada. URL para os usuários se autenticarem ou configurarem. Apenas para os tipos de resposta |
dialogAction |
Apenas entrada. Uma resposta a um evento relacionado a uma caixa de diálogo. Precisa estar acompanhado por |
Tipo de resposta
É o tipo de resposta do app Chat.
Enums | |
---|---|
TYPE_UNSPECIFIED |
Tipo padrão que é tratado como NEW_MESSAGE . |
NEW_MESSAGE |
Postar como uma nova mensagem no tópico. |
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 |
Atualize os cards na mensagem de um usuário. Isso só é permitido como uma resposta a um evento MESSAGE com um URL correspondente ou um evento CARD_CLICKED em que o tipo de remetente da mensagem é HUMAN . O texto é ignorado. |
REQUEST_CONFIG |
Solicite ao usuário autenticação ou configuração adicional. |
DIALOG |
Apresenta uma caixa de diálogo. |
DialogAction
Contém uma caixa de diálogo e um código de status da solicitação.
Representação JSON |
---|
{ "actionStatus": { object ( |
Campos | |
---|---|
actionStatus |
Apenas entrada. Status de uma solicitação para invocar ou enviar uma caixa de diálogo. Exibe um status e uma mensagem aos usuários, se necessário. Por exemplo, em caso de erro ou sucesso. |
Campo de união
|
|
dialog |
Apenas entrada. Dialog para a solicitação. |
Caixa de diálogo
Wrapper no corpo do cartão da caixa de diálogo.
Representação JSON |
---|
{
"body": {
object ( |
Campos | |
---|---|
body |
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: |
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 ( |
Campos | |
---|---|
statusCode |
O código de status. |
userFacingMessage |
A mensagem a ser enviada aos usuários sobre o status da solicitação deles. Se não for definido, 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
.
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 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 |
SlashCommand
Um comando de barra no Google Chat.
Representação JSON |
---|
{ "commandId": string } |
Campos | |
---|---|
commandId |
O 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. Saiba mais em Visualizar links.
Representação JSON |
---|
{ "url": string } |
Campos | |
---|---|
url |
Apenas saída. O URL correspondente. |
ResumodeEmojis
O número de pessoas que reagiram a uma mensagem com um emoji específico.
Representação JSON |
---|
{
"emoji": {
object ( |
Campos | |
---|---|
emoji |
Emojis associados às reações. |
reactionCount |
O número total de reações usando os emojis associados. |
Metadados de exclusão
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. |
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 expirou. |
CREATOR_VIA_APP |
Um app de chat excluiu a mensagem em nome do usuário. |
SPACE_OWNER_VIA_APP |
Um app Chat excluiu a mensagem em nome do proprietário do espaço. |
Métodos |
|
---|---|
|
Cria uma mensagem. |
|
Exclui uma mensagem. |
|
Retorna detalhes sobre uma mensagem. |
|
Lista as mensagens em um espaço de que o autor da chamada é participante, inclusive as mensagens de participantes e espaços bloqueados. |
|
Atualiza uma mensagem. |
|
Atualiza uma mensagem. |