Wyświetlanie listy użytkowników i aplikacji Google Chat w pokoju

Z tego przewodnika dowiesz się, jak używać metody list w zasobie membership interfejsu Google Chat API do wyświetlania listy użytkowników i aplikacji Google Chat w pokoju w formie podzielonej na strony listy członkostwa w pokoju, którą można filtrować. Wyświetlanie informacji o członkostwie w pokojach z uwierzytelnianiem w aplikacji zawiera listę subskrypcji w pokojach, do których aplikacja Google Chat ma dostęp, ale nie z niej. Wyświetlanie listy członkostwa z uwierzytelnianiem użytkowników umożliwia wyświetlenie listy użytkowników w pokojach, do których ma dostęp uwierzytelniony użytkownik.

Zasób Membership wskazuje, czy użytkownik lub aplikacja Google Chat są zaproszone do pokoju, które jest jego częścią lub poza nim.

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. Informacje o członkostwie obsługują obie te metody uwierzytelniania:

Wyświetlanie listy użytkowników i aplikacji Google Chat w pokoju z uwierzytelnianiem użytkowników

Aby wyświetlić listę użytkowników i aplikacji Google Chat w pokoju, do którego ma dostęp uwierzytelniony użytkownik, przekaż w prośbie:

Ten przykład zawiera listę użytkowników obszaru (nie menedżerów pokoju) widocznych dla uwierzytelnionego użytkownika, ponieważ atrybut filter ma wartość ROLE_Member:

Python

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

  2. Umieść ten kod w elemencie chat_member_list_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.memberships.readonly"]

def main():
    '''
    Authenticates with Chat API via user credentials,
    then lists human space members (but not space managers) in 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().members().list(

        # The space for which to list memberships.
        parent = 'spaces/SPACE',

        # An optional filter that returns only human space members.
        filter = 'member.type = "HUMAN" AND role = "ROLE_MEMBER"'

    ).execute()

    # Prints details about the created membership.
    print(result)

if __name__ == '__main__':
    main()

  3. W kodzie zastąp SPACE nazwą pokoju, którą możesz uzyskać za pomocą metody spaces.list w interfejsie Chat API lub z adresu URL pokoju.

  4. W katalogu roboczym skompiluj i uruchom przykład:

    python3 chat_member_list_user.py

Google Chat API zwraca listę użytkowników pokoju (z wyłączeniem menedżerów pokoju) i użytkowników aplikacji z określonego pokoju.

Wyświetlanie listy użytkowników i aplikacji Google Chat w pokoju z uwierzytelnianiem aplikacji

Aby wyświetlić listę użytkowników i aplikacji Google Chat w pokoju, do którego ma dostęp uwierzytelniona aplikacja, przekaż w żądaniu:

Ten przykład zawiera listę użytkowników pokoju (nie menedżerów pokoju) widocznych dla aplikacji Google Chat:

Python

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

  2. Umieść ten kod w elemencie chat_member_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().members().list(

        # The space for which to list memberships.
        parent = 'spaces/SPACE',

        # An optional filter that returns only human space members.
        filter = 'member.type = "HUMAN" AND role = "ROLE_MEMBER"'

    ).execute()

print(result)

  3. W kodzie zastąp SPACE nazwą pokoju, którą możesz uzyskać za pomocą metody spaces.list w interfejsie Chat API lub z adresu URL pokoju.

  4. W katalogu roboczym skompiluj i uruchom przykład:

    python3 chat_member_list_app.py

Google Chat API zwraca listę użytkowników pokoju (z wyłączeniem menedżerów pokoju) z określonego pokoju.

Dostosuj podział na strony lub filtruj listę

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

  • pageSize: maksymalna liczba członkostwa do zwrócenia. Usługa może zwrócić mniejszą wartość od tej wartości. Jeśli ich nie określisz, zwróconych zostanie 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. Wymaga uwierzytelniania użytkownika. Szczegółowe informacje o obsługiwanych zapytaniach znajdziesz w opisie metody spaces.members.list.