Nachrichten auflisten

In diesem Leitfaden wird erläutert, wie Sie mit der Methode list für die Ressource Message der Google Chat API eine paginierte, filterbare Liste von Nachrichten in einem Gruppenbereich aufrufen.

Die Ressource Message steht für eine Textnachricht oder eine Kartennachricht in Google Chat. Sie können eine Nachricht in der Google Chat API mit create, get, update oder delete durch Aufrufen der entsprechenden Methoden abrufen. Weitere Informationen zu Text- und Kartennachrichten finden Sie unter Google Chat-Nachrichten.

Voraussetzungen

Python

  • Python 3.6 oder höher
  • Das Paketverwaltungstool pip

  • Die neuesten 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-httplib2 google-auth-oauthlib oauth2client

  • Eine veröffentlichte Chat-App. Informationen zum Erstellen und Veröffentlichen einer Chat-App finden Sie unter Google Chat-App erstellen.

  • Die für die Chat-App konfigurierte Autorisierung. Zum Auflisten von Nachrichten ist eine Nutzerauthentifizierung mit dem Autorisierungsbereich chat.messages.readonly oder chat.messages erforderlich.

Nachrichten auflisten

Übergeben Sie in der Anfrage Folgendes, um Nachrichten mit Nutzerauthentifizierung aufzulisten:

Im folgenden Beispiel werden Nachrichten in einem Chatbereich aufgelistet, die nach dem 16. März 2023 gesendet wurden:

Python

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

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

    import os.path

from google.auth.transport.requests import Request
from google.oauth2.credentials import Credentials
from google_auth_oauthlib.flow import InstalledAppFlow
from googleapiclient.discovery import build
from googleapiclient.errors import HttpError

# 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.messages.readonly"]

def main():
    '''
    Authenticates with Chat API via user credentials,
    then lists messages in a space sent after March 16, 2023.
    '''

    # 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().messages().list(

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

          # An optional filter that returns messages
          # created after March 16, 2023.
          filter = 'createTime > "2023-03-16T00:00:00-00:00"'

      ).execute()

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

if __name__ == '__main__':
    main()

  3. Ersetzen Sie im Code SPACE durch den Namen eines Gruppenbereichs, den Sie in der Chat API mit der Methode spaces.list oder aus der URL eines Gruppenbereichs abrufen können.

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

    python3 chat_messages_list.py

Die Google Chat API gibt eine Liste der Nachrichten zurück, die nach dem 16. März 2023 an den angegebenen Gruppenbereich gesendet wurden.