Mitglieder in einem Gruppenbereich auflisten

In diesem Leitfaden wird erläutert, wie Sie die Methode list für die Ressource membership verwenden. der Google Chat API, um Mitglieder in einem Gruppenbereich als paginierte, filterbare Liste aufzulisten. in einem Gruppenbereich. Mitgliedschaften auflisten mit App-Authentifizierung Listet Mitgliedschaften in Gruppenbereichen auf, die die Chat App hat Zugriff auf die Mitgliedschaften in der Chat App, einschließlich davon, ausgenommen, für sich nutzen. Mitgliedschaften auflisten mit Nutzerauthentifizierung listet Mitgliedschaften in Gruppenbereichen auf, auf die der authentifizierte Nutzer Zugriff hat.

Die Membership-Ressource gibt an, ob ein menschlicher Nutzer oder die Google Chat App Teil eines Leerzeichens oder fehlt.

Vorbereitung

Python

Mitglieder in einem Gruppenbereich mit Nutzerauthentifizierung auflisten

So listen Sie Nutzer, Google Groups und die Chat App in einem Gruppenbereich auf auf die der authentifizierte Nutzer Zugriff hat, übergeben Sie in Ihrer Anfrage Folgendes:

  • Mit Nutzerauthentifizierung Geben Sie die Autorisierung chat.memberships.readonly oder chat.memberships an Umfang.
  • Rufen Sie die Methode list-Methode am membership-Ressource.
  • Wenn Sie Google Groups-Gruppen auflisten möchten, legen Sie den Suchparameter showGroups auf true fest.

Im folgenden Beispiel werden Google Groups-Mitglieder, Nutzer und App-Mitglieder aufgelistet, die sichtbar für mit dem authentifizierten Nutzer.

Python

  1. Erstellen Sie in Ihrem Arbeitsverzeichnis eine Datei mit dem Namen chat_member_list_user.py.

  2. Fügen Sie den folgenden Code in chat_member_list_user.py ein:

    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. Ersetzen Sie im Code SPACE durch einen Namen für den Gruppenbereich, der erhalten Sie in der Methode spaces.list in der Chat API oder über die URL eines Gruppenbereichs.

  4. Erstellen Sie das Beispiel in Ihrem Arbeitsverzeichnis und führen Sie es aus:

    python3 chat_member_list_user.py

Die Google Chat API gibt eine Liste der Gruppenmitglieder, Nutzer und App-Mitglieder aus dem angegebenen Leerzeichen enthalten.

Mitglieder in einem Gruppenbereich mit App-Authentifizierung auflisten

So listen Sie Nutzer und die Chat App in einem Gruppenbereich auf auf die die authentifizierte App zugreifen kann, übergeben Sie in Ihrer Anfrage Folgendes:

Im folgenden Beispiel werden die Mitglieder des Gruppenbereichs (keine Administratoren des Gruppenbereichs) aufgeführt, die sichtbar für Chat-App:

Python

  1. Erstellen Sie in Ihrem Arbeitsverzeichnis eine Datei mit dem Namen chat_member_list_app.py.

  2. Fügen Sie den folgenden Code in chat_member_list_app.py ein:

    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. Ersetzen Sie im Code SPACE durch einen Namen für den Gruppenbereich, der erhalten Sie in der Methode spaces.list in der Chat API oder über die URL eines Gruppenbereichs.

  4. Erstellen Sie das Beispiel in Ihrem Arbeitsverzeichnis und führen Sie es aus:

    python3 chat_member_list_app.py

Die Google Chat API gibt eine Liste der Mitglieder des menschlichen Gruppenbereichs zurück (ohne Gruppenbereiche) Administratoren) aus dem angegebenen Gruppenbereich.

Paginierung anpassen oder Liste filtern

Um die Mitgliedschaften aufzulisten, übergeben Sie die folgenden Abfrageparameter an Paginierung der aufgeführten Mitgliedschaften anpassen oder filtern:

  • pageSize: Die maximale Anzahl von Mitgliedschaften, die zurückgegeben werden sollen. Der Dienst kann gibt weniger als diesen Wert zurück. Wenn nicht angegeben, sind maximal 100 Leerzeichen zulässig zurückgegeben. Der Maximalwert ist 1.000. Werte über 1.000 werden automatisch auf 1.000 geändert.
  • pageToken: Seitentoken, das von einem vorherigen Aufruf von Gruppenbereichen zur Liste empfangen wurde. Geben Sie dieses Token an, um die nachfolgende Seite abzurufen. Beim Paginieren Filterwert muss mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat. Übergeben eines kann das zu unerwarteten Ergebnissen führen.
  • filter: ein Abfragefilter. Erforderlich Nutzerauthentifizierung Details zu unterstützten Abfragen finden Sie in der spaces.members.list-Methode.