Neste guia, explicamos como usar o list
no Space
da API Google Chat para listar espaços. A listagem de espaços retorna uma lista paginada e filtrável de espaços.
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.
Para listar os espaços com autenticação de app, você lista os espaços a que o app do Chat tem acesso. Para listar espaços com Autenticação de usuário, lista os 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 listagem de espaços é compatível com 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 listagem de espaços é compatível com 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
Listar espaços com autenticação de usuário
Para listar espaços no Google Chat, transmita o seguinte na sua solicitação:
- Com a
autenticação do usuário,
especifique o escopo de autorização
chat.spaces.readonly
ouchat.spaces
. - Chame o
método
list
no recursoSpace
.
O exemplo a seguir lista espaços nomeados e chats em grupo (mas não mensagens diretas, que são filtrados) visíveis para o usuário autenticado:
Python
- No diretório de trabalho, crie um arquivo chamado
chat_space_list.py
. Inclua o seguinte código em
chat_space_list.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 lists named spaces and group chats (but not direct messages) visible to the authenticated user. ''' # 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().list( # An optional filter that returns named spaces or unnamed group chats, # but not direct messages (DMs). filter='spaceType = "SPACE" OR spaceType = "GROUP_CHAT"' ).execute() # Prints the returned list of spaces. print(result) if __name__ == '__main__': main()
No diretório de trabalho, crie e execute a amostra:
python3 chat_space_list.py
Node.js
- No diretório de trabalho, crie um arquivo chamado
list-spaces.js
. Inclua o seguinte código em
list-spaces.js
:const chat = require('@googleapis/chat'); const {authenticate} = require('@google-cloud/local-auth'); /** * List Chat spaces. * @return {!Promise<!Object>} */ async function listSpaces() { 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.list({ filter: 'spaceType = "SPACE" OR spaceType = "GROUP_CHAT"' }); } listSpaces().then(console.log);
No diretório de trabalho, execute o exemplo:
node list-spaces.js
A API Chat retorna uma matriz paginada de espaços nomeados e chats em grupo.
Listar espaços com autenticação de apps
Para listar espaços no Google Chat, transmita o seguinte na sua solicitação:
- Com a
autenticação de apps,
especifique o escopo de autorização
chat.bot
. - Chame o
método
list
no recursoSpace
.
O exemplo a seguir lista espaços nomeados e chats em grupo (mas não mensagens diretas) visíveis para o app do Chat:
Python
- No diretório de trabalho, crie um arquivo chamado
chat_space_list_app.py
. Inclua o seguinte código em
chat_space_list_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().list( # An optional filter that returns named spaces or unnamed # group chats, but not direct messages (DMs). filter='spaceType = "SPACE" OR spaceType = "GROUP_CHAT"' ).execute() print(result)
No diretório de trabalho, crie e execute a amostra:
python3 chat_space_list_app.py
Node.js
- No diretório de trabalho, crie um arquivo chamado
app-list-spaces.js
. Inclua o seguinte código em
app-list-spaces.js
:const chat = require('@googleapis/chat'); /** * List Chat spaces. * @return {!Promise<!Object>} */ async function listSpaces() { 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.list({ filter: 'spaceType = "SPACE" OR spaceType = "GROUP_CHAT"' }); } listSpaces().then(console.log);
No diretório de trabalho, execute o exemplo:
node app-list-spaces.js
A API Chat retorna uma matriz paginada de espaços.
Personalizar a paginação ou filtrar a lista
Para listar espaços no Google Chat, transmita os seguintes parâmetros de consulta opcionais para personalizar a paginação ou filtrar os espaços listados:
pageSize
: o número máximo de espaços a serem retornados. O serviço pode retornar menos que esse valor. Se não for especificado, no máximo 100 espaços serão retornados. O valor máximo é 1.000. Valores acima de 1.000 são automaticamente alterados para 1.000.pageToken
: um token de página, recebido de uma chamada anterior de espaços da lista. Forneça esse token para recuperar a página seguinte. Ao paginar, o valor do filtro precisa corresponder à chamada que forneceu o token da página. Transmitir um valor diferente pode levar a resultados inesperados.filter
: um filtro de consulta. Para ver detalhes de consultas compatíveis, consulte o métodospaces.list
.
Temas relacionados
- Crie um espaço.
- Configurar um espaço.
- Ver detalhes sobre um espaço.
- Atualizar um espaço.
- Excluir um espaço.
- Encontre um espaço de mensagens diretas.