- Recurso: mensagem
- 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;
- 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
- ControlType (em inglês)
- Lista de botões
- TextInput
- Tipo
- Sugestões
- SuggestionItem
- SelectionInput
- SelectionType (em inglês)
- SelectionItem
- DateTimePicker.
- DateTimePickerType.
- Divider
- Grade
- GridItem
- ImageComponent
- ImageCropStyle
- ImageCropType (link em inglês)
- BorderStyle
- BorderType (link em inglês)
- GridItemLayout (link em inglês)
- CardAction
- CardFixedfooter
- Estilo de exibição
- Anotação
- AnnotationType (em inglês)
- UserReferenceMetadata
- Tipo
- SlashCommandMetadata
- Tipo
- Conversa
- ActionResponse
- Tipo de resposta
- DialogAction
- Caixa de diálogo
- Status da ação
- Code
- SlashCommand
- MatchUrl
- 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. |
createTime |
Apenas saída. O horário em que a mensagem foi criada no servidor do 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 servidor do 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, um vídeo, uma página da Web ou outro item que pode ser visualizado gera um ícone de visualização. |
cards[] |
Obsoleto: use 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[] |
Cards interativos e com formatação avançada que exibem elementos da IU e widgets editáveis, como:
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 Os widgets compatíveis no momento incluem:
|
annotations[] |
Apenas saída. Anotações associadas ao texto na mensagem. |
thread |
A conversa a que a mensagem pertence. Para ver um exemplo de uso, consulte Iniciar ou responder a uma conversa. |
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 |
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 |
Apenas entrada. Parâmetros que um app de chat pode usar para configurar como a resposta é postada. |
argumentText |
O corpo da mensagem em texto simples com todas as menções do app Chat removidas. |
slashCommand |
Apenas saída. Informações de 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 oferecer suporte à 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 |
CardWithId
Widgets para apps de chat especificar.
Representação JSON |
---|
{
"cardId": string,
"card": {
object ( |
Campos | |
---|---|
cardId |
Obrigatório para |
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 ( |
Campos | |
---|---|
type |
Tipo de anotação. |
startIndex |
Índice inicial (base 0, inclusive) no corpo da mensagem de texto simples a que esta anotação corresponde. |
length |
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 |
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 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 ( |
Campos | |
---|---|
user |
O usuário mencionou. |
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 ( |
Campos | |
---|---|
bot |
O app de 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 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 |
Nome do recurso da linha de execução. Exemplo: space/{space}/threads/{thread} |
threadKey |
Opcional. Identificador de linha de execução opaca. Para iniciar ou adicionar a uma linha de execução, crie uma mensagem e especifique um 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 ( |
Campos | |
---|---|
type |
Apenas entrada. O tipo de resposta do app de chat. |
url |
Apenas entrada. URL para autenticação ou configuração dos usuários. Somente para os tipos de resposta REQUEST_CONFIG. |
dialogAction |
Apenas entrada. Uma resposta a um evento relacionado a uma caixa de diálogo. Precisa ser acompanhado por |
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 ( |
Campos | |
---|---|
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
|
|
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 ( |
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 para enviar aos usuários o status da solicitação. Se não for definido, uma mensagem genérica baseada 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á uma pequena 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 |
Comando de barra
Um comando de barra no Google Chat.
Representação JSON |
---|
{ "commandId": string } |
Campos | |
---|---|
commandId |
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 |
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 ( |
Campos | |
---|---|
emoji |
Emoji associado às reações. |
Campo de união
|
|
reactionCount |
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 ( |
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 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 |
|
---|---|
|
Cria uma mensagem. |
|
Exclui uma mensagem. |
|
Retorna uma mensagem. |
|
Lista as mensagens em um espaço de que o autor da chamada participa, incluindo as mensagens de participantes e espaços bloqueados. |
|
Atualiza uma mensagem. |