Details zur Mitgliedschaft eines Nutzers oder einer Google Chat App abfragen

In dieser Anleitung wird erläutert, wie Sie die Methode get für die Ressource membership der Google Chat API verwenden, um Details zur Mitgliedschaft eines Nutzers oder einer Chat-App in einem Gruppenbereich abzurufen.

Die Ressource Membership gibt an, ob ein menschlicher Nutzer oder eine Google Chat-App in einen Gruppenbereich eingeladen oder dort teilweise eingeladen wurde oder nicht.

Bei der App-Authentifizierung kann eine Chat-App Mitgliedschaften aus Bereichen erhalten, auf die sie in Google Chat Zugriff hat (z. B. Gruppenbereiche, in denen sie Mitglied ist). Mitgliedschaften in Chat-Apps werden jedoch ausgeschlossen, einschließlich ihrer eigenen. Bei der Authentifizierung mithilfe der Nutzerauthentifizierung werden Mitgliedschaften aus Bereichen zurückgegeben, auf die der authentifizierte Nutzer Zugriff hat.

Voraussetzungen

Python

  • Python 3.6 oder höher
  • Das Paketverwaltungstool pip
  • Die aktuellen Google-Clientbibliotheken für Python. Führen Sie den folgenden Befehl in der Befehlszeile aus, um sie zu installieren oder zu aktualisieren:

    pip3 install --upgrade google-api-python-client google-auth-oauthlib
    
  • Ein Google Cloud-Projekt, in dem die Google Chat API aktiviert und konfiguriert ist. Eine entsprechende Anleitung finden Sie unter Google Chat-App erstellen.
  • Für die Chat-App konfigurierte Autorisierung. Eine Mitgliedschaft unterstützt die beiden folgenden Authentifizierungsmethoden:

Details zur Mitgliedschaft eines Nutzers oder einer Chat-App abrufen

Wenn Sie Details zu einer Mitgliedschaft in Google Chat erhalten möchten, übergeben Sie in Ihrer Anfrage Folgendes:

  • Geben Sie für die Anwendungsauthentifizierung den Autorisierungsbereich chat.bot an. Geben Sie für die Nutzerauthentifizierung den Autorisierungsbereich chat.memberships.readonly oder chat.memberships an. Wählen Sie als Best Practice den restriktivsten Bereich aus, bei dem Ihre Anwendung noch funktionieren kann.
  • Rufen Sie die Methode get für die Ressource membership auf.
  • Übergeben Sie die name der Mitgliedschaft, um zu erhalten. Rufen Sie den Namen der Mitgliedschaft aus der Mitgliedschaftsressource von Google Chat ab.

So erhältst du eine Mitgliedschaft mit der Nutzerauthentifizierung:

Python

  1. Erstellen Sie in Ihrem Arbeitsverzeichnis eine Datei mit dem Namen chat_membership_get.py.
  2. Fügen Sie den folgenden Code in chat_membership_get.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 gets details about a specified membership.
        '''
    
        # 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().get(
    
            # The membership to get.
            #
            # Replace SPACE with a space name.
            # Obtain the space name from the spaces resource of Chat API,
            # or from a space's URL.
            #
            # Replace MEMBER with a membership name.
            # Obtain the membership name from the memberships resource of
            # Chat API.
            name='spaces/SPACE/members/MEMBER'
    
        ).execute()
    
        # Prints details about the created membership.
        print(result)
    
    if __name__ == '__main__':
        main()
    
  3. Ersetzen Sie im Code Folgendes:

    • SPACE: Der Name eines Gruppenbereichs, den Sie über die Methode spaces.list in der Chat API oder aus der URL eines Gruppenbereichs abrufen können.
    • MEMBER: ein Mitgliedsname, den Sie aus der Methode spaces.members.list in der Chat API abrufen können.
  4. Erstellen Sie das Beispiel in Ihrem Arbeitsverzeichnis und führen Sie es aus:

    python3 chat_membership_get.py
    

Die Chat API gibt eine Instanz von membership zurück, in der die angegebene Mitgliedschaft detailliert beschrieben ist.