- Recurso: mensagem
- Representação JSON
- Cartão
- 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
- 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 (link em inglês)
- 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
- Thread
- 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 |
Identificador. Nome do recurso da mensagem. Formato: Em que Se você definir um ID personalizado ao criar uma mensagem, poderá usar esse ID 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 se autenticar como um usuário, a saída preencherá o usuário |
create |
Opcional. Imutável. Nos espaços criados no Chat, o horário em que a mensagem foi criada. Esse 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. |
last |
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. |
delete |
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 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. |
formatted |
Apenas saída. Contém a mensagem
Para mais informações, consulte Conferir a formatação de texto enviada em uma mensagem. |
cards[] |
Descontinuado: 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 do texto simples da mensagem. |
cards |
Opcional. Uma matriz de cards. Somente os apps de chat podem criar cards. Se o app de chat se autenticar como um usuário, as mensagens não poderão conter cards. Para saber como criar uma mensagem com cards, consulte Enviar uma mensagem. Crie e visualize cards com o Criador de cards. Abrir o Card Builder |
annotations[] |
Apenas saída. Anotações associadas ao |
thread |
A conversa a que a mensagem pertence. Para conferir um exemplo de uso, consulte Iniciar ou responder a uma conversa. |
space |
Apenas saída. Se o app de chat se autenticar como um usuário, a saída vai preencher apenas o espaço |
fallback |
Opcional. 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. |
action |
Somente entrada. Parâmetros que um app do Chat pode usar para configurar como a resposta é postada. |
argument |
Apenas saída. Corpo de texto simples da mensagem sem nenhuma menção do app Chat. |
slash |
Apenas saída. Informações sobre o comando de barra, se aplicável. |
attachment[] |
Opcional. Anexo enviado pelo usuário. |
matched |
Apenas saída. Um URL em |
thread |
Apenas saída. Quando Se o espaço não oferecer suporte a respostas em conversas, esse campo será sempre |
client |
Opcional. Opcional. Um ID personalizado para a mensagem. É possível usar o campo para identificar, receber, excluir ou atualizar uma mensagem. Para definir um ID personalizado, especifique o campo |
emoji |
Apenas saída. A lista de resumos das reações com emojis na mensagem. |
private |
Opcional. Imutável. Entrada para criar uma mensagem, caso contrário, apenas saída. O usuário que pode acessar a mensagem. Quando definido, a mensagem é privada e só fica visível para o usuário especificado e para o app 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. |
deletion |
Apenas saída. Informações sobre uma mensagem excluída. Uma mensagem é excluída quando |
quoted |
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. |
attached |
Apenas saída. Imagens GIF anexadas à mensagem. |
accessory |
Opcional. Um ou mais widgets interativos que aparecem na parte de baixo de uma mensagem. Você pode adicionar widgets de acessório a mensagens que contenham texto, cards ou ambos. Não é compatível com mensagens que contêm caixas de diálogo. Confira mais detalhes em Adicionar widgets interativos na parte de baixo de uma mensagem. A criação de uma mensagem com widgets acessórios requer a autenticação do 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.
Crie e visualize cards com o Criador de cards.
Abrir o criador de cardsRepresentação JSON |
---|
{
"cardId": string,
"card": {
object ( |
Campos | |
---|---|
card |
Obrigatório se a mensagem tiver vários cards. Um 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 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. |
start |
Índice inicial (com base em 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: |
|
user |
Os metadados da menção do usuário. |
slash |
Os metadados para um comando de barra. |
rich |
Os metadados de 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çado. |
UserMentionMetadata
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 menção de usuário. |
Tipo
Enums | |
---|---|
TYPE_UNSPECIFIED |
Valor padrão do tipo enumerado. Não use. |
ADD |
Adicione o 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. |
command |
O nome do comando de barra invocado. |
command |
O ID do comando de barra invocado. |
triggers |
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 desse link. |
rich |
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: |
|
drive |
Dados de um link do Drive. |
chat |
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 para links do Google Drive.
Representação JSON |
---|
{
"driveDataRef": {
object ( |
Campos | |
---|---|
drive |
Uma DriveDataRef que faz referência a um arquivo do Google Drive. |
mime |
O tipo MIME do recurso do Google Drive vinculado. |
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 do espaço do Chat vinculado. Formato: |
thread |
A linha do recurso do 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 conferir um exemplo 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 |
Identificador. Nome do recurso da linha de execução. Exemplo: |
thread |
Opcional. Entrada para criar ou atualizar uma linha de execução. 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 de chat, especifique o campo |
ActionResponse
Parâmetros que um app de 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 autenticação ou configuração dos usuários. (Somente para tipos de resposta |
dialog |
Somente entrada. Uma resposta a um evento de interação relacionado a uma caixa de diálogo. Precisa ser acompanhado por |
updated |
Somente entrada. A resposta do widget atualizado. |
ResponseType
O tipo de resposta do app Chat.
Enums | |
---|---|
TYPE_UNSPECIFIED |
Tipo padrão processado como NEW_MESSAGE . |
NEW_MESSAGE |
Publique 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 |
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 |
Peça ao usuário para fazer uma autenticação ou configuração extra. |
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 o código de status da solicitação.
Representação JSON |
---|
{ "actionStatus": { object ( |
Campos | |
---|---|
action |
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. Dialog 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 | |
---|---|
status |
O código de status. |
user |
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 | |
---|---|
command |
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 saber mais, consulte Visualizar links.
Representação JSON |
---|
{ "url": string } |
Campos | |
---|---|
url |
Apenas saída. O URL que foi encontrado. |
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. |
reaction |
Apenas saída. O número total de reações com o emoji associado. |
DeletionMetadata
Informações sobre uma mensagem excluída. Uma mensagem é excluída quando deleteTime
é definida.
Representação JSON |
---|
{
"deletionType": enum ( |
Campos | |
---|---|
deletion |
Indica quem excluiu a mensagem. |
DeletionType
Quem excluiu a mensagem e como ela foi excluída. Outros valores podem ser adicionados no futuro.
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 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: |
last |
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: |
|
button |
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. |