Wyświetlanie listy użytkowników w pokoju

Z tego przewodnika dowiesz się, jak używać metody list w zasobie membership interfejsu Google Chat API do wyświetlania użytkowników w pokoju w postaci podzielonej na strony listy, którą można filtrować w pomieszczeniu. Członkostwo w usłudze z uwierzytelnianie aplikacji wyświetla listę użytkowników w pokojach dostępnych w aplikacji Google Chat. dostępu do aplikacji Google Chat, ale nie obejmuje tej funkcji, i w swojej organizacji. Członkostwo w usłudze z Uwierzytelnianie użytkowników zawiera listę użytkowników w pokojach, do których ma dostęp uwierzytelniony użytkownik.

Membership zasób wskazuje, czy zaproszeni jest człowiek czy aplikacja Google Chat; które znajdują się w pokoju lub w ogóle ich nie ma.

Wymagania wstępne

Python

Wyświetlanie listy użytkowników w pokoju z uwierzytelnianiem użytkowników

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

Poniżej znajduje się przykład listy członków grupy dyskusyjnej Google, osób i aplikacji, dla których są widoczni uwierzytelnionego użytkownika.

Python

  1. W katalogu roboczym utwórz plik o nazwie chat_member_list_user.py.
  2. Umieść w pliku chat_member_list_user.py ten kod:

    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 Google Group, human, and app members 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',
    
            # Set this parameter to list Google Groups.
            showGroups = 'true'
    
        ).execute()
    
        # Prints the list of memberships.
        print(result)
    
    if __name__ == '__main__':
        main()
    
  3. W kodzie zastąp SPACE nazwą pokoju, która który znajdziesz w Metoda 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
    

Interfejs Google Chat API zwraca listę użytkowników grupy dyskusyjnej Google, użytkowników i aplikacji z w określonym miejscu.

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

Wyświetlanie listy użytkowników i aplikacji Google Chat w pokoju do których ma dostęp uwierzytelniona aplikacja, przekaż w żądaniu te informacje:

Przykład poniżej 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ść w pliku chat_member_list_app.py ten kod:

    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óra który znajdziesz w Metoda 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
    

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

Dostosuj podział na strony lub filtruj listę

Aby wyświetlić listę członków, przekaż następujące parametry zapytania do dostosować podział na strony lub filtrować listy członków:

  • pageSize: maksymalna liczba subskrypcji do zwrócenia. Usługa może zwraca mniej niż ta wartość. Jeśli nie określono inaczej, maksymalnie 100 spacji . Maksymalna wartość to 1000. wartości powyżej 1000 są automatycznie został zmieniony na 1000.
  • pageToken: token strony otrzymany z poprzedniego wywołania listy pokoi. Podaj ten token, aby pobrać kolejną stronę. Przy dzieleniu na strony wartość filtra powinna pasować do wywołania, które dostarczyło token strony. Podanie wyniku może prowadzić do nieoczekiwanych rezultatów.
  • filter: filtr zapytania. Wymagane uwierzytelnianie użytkownika. Szczegółowe informacje o obsługiwanych zapytaniach znajdziesz w Metoda spaces.members.list.