Listar espaços

Este guia explica como usar o recurso list no Space do a API Google Chat para listar espaços. Listar espaços retorna uma função paginada e filtrável lista de espaços.

A 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 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 Apps de chat
  • Os espaços nomeados são lugares persistentes onde as pessoas enviam mensagens, compartilham arquivos e colaborar.

Como listar espaços com autenticação de apps lista os espaços que o app do Chat pode acessar. Ficha espaços com Autenticação de usuários lista os espaços que o usuário autenticado pode acessar.

Pré-requisitos

Python

Node.js

Listar espaços com autenticação de usuário

Para listar espaços no Google Chat, transmita o seguinte no seu solicitação:

O exemplo a seguir lista espaços nomeados e chats em grupo (mas não diretos) mensagens, que são filtradas) visíveis para o usuário autenticado:

Python

  1. No diretório de trabalho, crie um arquivo chamado chat_space_list.py.
  2. 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()
    
  3. No diretório de trabalho, crie e execute o exemplo:

    python3 chat_space_list.py
    

Node.js

  1. No diretório de trabalho, crie um arquivo chamado list-spaces.js.
  2. 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);
    
  3. 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 no seu solicitação:

O exemplo a seguir lista espaços nomeados e chats em grupo (mas não diretos) mensagens) visíveis no app do Chat:

Python

  1. No diretório de trabalho, crie um arquivo chamado chat_space_list_app.py.
  2. 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)
    
  3. No diretório de trabalho, crie e execute o exemplo:

    python3 chat_space_list_app.py
    

Node.js

  1. No diretório de trabalho, crie um arquivo chamado app-list-spaces.js.
  2. 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);
    
  3. 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 o seguinte comando opcional parâmetros de consulta para personalizar a paginação ou filtrar espaços listados:

  • pageSize: o número máximo de espaços a serem retornados. O serviço pode retornar menor que esse valor. Se não for especificado, serão retornados no máximo 100 espaços. A o valor máximo é 1.000; valores acima de 1.000 são alterados automaticamente para 1.000.
  • pageToken: um token de página recebido de uma chamada anterior de espaços de lista. Forneça esse token para recuperar a página subsequente. Na paginação, o O valor do filtro precisa corresponder à chamada que forneceu o token da página. Transmitir um valor de um valor diferente pode levar a resultados inesperados.
  • filter: um filtro de consulta. Para obter detalhes sobre as consultas aceitas, consulte a método spaces.list.