Neste guia, explicamos como usar o método get
em um recurso Space
da
API Google Chat para conferir detalhes sobre um espaço, como nome de exibição, descrição
e diretrizes.
O
recurso Space
representa um lugar onde as pessoas e os apps de chat podem enviar mensagens,
compartilhar arquivos e colaborar. Existem 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.
- Chats em grupo são conversas entre três ou mais usuários e apps do Chat.
- Os espaços nomeados são lugares persistentes onde as pessoas enviam mensagens, compartilham arquivos e colaboram.
A autenticação com a autenticação de apps permite que um app do Chat receba espaços a que ele tem acesso no Google Chat (por exemplo, espaços de que o app participa). Autenticar com a autenticação do usuário permite que você receba espaços a que o usuário autenticado tem acesso.
Pré-requisitos
Python
- Python 3.6 ou superior
- A ferramenta de gerenciamento de pacotes pip
As bibliotecas de cliente mais recentes do Google para Python. Para instalar ou atualizar, execute o seguinte na interface de linha de comando:
pip3 install --upgrade google-api-python-client google-auth-oauthlib google-auth
- Um projeto do Google Cloud com a API Google Chat ativada e configurada. Veja as etapas em Criar um app do Google Chat.
Autorização configurada para o app do Chat. A obtenção de um espaço aceita os dois métodos de autenticação a seguir:
- Autenticação do usuário com o escopo de autorização
chat.spaces.readonly
ouchat.spaces
. - Autenticação de app
com o escopo de autorização
chat.bot
.
- Autenticação do usuário com o escopo de autorização
Node.js
- Node.js e npm
As bibliotecas de cliente mais recentes do Google para Node.js. Para instalá-los, execute o seguinte comando na 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. Veja as etapas em Criar um app do Google Chat.
Autorização configurada para o app do Chat. A obtenção de um espaço aceita os dois métodos de autenticação a seguir:
- Autenticação do usuário com o escopo de autorização
chat.spaces.readonly
ouchat.spaces
. - Autenticação de app
com o escopo de autorização
chat.bot
.
- Autenticação do usuário com o escopo de autorização
Comprar um espaço
Para ter um espaço no Google Chat, envie o seguinte comando na sua solicitação:
- Com a
autenticação de apps,
especifique o escopo de autorização
chat.bot
. Com a autenticação do usuário, especifique o escopo de autorizaçãochat.spaces.readonly
ouchat.spaces
. - Chame o
método
get
no recursoSpace
, transmitindo oname
do espaço a ser recebido. Encontre o nome do espaço no recurso de espaços do Google Chat ou no URL de um espaço.
Receber detalhes do espaço com a autenticação do usuário
Confira como conseguir detalhes do espaço com a autenticação do usuário:
Python
- No diretório de trabalho, crie um arquivo chamado
chat_space_get_user.py
. Inclua o seguinte código em
chat_space_get_user.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.readonly"] def main(): ''' Authenticates with Chat API via user credentials, then gets details about a specified 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().get( # The space to get. # # Replace SPACE with a space name. # Obtain the space name from the spaces resource of Chat API, # or from a space's URL. name='spaces/SPACE' ).execute() # Prints details about the space. print(result) if __name__ == '__main__': main()
No código, substitua
SPACE
por um nome de espaço, que pode ser obtido no métodospaces.list
na API Chat ou no URL de um espaço.No diretório de trabalho, crie e execute a amostra:
python3 chat_space_get_user.py
Node.js
- No diretório de trabalho, crie um arquivo chamado
get-space.js
. Inclua o seguinte código em
get-space.js
:const chat = require('@googleapis/chat'); const {authenticate} = require('@google-cloud/local-auth'); /** * Gets details about a Chat space by name. * @return {!Object} */ async function getSpace() { const scopes = [ 'https://www.googleapis.com/auth/chat.spaces.readonly', ]; const authClient = await authenticate({scopes, keyfilePath: 'client_secrets.json'}); const chatClient = await chat.chat({version: 'v1', auth: authClient}); return await chatClient.spaces.get({name: 'spaces/SPACE'}); } getSpace().then(console.log);
No código, substitua
SPACE
por um nome de espaço, que pode ser obtido no métodospaces.list
na API Chat ou no URL de um espaço.No diretório de trabalho, execute o exemplo:
node get-space.js
A API Chat retorna uma instância de
Space
que detalha o espaço especificado.
Receber detalhes do espaço com a autenticação de apps
Confira como receber detalhes do espaço com a autenticação de apps:
Python
- No diretório de trabalho, crie um arquivo chamado
chat_space_get_app.py
. Inclua o seguinte código em
chat_space_get_app.py
:from google.oauth2 import service_account from apiclient.discovery import build # Specify required scopes. SCOPES = ['https://www.googleapis.com/auth/chat.bot'] # Specify service account details. CREDENTIALS = ( service_account.Credentials.from_service_account_file('credentials.json') .with_scopes(SCOPES) ) # Build the URI and authenticate with the service account. chat = build('chat', 'v1', credentials=CREDENTIALS) # Use the service endpoint to call Chat API. result = chat.spaces().get( # The space to get. # # Replace SPACE with a space name. # Obtain the space name from the spaces resource of Chat API, # or from a space's URL. name='spaces/SPACE' ).execute() print(result)
No código, substitua
SPACE
por um nome de espaço, que pode ser encontrado no métodospaces.list()
da API Chat ou no URL de um espaço.No diretório de trabalho, crie e execute a amostra:
python3 chat_space_get_app.py
Node.js
- No diretório de trabalho, crie um arquivo chamado
app-get-space.js
. Inclua o seguinte código em
app-get-space.js
:const chat = require('@googleapis/chat'); /** * Gets details about a Chat space by name. * @return {!Promise<!Object>} */ async function getSpace() { const scopes = [ 'https://www.googleapis.com/auth/chat.bot', ]; const auth = new chat.auth.GoogleAuth({ scopes, keyFilename: 'credentials.json', }); const authClient = await auth.getClient(); const chatClient = await chat.chat({version: 'v1', auth: authClient}); return await chatClient.spaces.get({name: 'spaces/SPACE'}); } getSpace().then(console.log);
No código, substitua
SPACE
por um nome de espaço, que pode ser obtido no métodospaces.list
na API Chat ou no URL de um espaço.No diretório de trabalho, execute o exemplo:
node app-get-space.js
A API Chat retorna uma instância de
Space
que detalha o espaço especificado.
Temas relacionados
- Crie um espaço.
- Configurar um espaço.
- Listar espaços.
- Atualizar um espaço.
- Excluir um espaço.
- Encontre um espaço de mensagens diretas.