Package google.chat.v1

rpc CompleteImportSpace(CompleteImportSpaceRequest) returns (CompleteImportSpaceResponse)

Conclui o processo de importação do espaço especificado e o torna visível para os usuários.

Exige autenticação do usuário e delegação em todo o domínio com o escopo de autorização:

• https://www.googleapis.com/auth/chat.import

Para mais informações, consulte Autorizar apps do Google Chat a importar dados.

Escopos de autorização

Requer o seguinte escopo OAuth:

• https://www.googleapis.com/auth/chat.import

Para mais informações, consulte o guia de autorização.

rpc CreateCustomEmoji(CreateCustomEmojiRequest) returns (CustomEmoji)

Cria um emoji personalizado.

Os emojis personalizados só estão disponíveis para contas do Google Workspace, e o administrador precisa ativá-los para a organização. Para mais informações, consulte Saiba mais sobre os emojis personalizados no Google Chat e Gerenciar permissões de emojis personalizados.

Exige autenticação do usuário com o escopo de autorização:

• https://www.googleapis.com/auth/chat.customemojis

Escopos de autorização

Requer o seguinte escopo OAuth:

• https://www.googleapis.com/auth/chat.customemojis

Para mais informações, consulte o guia de autorização.

rpc CreateMembership(CreateMembershipRequest) returns (Membership)

Cria uma associação para o app de chat que faz a chamada, um usuário ou um grupo do Google. Não é possível criar assinaturas para outros apps de chat. Ao criar uma assinatura, se o membro especificado tiver a política de aceitação automática desativada, ele vai receber um convite e precisará aceitá-lo antes de entrar no espaço. Caso contrário, a criação de uma assinatura adiciona o membro diretamente ao espaço especificado.

Aceita os seguintes tipos de autenticação:

• Autenticação de app com aprovação do administrador e o escopo de autorização:

  • https://www.googleapis.com/auth/chat.app.memberships

• Autenticação de usuário com um dos seguintes escopos de autorização:

  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.app (para adicionar o app de chamada ao espaço)
  • https://www.googleapis.com/auth/chat.import (somente espaços do modo de importação)
  • A autenticação de usuário concede privilégios de administrador quando uma conta de administrador é autenticada, use_admin_access é true e o seguinte escopo de autorização é usado:
    • https://www.googleapis.com/auth/chat.admin.memberships

A autenticação de app não é compatível com os seguintes casos de uso:

• Convidar usuários externos à organização do Workspace proprietária do espaço.
• Adicionar um grupo do Google a um espaço.
• Adicionar um app do Chat a um espaço.

Para exemplos de uso, consulte:

• Convidar ou adicionar um usuário a um espaço.
• Convidar ou adicionar um grupo do Google a um espaço.
• Adicione o app do Chat a um espaço.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

• https://www.googleapis.com/auth/chat.app.memberships
• https://www.googleapis.com/auth/chat.admin.memberships
• https://www.googleapis.com/auth/chat.import
• https://www.googleapis.com/auth/chat.memberships
• https://www.googleapis.com/auth/chat.memberships.app

Para mais informações, consulte o guia de autorização.

rpc CreateMessage(CreateMessageRequest) returns (Message)

Cria uma mensagem em um espaço do Google Chat. Para ver um exemplo, consulte Enviar uma mensagem.

Aceita os seguintes tipos de autenticação:

• Autenticação do app com o escopo de autorização:
  • https://www.googleapis.com/auth/chat.bot
• Autenticação do usuário com um dos seguintes escopos de autorização:
  • https://www.googleapis.com/auth/chat.messages.create
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.import (somente espaços do modo de importação)

O Chat atribui o remetente da mensagem de maneira diferente, dependendo do tipo de autenticação usado na solicitação.

A imagem a seguir mostra como o Chat atribui uma mensagem quando você usa a autenticação do app. O Chat mostra o app do Chat como o remetente da mensagem. O conteúdo da mensagem pode ter texto (text), cards (cardsV2) e widgets acessórios (accessoryWidgets).

A imagem a seguir mostra como o Chat atribui uma mensagem quando você usa a autenticação do usuário. O Chat mostra o usuário como o remetente da mensagem e atribui o app do Chat à mensagem mostrando o nome dele. O conteúdo da mensagem só pode conter texto (text).

O tamanho máximo da mensagem, incluindo o conteúdo, é de 32.000 bytes.

Para solicitações de webhook, a resposta não contém a mensagem completa. A resposta preenche apenas os campos name e thread.name, além das informações que estavam na solicitação.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

• https://www.googleapis.com/auth/chat.bot
• https://www.googleapis.com/auth/chat.import
• https://www.googleapis.com/auth/chat.messages
• https://www.googleapis.com/auth/chat.messages.create

Para mais informações, consulte o guia de autorização.

rpc CreateReaction(CreateReactionRequest) returns (Reaction)

Cria uma reação e a adiciona a uma mensagem. Para ver um exemplo, consulte Adicionar uma reação a uma mensagem.

Requer autenticação do usuário com um dos seguintes escopos de autorização:

• https://www.googleapis.com/auth/chat.messages.reactions.create
• https://www.googleapis.com/auth/chat.messages.reactions
• https://www.googleapis.com/auth/chat.messages
• https://www.googleapis.com/auth/chat.import (somente espaços do modo de importação)

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

• https://www.googleapis.com/auth/chat.import
• https://www.googleapis.com/auth/chat.messages
• https://www.googleapis.com/auth/chat.messages.reactions
• https://www.googleapis.com/auth/chat.messages.reactions.create

Para mais informações, consulte o guia de autorização.

rpc CreateSpace(CreateSpaceRequest) returns (Space)

Cria um espaço. Pode ser usado para criar um espaço nomeado ou um chat em grupo no Import mode. Para ver um exemplo, consulte Criar um espaço.

Aceita os seguintes tipos de autenticação:

• Autenticação de app com aprovação do administrador e um dos seguintes escopos de autorização:

  • https://www.googleapis.com/auth/chat.app.spaces.create
  • https://www.googleapis.com/auth/chat.app.spaces

• Autenticação de usuário com um dos seguintes escopos de autorização:

  • https://www.googleapis.com/auth/chat.spaces.create
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.import (somente espaços do modo de importação)

Ao autenticar como um app, o campo space.customer precisa ser definido na solicitação.

Ao autenticar como um app, o app do Chat é adicionado como participante do espaço. No entanto, ao contrário da autenticação humana, o app do Chat não é adicionado como administrador do espaço. Por padrão, todos os participantes podem remover o app Chat do espaço. Para permitir que apenas administradores do espaço removam o app, defina space.permission_settings.manage_apps como managers_allowed.

A assinatura do espaço no momento da criação depende de onde ele foi criado: Import mode:

• Modo de importação:nenhum participante é criado.
• Todos os outros modos:o usuário que faz a chamada é adicionado como participante. Isso é:
  • O próprio app ao usar a autenticação de app.
  • O usuário humano ao usar a autenticação de usuário.

Se você receber a mensagem de erro ALREADY_EXISTS ao criar um espaço, tente usar outro displayName. Um espaço na organização do Google Workspace já pode usar esse nome de exibição.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

• https://www.googleapis.com/auth/chat.app.spaces.create
• https://www.googleapis.com/auth/chat.app.spaces
• https://www.googleapis.com/auth/chat.import
• https://www.googleapis.com/auth/chat.spaces
• https://www.googleapis.com/auth/chat.spaces.create

Para mais informações, consulte o guia de autorização.

rpc DeleteCustomEmoji(DeleteCustomEmojiRequest) returns (Empty)

Exclui um emoji personalizado. Por padrão, os usuários só podem excluir os emojis personalizados que criaram. Os gerenciadores de emojis atribuídos pelo administrador podem excluir qualquer emoji personalizado na organização. Consulte Saiba mais sobre os emojis personalizados no Google Chat.

Os emojis personalizados só estão disponíveis para contas do Google Workspace, e o administrador precisa ativá-los para a organização. Para mais informações, consulte Saiba mais sobre os emojis personalizados no Google Chat e Gerenciar permissões de emojis personalizados.

Exige autenticação do usuário com o escopo de autorização:

• https://www.googleapis.com/auth/chat.customemojis

Escopos de autorização

Requer o seguinte escopo OAuth:

• https://www.googleapis.com/auth/chat.customemojis

Para mais informações, consulte o guia de autorização.

rpc DeleteMembership(DeleteMembershipRequest) returns (Membership)

Exclui uma assinatura. Por exemplo, consulte Remover um usuário ou um app do Google Chat de um espaço.

Aceita os seguintes tipos de autenticação:

• Autenticação de app com aprovação do administrador e o escopo de autorização:

  • https://www.googleapis.com/auth/chat.app.memberships

• Autenticação de usuário com um dos seguintes escopos de autorização:

  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.app (para remover o app de chamadas do espaço)
  • https://www.googleapis.com/auth/chat.import (somente espaços do modo de importação)
  • A autenticação de usuário concede privilégios de administrador quando uma conta de administrador é autenticada, use_admin_access é true e o seguinte escopo de autorização é usado:
    • https://www.googleapis.com/auth/chat.admin.memberships

A autenticação de app não é compatível com os seguintes casos de uso:

• Remover um grupo do Google de um espaço.
• Remover um app do Chat de um espaço.

Para excluir assinaturas de administradores do espaço, o solicitante precisa ser um administrador do espaço. Se você estiver usando a autenticação de app, o app Chat precisa ser o criador do espaço.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

• https://www.googleapis.com/auth/chat.app.memberships
• https://www.googleapis.com/auth/chat.admin.memberships
• https://www.googleapis.com/auth/chat.import
• https://www.googleapis.com/auth/chat.memberships
• https://www.googleapis.com/auth/chat.memberships.app

Para mais informações, consulte o guia de autorização.

rpc DeleteMessage(DeleteMessageRequest) returns (Empty)

Exclui uma mensagem. Para ver um exemplo, consulte Excluir uma mensagem.

Aceita os seguintes tipos de autenticação:

• Autenticação do app com o escopo de autorização:

  • https://www.googleapis.com/auth/chat.bot

• Autenticação de usuário com um dos seguintes escopos de autorização:

  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.import (somente espaços do modo de importação)

Ao usar a autenticação de app, as solicitações só podem excluir mensagens criadas pelo app de chat que fez a chamada.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

• https://www.googleapis.com/auth/chat.bot
• https://www.googleapis.com/auth/chat.import
• https://www.googleapis.com/auth/chat.messages

Para mais informações, consulte o guia de autorização.

rpc DeleteReaction(DeleteReactionRequest) returns (Empty)

Exclui uma reação a uma mensagem. Para ver um exemplo, consulte Excluir uma reação.

Requer autenticação do usuário com um dos seguintes escopos de autorização:

• https://www.googleapis.com/auth/chat.messages.reactions
• https://www.googleapis.com/auth/chat.messages
• https://www.googleapis.com/auth/chat.import (somente espaços do modo de importação)

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

• https://www.googleapis.com/auth/chat.import
• https://www.googleapis.com/auth/chat.messages
• https://www.googleapis.com/auth/chat.messages.reactions

Para mais informações, consulte o guia de autorização.

rpc DeleteSpace(DeleteSpaceRequest) returns (Empty)

Exclui um espaço nomeado. Sempre realiza uma exclusão em cascata, o que significa que os recursos filhos do espaço, como mensagens postadas e participações, também são excluídos. Para conferir um exemplo, consulte Excluir um espaço.

Aceita os seguintes tipos de autenticação:

• Autenticação de app com aprovação do administrador e o escopo de autorização:

  • https://www.googleapis.com/auth/chat.app.delete (apenas nos espaços criados pelo app)

• Autenticação de usuário com um dos seguintes escopos de autorização:

  • https://www.googleapis.com/auth/chat.delete
  • https://www.googleapis.com/auth/chat.import (somente espaços do modo de importação)
  • A autenticação de usuário concede privilégios de administrador quando uma conta de administrador é autenticada, use_admin_access é true e o seguinte escopo de autorização é usado:
    • https://www.googleapis.com/auth/chat.admin.delete

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

• https://www.googleapis.com/auth/chat.app.delete
• https://www.googleapis.com/auth/chat.admin.delete
• https://www.googleapis.com/auth/chat.import
• https://www.googleapis.com/auth/chat.delete

Para mais informações, consulte o guia de autorização.

rpc FindDirectMessage(FindDirectMessageRequest) returns (Space)

Retorna a mensagem direta com o usuário especificado. Se nenhum espaço de mensagem direta for encontrado, vai retornar um erro 404 NOT_FOUND. Para ver um exemplo, consulte Encontrar uma mensagem direta.

Com a autenticação de app, retorna o espaço de mensagem direta entre o usuário especificado e o app do Chat que faz a chamada.

Com a autenticação do usuário, retorna o espaço de mensagem direta entre o usuário especificado e o usuário autenticado.

Aceita os seguintes tipos de autenticação: