Wyświetlenie listy pokoi

Z tego przewodnika dowiesz się, jak używać zasobu list w zasobie Space interfejsu Google Chat API do wyświetlania listy pokoi. W przypadku listy pokoi zwracana jest podzielona na strony lista pokoi, którą można filtrować.

Zasób Space wskazuje miejsce, w którym użytkownicy i aplikacje do obsługi czatu mogą wysyłać wiadomości, udostępniać pliki i współpracować. Jest kilka typów pokoi:

  • Czaty to rozmowy między 2 użytkownikami lub użytkownikiem i aplikacją Google Chat.
  • Czaty grupowe to rozmowy między co najmniej 3 użytkownikami i aplikacjami Google Chat.
  • Pokoje nazwane to trwałe miejsca, w których użytkownicy wysyłają wiadomości, udostępniają pliki i współpracują.

Lista pokoi z uwierzytelnianiem w aplikacji zawiera listę pokoi, do których aplikacja Google Chat ma dostęp. Lista pokoi z uwierzytelnianiem użytkownika zawiera listę pokoi, do których ma dostęp uwierzytelniony użytkownik.

Wymagania wstępne

Python

  • Python 3.6 lub nowszy
  • Narzędzie do zarządzania pakietami pip

  • Najnowsze biblioteki klienta Google dla języka Python. Aby je zainstalować lub zaktualizować, uruchom w interfejsie wiersza poleceń to polecenie:

    pip3 install --upgrade google-api-python-client google-auth-oauthlib google-auth
  • Projekt Google Cloud z włączonym i skonfigurowanym interfejsem Google Chat API. Instrukcje znajdziesz w artykule Tworzenie aplikacji Google Chat.

  • Skonfigurowano autoryzację dla aplikacji Google Chat. Pokoje z listą pomieszczeń obsługują obie te metody uwierzytelniania:

Node.js

  • Node.js i npm

  • Najnowsze biblioteki klienta Google dla środowiska Node.js. Aby je zainstalować, uruchom w interfejsie wiersza poleceń to polecenie:

    npm install @google-cloud/local-auth @googleapis/chat
  • Projekt Google Cloud z włączonym i skonfigurowanym interfejsem Google Chat API. Instrukcje znajdziesz w artykule Tworzenie aplikacji Google Chat.

  • Skonfigurowano autoryzację dla aplikacji Google Chat. Pokoje z listą pomieszczeń obsługują obie te metody uwierzytelniania:

Wyświetlenie listy pokoi z uwierzytelnianiem użytkownika

Aby wyświetlić listę pokoi w Google Chat, przekaż w prośbie:

Poniżej znajduje się przykładowa lista nazwanych pokoi i czatów grupowych (ale nie czatów, które są odfiltrowane) widocznych dla uwierzytelnionego użytkownika:

Python

  1. W katalogu roboczym utwórz plik o nazwie chat_space_list.py.

  2. Umieść ten kod w elemencie 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. W katalogu roboczym skompiluj i uruchom przykład:

    python3 chat_space_list.py

Node.js

  1. W katalogu roboczym utwórz plik o nazwie list-spaces.js.

  2. Umieść ten kod w elemencie 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. W katalogu roboczym uruchom przykład:

    node list-spaces.js

Interfejs Chat API zwraca podzielony na strony tablicę nazwanych pokoi i czatów grupowych.

Wyświetlanie listy pokoi z uwierzytelnianiem w aplikacji

Aby wyświetlić listę pokoi w Google Chat, przekaż w prośbie:

Poniżej znajduje się przykład listy nazwanych pokoi i czatów grupowych (ale nie czatów) widocznych dla aplikacji Google Chat:

Python

  1. W katalogu roboczym utwórz plik o nazwie chat_space_list_app.py.

  2. Umieść ten kod w elemencie 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. W katalogu roboczym skompiluj i uruchom przykład:

    python3 chat_space_list_app.py

Node.js

  1. W katalogu roboczym utwórz plik o nazwie app-list-spaces.js.

  2. Umieść ten kod w elemencie 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. W katalogu roboczym uruchom przykład:

    node app-list-spaces.js

Interfejs Chat API zwraca tablicę pokoi podzieloną na strony.

Dostosuj podział na strony lub filtruj listę

Aby wyświetlić listę pokoi w Google Chat, przekaż te opcjonalne parametry zapytania w celu dostosowania podziału na strony lub filtrowania wymienionych pokoi:

  • pageSize: maksymalna liczba spacji do zwrócenia. Usługa może zwrócić wartość mniejszą od tej wartości. Jeśli nie określono inaczej, zwracanych jest maksymalnie 100 spacji. Maksymalna wartość to 1000, a wartości powyżej 1000 są automatycznie zmieniane na 1000.
  • pageToken: token strony otrzymany z poprzedniego wywołania pokoi list. Podaj ten token, aby pobrać kolejną stronę. W przypadku podziału na strony wartość filtra powinna odpowiadać wywołaniu, które dostarczyło token strony. Przekazywanie innej wartości może doprowadzić do nieoczekiwanych wyników.
  • filter: filtr zapytania. Szczegółowe informacje o obsługiwanych zapytaniach znajdziesz w opisie metody spaces.list.