Este guia explica como usar o método
create()
no recurso Space
da API Google Chat para criar um espaço nomeado.
O
recurso Space
representa um lugar onde as pessoas e os apps de 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.
Um espaço nomeado é um lugar onde as pessoas enviam mensagens, compartilham arquivos e colaboram. Os espaços nomeados podem incluir apps do Chat. Os espaços nomeados incluem recursos extras que as conversas em grupo e as mensagens diretas não têm, como administradores de espaço que podem aplicar configurações administrativas, descrições e adicionar ou remover pessoas e apps. Depois de criar um espaço nomeado, o único membro dele é o usuário autenticado. O espaço não inclui outras pessoas ou apps, nem mesmo o app Chat que o criou. Para adicionar participantes a um espaço, consulte Criar uma assinatura.
Para criar um espaço nomeado com vários participantes, como um chat em grupo sem nome entre três ou mais pessoas, uma conversa de mensagem direta entre duas pessoas ou uma pessoa e o app Chat que chama a API Chat, configure um espaço.
Pré-requisitos
Node.js
- 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 Node.js.
- Crie credenciais de acesso com base na forma como você quer se autenticar na solicitação da API Google Chat:
- Para fazer a autenticação como um usuário do Chat,
crie credenciais de ID do cliente do OAuth e salve-as como um arquivo JSON chamado
client_secrets.json
no seu diretório local. - Para fazer a autenticação como o app de chat,
crie credenciais da conta de serviço e salve-as como um arquivo JSON chamado
credentials.json
.
- Para fazer a autenticação como um usuário do Chat,
crie credenciais de ID do cliente do OAuth e salve-as como um arquivo JSON chamado
- Escolha um escopo de autorização com base em se você quer autenticar como um usuário ou o app Chat.
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, ícone e descrição para seu app do Chat.
- Instale a biblioteca de cliente do Cloud para Python.
- Crie credenciais de acesso com base em como você quer autenticar sua solicitação da API Google Chat:
- Para fazer a autenticação como um usuário do Chat,
crie credenciais de ID do cliente do OAuth e salve-as como um arquivo JSON chamado
client_secrets.json
no seu diretório local. - Para fazer a autenticação como o app de chat,
crie credenciais da conta de serviço e salve-as como um arquivo JSON chamado
credentials.json
.
- Para fazer a autenticação como um usuário do Chat,
crie credenciais de ID do cliente do OAuth e salve-as como um arquivo JSON chamado
- Escolha um escopo de autorização com base em se você quer autenticar como um usuário ou o app Chat.
Java
- 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 Java.
- Crie credenciais de acesso com base na forma como você quer se autenticar na solicitação da API Google Chat:
- Para autenticar como um usuário do Chat, crie credenciais de ID do cliente OAuth e salve-as como um arquivo JSON chamado
client_secrets.json
no seu diretório local. - Para fazer a autenticação como o app de chat,
crie credenciais da conta de serviço e salve-as como um arquivo JSON chamado
credentials.json
.
- Para autenticar como um usuário do Chat, crie credenciais de ID do cliente OAuth e salve-as como um arquivo JSON chamado
- Escolha um escopo de autorização para autenticar como usuário ou como app do Chat.
Apps Script
- 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.
- Crie um projeto independente do Apps Script e ative o Serviço avançado de chat.
- Neste guia, você precisa usar a autenticação do usuário ou do app. Para autenticar como o app do Chat, crie as credenciais da conta de serviço. Para conferir as etapas, consulte Autenticar e autorizar como um app do Google Chat.
- Escolha um escopo de autorização com base em se você quer autenticar como um usuário ou o app Chat.
Criar um espaço nomeado como um usuário
Para criar um espaço nomeado com a autenticação do usuário, transmita o seguinte na solicitação:
- Especifique o escopo de autorização
chat.spaces.create
ouchat.spaces
. - Chame o método
CreateSpace()
, transmitindospace
como uma instância deSpace
com os seguintes campos:spaceType
definido comoSPACE
.displayName
definido como o nome visível para o usuário do espaço.- Se quiser, defina outros atributos, como os seguintes:
spaceDetails
: uma descrição visível ao usuário e um conjunto de diretrizes para o espaço.predefinedPermissionSettings
: permissões predefinidas para o espaço. Por exemplo, você pode configurar para que todos os participantes ou apenas os administradores do espaço possam postar mensagens.
Veja como criar um espaço com nome:
Node.js
Python
Java
Apps Script
Criar um espaço com nome como um app de chat
A autenticação de apps requer uma aprovação única do administrador.
Para convidar ou adicionar um usuário a um espaço com autenticação de apps, transmita o seguinte na solicitação:
- Especifique o escopo de autorização
chat.app.spaces.create
ouchat.app.spaces
. - Chame o
método
create
no recursoSpace
. - Defina
spaceType
comoSPACE
. - Defina
displayName
como o nome visível ao usuário do espaço. No exemplo abaixo,displayName
é definido comoAPI-made
. - Especifique o ID do cliente do domínio do Google Workspace usando o campo
customer
. - Outra opção é definir outros atributos de espaço, como
spaceDetails
(uma descrição visível ao usuário e um conjunto de diretrizes para o espaço).
Criar uma chave de API
Para chamar um método da prévia para desenvolvedores da API, use uma versão não pública da prévia para desenvolvedores do documento de descoberta da API. Para autenticar a solicitação, é necessário transmitir uma chave de API.
Para criar a chave de API, abra o projeto do Google Cloud do app e faça o seguinte:
- No console do Google Cloud, acesse Menu > APIs e serviços > Credenciais.
- Clique em Criar credenciais > Chave de API.
- Sua nova chave de API vai aparecer.
- Clique em Copiar para copiar sua chave de API e usá-la no código do app. A chave de API também pode ser encontrada na seção "Chaves de API" das credenciais do projeto.
- Clique em Restringir chave para atualizar as configurações avançadas e limitar o uso da chave de API. Para mais detalhes, consulte Como aplicar restrições de chave de API.
Programar um script que chame a API Chat
Veja como criar um espaço nomeado:
Python
- No diretório de trabalho, crie um arquivo chamado
chat_space_create_named_app.py
. Inclua o seguinte código em
chat_space_create_named_app.py
:from google.oauth2 import service_account from apiclient.discovery import build # Define your app's authorization scopes. # When modifying these scopes, delete the file token.json, if it exists. SCOPES = ["https://www.googleapis.com/auth/chat.app.spaces.create"] def main(): ''' Authenticates with Chat API using app authentication, then creates a Chat space. ''' # Specify service account details. creds = ( service_account.Credentials.from_service_account_file('credentials.json') .with_scopes(SCOPES) ) # Build a service endpoint for Chat API. chat = build('chat', 'v1', credentials=creds, discoveryServiceUrl='https://chat.googleapis.com/$discovery/rest?version=v1&labels=DEVELOPER_PREVIEW&key=API_KEY') # Use the service endpoint to call Chat API. result = chat.spaces().create( # Details about the space to create. body = { # To create a named space, set spaceType to SPACE. 'spaceType': 'SPACE', # The user-visible name of the space. 'displayName': 'API-made', # The customer ID of the Workspace domain. 'customer': 'CUSTOMER' } ).execute() # Prints details about the created space. print(result) if __name__ == '__main__': main()
No código, substitua o seguinte:
API_KEY
: a chave de API criada para criar o endpoint de serviço da API Chat.CUSTOMER
: o ID do cliente do domínio do espaço no formatocustomer/{customer}
, em que{customer}
é oID
do recurso de cliente do SDK Admin. Para criar um espaço na mesma organização do Google Workspace que o app do Chat, usecustomers/my_customer
.
No diretório de trabalho, crie e execute o exemplo:
python3 chat_space_create_named_app.py
Abrir o espaço no Google Chat
Para navegar até o espaço, use o ID do recurso
para criar o URL dele. Você pode encontrar 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
, você poderá navegar até ele usando este
URL: https://mail.google.com/chat/u/0/#chat/space/1234567
.
Temas relacionados
- Adicione pessoas e apps ao espaço criando participantes.
- Para postar uma mensagem no espaço, crie uma mensagem.
- Conferir detalhes sobre um espaço.
- Listar espaços
- Atualizar um espaço.
- Excluir um espaço.
- Configurar um espaço.
- Encontrar um espaço de mensagem direta.
- Deixar um espaço detectável para usuários específicos.