Neste guia, explicamos 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 do Chat podem enviar mensagens,
compartilhar arquivos e colaborar. Há vários tipos de espaços:
- As mensagens diretas são conversas entre dois usuários ou um usuário e um app do Chat.
- Os grupos de chat são conversas entre três ou mais usuários e os apps do Chat.
- Os espaços nomeados são lugares persistentes onde 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
sem nome não têm, como administradores 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 do Chat
que o cria. Para adicionar pessoas, crie associações no espaço chamando o
método create
no
recurso Member
.
Saiba como fazer isso em Criar uma assinatura.
Para criar um espaço nomeado com vários participantes, 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 do Chat chamando a API Chat, configure um espaço.
Pré-requisitos
Python
- Python 3.6 ou superior
- pip (em inglês)
As bibliotecas de cliente mais recentes do Google para Python. Para instalá-los ou atualizá-los, execute o seguinte comando em sua interface de linha de comando:
pip3 install --upgrade google-api-python-client google-auth-oauthlib
- Um projeto do Google Cloud com a API Google Chat ativada e configurada. Para ver as etapas, consulte Criar um app do Google Chat.
Autorização configurada para o app do Chat. A criação de um espaço requer a autenticação do usuário com o escopo de autorização
chat.spaces.create
ouchat.spaces
.
Node.js
- Node.js e npm
As bibliotecas de cliente mais recentes do Google para Node.js. Para instalá-los, execute o seguinte comando em sua interface de linha de comando:
npm install @google-cloud/local-auth @googleapis/chat
- Um projeto do Google Cloud com a API Google Chat ativada e configurada. Para ver as etapas, consulte Criar um app do Google Chat.
Autorização configurada para o app do Chat. A criação de um espaço requer a autenticação do usuário com o escopo de autorização
chat.spaces.create
ouchat.spaces
.
Criar um espaço nomeado
Para criar um espaço nomeado, transmita o seguinte na sua solicitação:
- Especifique o escopo de autorização
chat.spaces.create
ouchat.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 a seguir,displayName
é definido comoAPI-made
. - 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).
Veja como criar um espaço nomeado:
Python
- No diretório de trabalho, crie um arquivo chamado
chat_space_create_named.py
. Inclua o seguinte código em
chat_space_create_named.py
:from google_auth_oauthlib.flow import InstalledAppFlow from googleapiclient.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.spaces.create"] def main(): ''' Authenticates with Chat API via user credentials, then creates a Chat space. ''' # Authenticate with Google Workspace # and get user authorization. flow = InstalledAppFlow.from_client_secrets_file( 'client_secrets.json', SCOPES) creds = flow.run_local_server() # Build a service endpoint for Chat API. chat = build('chat', 'v1', credentials=creds) # 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' } ).execute() # Prints details about the created space. print(result) if __name__ == '__main__': main()
No diretório de trabalho, crie e execute o exemplo:
python3 chat_space_create_named.py
Node.js
- No diretório de trabalho, crie um arquivo chamado
create-space.js
. Inclua o seguinte código em
create-space.js
:const chat = require('@googleapis/chat'); const {authenticate} = require('@google-cloud/local-auth'); /** * Creates a new chat space. * @return {!Promise<!Object>} */ async function createSpace() { const scopes = [ 'https://www.googleapis.com/auth/chat.spaces.create', ]; const authClient = await authenticate({scopes, keyfilePath: 'client_secrets.json'}); const chatClient = await chat.chat({version: 'v1', auth: authClient}); return await chatClient.spaces.create( {requestBody: {spaceType: 'SPACE', displayName: 'API-made'}}); } createSpace().then(console.log);
No diretório de trabalho, execute o exemplo:
node create-space.js
Um espaço nomeado é criado. Para navegar até o espaço, use o ID do recurso
para criar o URL dele. É possível 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
- Crie participantes para adicionar pessoas e apps ao espaço.
- Para postar uma mensagem no espaço, crie uma mensagem.
- Ver 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.
- Tornar um espaço detectável para usuários específicos