- Recurso: Mensagem
- Representação JSON
- Cartas
- CardHeader
- ImageStyle
- Seção
- WidgetMarkup
- TextParagraph
- Imagem
- OnClick
- FormAction
- ActionParameter
- OpenLink
- KeyValue
- Ícone
- Botão
- TextButton
- ImageButton
- CardAction
- CardWithId
- Cartas
- CardHeader
- ImageType
- Seção
- Widget
- TextParagraph
- Imagem
- OnClick
- Ação
- ActionParameter
- LoadIndicator
- Interação
- OpenLink
- OpenAs
- OnClose
- OverflowMenu
- OverflowMenuItem
- Ícone
- MaterialIcon
- DecoratedText
- Botão
- Cor
- Tipo
- SwitchControl
- ControlType
- ButtonList
- TextInput
- Tipo
- Sugestões
- SuggestionItem
- Validação
- InputType
- SelectionInput
- SelectionType
- SelectionItem
- PlatformDataSource
- CommonDataSource
- HostAppDataSourceMarkup
- ChatClientDataSourceMarkup
- SpaceDataSource
- DateTimePicker
- DateTimePickerType
- Divider
- Grade
- GridItem
- ImageComponent
- ImageCropStyle
- ImageCropType
- BorderStyle
- BorderType
- GridItemLayout
- Colunas
- Coluna
- HorizontalSizeStyle
- HorizontalAlignment
- VerticalAlignment
- Widgets
- ChipList
- Layout
- Ícone
- CollapseControl
- DividerStyle
- CardAction
- CardFixedFooter
- DisplayStyle
- Anotação
- AnnotationType
- UserMentionMetadata
- Tipo
- SlashCommandMetadata
- Tipo
- RichLinkMetadata
- RichLinkType
- DriveLinkData
- ChatSpaceLinkData
- Conversa
- ActionResponse
- ResponseType
- DialogAction
- Caixa de diálogo
- ActionStatus
- Código
- UpdatedWidget
- SelectionItems
- SlashCommand
- MatchedUrl
- EmojiReactionSummary
- DeletionMetadata
- DeletionType
- QuotedMessageMetadata
- AttachedGif
- AccessoryWidget
- Métodos
Recurso: mensagem
Uma mensagem em um espaço do Google Chat.
Representação JSON |
---|
{ "name": string, "sender": { object ( |
Campos | |
---|---|
name |
Nome do recurso da mensagem. Formato: Em que Se você definir um ID personalizado ao criar uma mensagem, poderá usá-lo para especificar a mensagem em uma solicitação. Basta substituir |
sender |
Apenas saída. O usuário que criou a mensagem. Se o app do Chat se autenticar como um usuário, a saída preencherá o usuário |
createTime |
Opcional. Imutável. Nos espaços criados no Chat, o horário em que a mensagem foi criada. Este campo é apenas para 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, este campo estará 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 |
Corpo da mensagem em texto simples. 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
Saiba mais em Ver a formatação do texto enviada em uma mensagem. |
cards[] |
Obsoleto: use Cards avançados, formatados e interativos que você pode usar para exibir 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[] |
Uma matriz de cards. Somente apps do Chat podem criar cards. Se o app do Chat se autenticar como um usuário, as mensagens não poderão conter cartões. Para saber como criar uma mensagem com cards, consulte Enviar uma mensagem. Elabore e visualize cards com o Criador de cartões. Abrir o Card Builder |
annotations[] |
Apenas saída. Anotações associadas ao |
thread |
A conversa a que a mensagem pertence. Para exemplos de uso, consulte Iniciar ou responder a uma conversa. |
space |
Se o app do Chat se autenticar como um usuário, a saída vai preencher o espaço |
fallbackText |
Uma descrição em texto simples dos cards da mensagem, usada quando os cards reais não podem ser exibidos, por exemplo, notificações em dispositivos móveis. |
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 com todas as menções a apps do 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 definido como Se o espaço não permitir a resposta em conversas, este campo será sempre |
clientAssignedMessageId |
Opcional. Um ID personalizado para a mensagem. Você pode usar esse campo para identificar ou receber, excluir ou atualizar uma mensagem. Para definir um ID personalizado, especifique o campo |
emojiReactionSummaries[] |
Apenas saída. A lista de resumos de reações com emojis na mensagem. |
privateMessageViewer |
Imutável. Entrada para criar uma mensagem. Caso contrário, apenas saída. O usuário que pode ver a mensagem. Quando definida, a mensagem é particular e só fica visível para o usuário especificado e para o app do Chat. Para incluir esse campo na solicitação, chame a API Chat usando a autenticação de apps e omita o seguinte: Confira mais detalhes em Enviar uma mensagem particular. |
deletionMetadata |
Apenas saída. Informações sobre uma mensagem excluída. Uma mensagem é excluída quando o |
quotedMessageMetadata |
Apenas saída. Informações sobre uma mensagem citada por um usuário do Google Chat em um espaço. Os usuários do Google Chat podem citar uma mensagem para responder. |
attachedGifs[] |
Apenas saída. Imagens GIF anexadas à mensagem. |
accessoryWidgets[] |
Um ou mais widgets interativos que aparecem na parte inferior de uma mensagem. Você pode adicionar widgets de acessório a mensagens que contenham texto, cards ou ambos. Indisponível para mensagens que contêm caixas de diálogo. Confira mais detalhes em Adicionar widgets interativos na parte de baixo de uma mensagem. Para criar uma mensagem com widgets de acessório, é preciso autenticar o app. |
CardWithId
Um card em uma mensagem do Google Chat.
Somente apps do Chat podem criar cards. Se o app do Chat se autenticar como um usuário, a mensagem não poderá conter cards.
Elabore e visualize cards com o Criador de cartões.
Abrir o Card BuilderRepresentação JSON |
---|
{
"cardId": string,
"card": {
object ( |
Campos | |
---|---|
cardId |
Obrigatório se a mensagem tiver vários cards. Identificador exclusivo de um cartão em uma mensagem. |
card |
Um cartão. O tamanho máximo é de 32 KB. |
Nota
Apenas saída. Anotações associadas ao corpo de texto simples da mensagem. Para adicionar uma formatação básica a uma mensagem de texto, consulte Formatar mensagens de texto.
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 da anotação. |
length |
Tamanho da substring no corpo da mensagem de texto simples a que essa anotação corresponde. |
startIndex |
Índice inicial (base 0, inclusive) no corpo da mensagem de texto simples a que essa 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 para um comando de barra. |
richLinkMetadata |
Os metadados para um link avançado. |
AnnotationType
Tipo da anotação.
Enums | |
---|---|
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çada. |
UserMentionMetadata
Metadados de anotação para menções a usuários (@).
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 do tipo enumerado. Não use. |
ADD |
Adicionar usuário ao espaço. |
MENTION |
Mencionar o 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 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 tipo enumerado. Não use. |
ADD |
Adicionar o app do Chat ao espaço. |
INVOKE |
Invocar o comando de barra no espaço. |
RichLinkMetadata
Um link avançado para um recurso.
Representação JSON |
---|
{ "uri": string, "richLinkType": enum ( |
Campos | |
---|---|
uri |
O URI do link. |
richLinkType |
O tipo de link avançado. |
Campo de união data . Dados do recurso vinculado. data pode ser apenas de um dos tipos a seguir: |
|
driveLinkData |
Dados de um link do Drive. |
chatSpaceLinkData |
Dados de um link do espaço do Chat. |
RichLinkType
O tipo de link avançado. Outros tipos podem ser adicionados no futuro.
Enums | |
---|---|
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 do espaço do Chat. Por exemplo, um ícone inteligente de espaço. |
DriveLinkData
Dados de links do Google Drive.
Representação JSON |
---|
{
"driveDataRef": {
object ( |
Campos | |
---|---|
driveDataRef |
Um DriveDataRef que faz referência a um arquivo do Google Drive. |
mimeType |
O tipo MIME do recurso vinculado do Google Drive. |
ChatSpaceLinkData
Dados de links do espaço 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 linha de execução do recurso de espaço do Chat vinculado. Formato: |
message |
A mensagem do recurso do espaço do Chat vinculado. Formato: |
Conversa
Uma conversa em um espaço do Google Chat. Para exemplos de uso, consulte Iniciar ou responder a uma conversa.
Se você especificar uma conversa ao criar uma mensagem, poderá definir o campo messageReplyOption
para determinar o que vai acontecer se nenhuma conversa correspondente for encontrada.
Representação JSON |
---|
{ "name": string, "threadKey": string } |
Campos | |
---|---|
name |
Nome do recurso da linha de execução. Exemplo: |
threadKey |
Opcional. Entrada para criar ou atualizar uma conversa. Caso contrário, somente saída. ID da linha de execução. Aceita até 4.000 caracteres. Esse ID é exclusivo do app do Chat que o define. Por exemplo, se vários apps de chat criarem uma mensagem usando a mesma chave de conversa, as mensagens serão postadas em conversas diferentes. Para responder a 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 autenticarem ou configurarem. Apenas para tipos de resposta |
dialogAction |
Somente entrada. Uma resposta a um evento de interação relacionado a uma caixa de diálogo. Precisa estar acompanhado de |
updatedWidget |
Somente entrada. A resposta do widget atualizado. |
ResponseType
O tipo de resposta do app do Chat.
Enums | |
---|---|
TYPE_UNSPECIFIED |
Tipo padrão processado como NEW_MESSAGE . |
NEW_MESSAGE |
Postar como uma nova mensagem no tema. |
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 |
Atualize 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 é HUMAN . O texto é ignorado. |
REQUEST_CONFIG |
Solicitar ao usuário autenticação ou configuração adicional. |
DIALOG |
Apresenta uma caixa de diálogo. |
UPDATE_WIDGET |
Consulta das 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. |
Campo de união action . Ação a ser realizada. action pode ser apenas de um dos tipos a seguir: |
|
dialog |
Somente entrada. Caixa de diálogo para a solicitação. |
Dialog
Wrapper em torno do corpo do cartão da caixa de diálogo.
Representação JSON |
---|
{
"body": {
object ( |
Campos | |
---|---|
body |
Somente entrada. Corpo da caixa de diálogo, 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 a ser enviada aos usuários sobre o status da solicitação. 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 |
UpdatedWidget
A resposta do widget atualizado. Usado para fornecer opções de preenchimento automático para um widget.
Representação JSON |
---|
{ "widget": string, // Union field |
Campos | |
---|---|
widget |
ID do widget atualizado. O ID precisa corresponder ao do widget que acionou a solicitação de atualização. |
Campo de união updated_widget . O widget é atualizado em resposta a uma ação do usuário. updated_widget pode ser apenas de um dos tipos a seguir: |
|
suggestions |
Lista de resultados de preenchimento automático do widget |
SelectionItems
Lista de resultados de preenchimento automático do widget.
Representação JSON |
---|
{
"items": [
{
object ( |
Campos | |
---|---|
items[] |
Uma matriz dos objetos SelectionItem. |
SlashCommand
Um comando de barra no Google Chat.
Representação JSON |
---|
{ "commandId": string } |
Campos | |
---|---|
commandId |
O ID do comando de barra invocado. |
MatchedUrl
Um URL correspondente em uma mensagem do Chat. Os apps de chat podem visualizar URLs correspondentes. Para mais informações, consulte Visualizar links.
Representação JSON |
---|
{ "url": string } |
Campos | |
---|---|
url |
Apenas saída. O URL correspondente. |
EmojiReactionSummary
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. |
reactionCount |
O número total de reações com o emoji associado. |
DeletionMetadata
Informações sobre uma mensagem excluída. Uma mensagem é excluída quando o 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.
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 do Chat excluiu a própria mensagem quando ela expirou. |
CREATOR_VIA_APP |
Um app do Chat excluiu a mensagem em nome do usuário. |
SPACE_OWNER_VIA_APP |
Um app do Chat excluiu a mensagem em nome do proprietário do espaço. |
QuotedMessageMetadata
Informações sobre uma mensagem citada.
Representação JSON |
---|
{ "name": string, "lastUpdateTime": string } |
Campos | |
---|---|
name |
Apenas saída. Nome do recurso da mensagem citada. Formato: |
lastUpdateTime |
Apenas saída. O carimbo de data/hora em que a mensagem citada foi criada ou atualizada pela última vez. |
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 inferior de uma mensagem. Confira mais detalhes em Adicionar widgets interativos na parte de baixo de uma mensagem.
Representação JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de união action . O tipo de ação. action pode ser apenas de um dos tipos a seguir: |
|
buttonList |
Uma lista de botões. |
Métodos |
|
---|---|
|
Cria uma mensagem em um espaço do Google Chat. |
|
Exclui uma mensagem. |
|
Retorna detalhes sobre uma mensagem. |
|
Lista as mensagens de um espaço de que o autor da chamada participa, inclusive as de participantes e espaços bloqueados. |
|
Atualiza uma mensagem. |
|
Atualiza uma mensagem. |