Este guia explica como usar o método
setUp()
no recurso Space
da API Google Chat para configurar um espaço
do Google Chat. A configuração de um espaço cria um espaço e adiciona os usuários especificados a ele.
O
recurso Space
representa um lugar onde as pessoas e os apps do Chat podem enviar mensagens,
compartilhar arquivos e colaborar. Há vários tipos de espaços:
- As mensagens diretas (DMs) são conversas entre dois usuários ou um usuário e um app do Chat.
- As conversas em grupo são conversas entre três ou mais usuários e apps de chat.
- Os espaços nomeados são lugares persistentes em que as pessoas enviam mensagens, compartilham arquivos e colaboram.
Ao configurar um espaço, considere o seguinte:
- O usuário que faz a chamada (autenticado) é adicionado automaticamente ao espaço. Portanto, não é necessário especificar a associação do usuário na solicitação.
- Ao criar uma mensagem direta (DM), se houver uma mensagem direta entre dois usuários, ela será retornada. Caso contrário, um DM é criado.
- Ao criar um chat em grupo, se nenhuma das adesões fornecidas na solicitação for adicionada ao chat em grupo (por exemplo, devido a um problema de permissão), um chat em grupo vazio (incluindo apenas o usuário que faz a chamada) poderá ser criado.
- Não é possível configurar espaços com respostas em linha nem adicionar pessoas de fora do Google Workspace.
- As assinaturas duplicadas (incluindo o usuário que faz a chamada) fornecidas na solicitação são filtradas em vez de resultar em um erro de solicitação.
Pré-requisitos
Node.js
- Uma conta empresarial ou corporativa do Google Workspace com acesso ao Google Chat.
- Configure o ambiente:
- Crie um projeto do Google Cloud.
- Configure a tela de consentimento OAuth.
- Ative e configure a API Google Chat com um nome, ícone e descrição para seu app do Chat.
- Instale a biblioteca de cliente do Cloud para Node.js.
-
Crie credenciais do ID do cliente do OAuth para um aplicativo de computador. Para executar o exemplo neste
guia, salve as credenciais como um arquivo JSON chamado
client_secrets.json
no seu diretório local.
- Escolha um escopo de autorização compatível com a autenticação do usuário.
Python
- Uma conta do Google Workspace para empresas ou empresas com acesso ao Google Chat.
- Configure o ambiente:
- Crie um projeto do Google Cloud.
- Configure a tela de consentimento OAuth.
- Ative e configure a API Google Chat com um nome, um ícone e uma descrição para seu app do Chat.
- Instale a biblioteca de cliente do Cloud para Python.
-
Crie credenciais do ID do cliente do OAuth para um aplicativo de computador. Para executar o exemplo neste
guia, salve as credenciais como um arquivo JSON chamado
client_secrets.json
no seu diretório local.
- Escolha um escopo de autorização que ofereça suporte à autenticação do usuário.
Java
- Uma conta empresarial ou corporativa do Google Workspace com acesso ao Google Chat.
- Configure o ambiente:
- Crie um projeto do Google Cloud.
- Configure a tela de permissão OAuth.
- Ative e configure a API Google Chat com um nome, um ícone e uma descrição para seu app do Chat.
- Instale a biblioteca de cliente do Cloud (em inglês) para Java.
-
Crie credenciais do ID do cliente do OAuth para um aplicativo de computador. Para executar a amostra deste guia, salve as credenciais como um arquivo JSON chamado
client_secrets.json
no seu diretório local.
- Escolha um escopo de autorização que ofereça suporte à autenticação do usuário.
Apps Script
- Uma conta do Google Workspace para empresas ou empresas com acesso ao Google Chat.
- Configure o ambiente:
- Crie um projeto do Google Cloud.
- Configure a tela de consentimento OAuth.
- Ative e configure a API Google Chat com um nome, ícone e descrição para seu app do Chat.
- Crie um projeto independente do Apps Script e ative o Serviço avançado de chat.
- Escolha um escopo de autorização que ofereça suporte à autenticação do usuário.
Configurar um espaço
Para configurar um espaço, transmita o seguinte na sua solicitação:
- Especifique o escopo de autorização
chat.spaces.create
ouchat.spaces
. - Chame o método
SetUpSpace()
. - Transmita
space
como uma instância deSpace
com todos os campos necessários, comodisplayName
ouspaceType
. - Transmita
memberships
como uma matriz de instânciasMembership
. Para cada instância:- Especifique
users/{user}
para adicionar um usuário humano como participante do espaço, em que{user}
é o{person_id}
doperson
da API People ou o ID de umauser
na API Directory. Por exemplo, se oresourceName
da pessoa da API People forpeople/123456789
, será possível adicionar o usuário ao espaço incluindo uma associação comusers/123456789
comomember.name
. - Especifique
groups/{group}
para adicionar um grupo como membro do espaço, em que{group}
é o ID do grupo para o qual você quer criar a associação. O ID do grupo pode ser recuperado usando a API Cloud Identity. Por exemplo, se a API Cloud Identity retornar um grupo com o nomegroups/123456789
, definamembership.groupMember.name
comogroups/123456789
. Não é possível adicionar Grupos do Google a um grupo de chat ou mensagem direta, mas apenas a um espaço nomeado.
- Especifique
Para criar uma DM entre o usuário que faz a chamada e outro usuário humano, especifique uma filiação do usuário humano na sua solicitação.
Para criar uma DM entre o usuário que faz a chamada e o app de chamada, defina
space.singleUserBotDm
como true
e não especifique nenhuma associação. Só é possível
usar esse método para configurar uma DM com o app de chamada. Para adicionar o app de chamada
como membro de um espaço ou de uma DM entre dois usuários humanos, consulte
Criar uma associação.
O exemplo a seguir cria um espaço com nome e uma associação ao espaço para dois usuários humanos (o usuário autenticado e outro usuário).
Node.js
Python
Java
Apps Script
Para executar a amostra, substitua o seguinte:
DISPLAY_NAME
: o nome de exibição do novo espaço.USER_NAME
: o ID do outro usuário que vai receber a assinatura.
Para acessar o espaço, use o ID do recurso e crie o URL dele.
Você pode conferir o ID do recurso do espaço name
no corpo da resposta do
Google Chat. Por exemplo, se o name
do espaço for spaces/1234567
, acesse
o espaço usando o seguinte URL:
https://mail.google.com/chat/u/0/#chat/space/1234567
.
Temas relacionados
- Crie um espaço.
- Conferir detalhes sobre um espaço.
- Listar espaços.
- Atualizar um espaço.
- Excluir um espaço.
- Encontre um espaço de mensagem direta.
- Deixar um espaço detectável para usuários específicos.