In dieser Anleitung wird erläutert, wie Sie die
list()
Methode für die Message Ressource der Google Chat API verwenden, um eine paginierte,
filterbare Liste von Nachrichten in einem Gruppenbereich aufzurufen.
In der Chat API wird eine Chat-Nachricht durch die
Message Ressource dargestellt.
Während Chat-Nutzer nur Nachrichten mit Text senden können, können Chat-Apps viele andere Messaging-Funktionen nutzen, darunter das Anzeigen statischer oder interaktiver Benutzeroberflächen, das Erfassen von Informationen von Nutzern und das private Senden von Nachrichten. Weitere Informationen zu den Messaging
Funktionen, die für die Chat API verfügbar sind, finden Sie in der
Übersicht zu Google Chat-Nachrichten.
Vorbereitung
Node.js
- Ein Google Workspace-Konto für Unternehmen mit Zugriff auf Google Chat.
- Umgebung einrichten:
- Google Cloud-Projekt erstellen.
- OAuth-Zustimmungsbildschirm konfigurieren.
- Aktivieren und konfigurieren Sie die Google Chat API mit einem Namen, Symbol und einer Beschreibung für Ihre Chat-App.
- Installieren Sie die Cloud-Clientbibliothek für Node.js.
- Erstellen Sie Zugriffsanmeldedaten basierend darauf, wie Sie sich in Ihrer Google Chat API
Anfrage:
- Wenn Sie sich als Chat-Nutzer authentifizieren möchten,
erstellen Sie Anmeldedaten für die OAuth-Client-ID und speichern Sie sie als JSON-Datei mit dem Namen
credentials.jsonin Ihrem lokalen Verzeichnis. - Wenn Sie sich als Chat-App authentifizieren möchten,
erstellen Sie Anmeldedaten für das Dienstkonto und speichern Sie sie als JSON-Datei mit dem Namen
credentials.json.
- Wenn Sie sich als Chat-Nutzer authentifizieren möchten,
erstellen Sie Anmeldedaten für die OAuth-Client-ID und speichern Sie sie als JSON-Datei mit dem Namen
- Wählen Sie einen Autorisierungsbereich aus, je nachdem, ob Sie sich als Nutzer oder als die Chat-App authentifizieren möchten.
- Ein Google Chat-Gruppenbereich. Informationen zum Erstellen eines Gruppenbereichs mit der Google Chat API finden Sie unter Gruppenbereich erstellen. Informationen zum Erstellen eines Gruppenbereichs in Chat finden Sie in der Hilfe .
Python
- Ein Google Workspace-Konto für Unternehmen mit Zugriff auf Google Chat.
- Umgebung einrichten:
- Google Cloud-Projekt erstellen.
- OAuth-Zustimmungsbildschirm konfigurieren.
- Aktivieren und konfigurieren Sie die Google Chat API mit einem Namen, Symbol und einer Beschreibung für Ihre Chat-App.
- Installieren Sie die Cloud-Clientbibliothek für Python.
- Erstellen Sie Zugriffsanmeldedaten basierend darauf, wie Sie sich in Ihrer Google Chat API
Anfrage:
- Wenn Sie sich als Chat-Nutzer authentifizieren möchten,
erstellen Sie Anmeldedaten für die OAuth-Client-ID und speichern Sie sie als JSON-Datei mit dem Namen
credentials.jsonin Ihrem lokalen Verzeichnis. - Wenn Sie sich als Chat-App authentifizieren möchten,
erstellen Sie Anmeldedaten für das Dienstkonto und speichern Sie sie als JSON-Datei mit dem Namen
credentials.json.
- Wenn Sie sich als Chat-Nutzer authentifizieren möchten,
erstellen Sie Anmeldedaten für die OAuth-Client-ID und speichern Sie sie als JSON-Datei mit dem Namen
- Wählen Sie einen Autorisierungsbereich aus, je nachdem, ob Sie sich als Nutzer oder als die Chat-App authentifizieren möchten.
- Ein Google Chat-Gruppenbereich. Informationen zum Erstellen eines Gruppenbereichs mit der Google Chat API finden Sie unter Gruppenbereich erstellen. Informationen zum Erstellen eines Gruppenbereichs in Chat finden Sie in der Hilfe .
Java
- Ein Google Workspace-Konto für Unternehmen mit Zugriff auf Google Chat.
- Umgebung einrichten:
- Google Cloud-Projekt erstellen.
- OAuth-Zustimmungsbildschirm konfigurieren.
- Aktivieren und konfigurieren Sie die Google Chat API mit einem Namen, Symbol und einer Beschreibung für Ihre Chat-App.
- Installieren Sie die Cloud-Clientbibliothek für Java.
- Erstellen Sie Zugriffsanmeldedaten basierend darauf, wie Sie sich in Ihrer Google Chat API
Anfrage:
- Wenn Sie sich als Chat-Nutzer authentifizieren möchten,
erstellen Sie Anmeldedaten für die OAuth-Client-ID und speichern Sie sie als JSON-Datei mit dem Namen
credentials.jsonin Ihrem lokalen Verzeichnis. - Wenn Sie sich als Chat-App authentifizieren möchten,
erstellen Sie Anmeldedaten für das Dienstkonto und speichern Sie sie als JSON-Datei mit dem Namen
credentials.json.
- Wenn Sie sich als Chat-Nutzer authentifizieren möchten,
erstellen Sie Anmeldedaten für die OAuth-Client-ID und speichern Sie sie als JSON-Datei mit dem Namen
- Wählen Sie einen Autorisierungsbereich aus, je nachdem, ob Sie sich als Nutzer oder als die Chat-App authentifizieren möchten.
- Ein Google Chat-Gruppenbereich. Informationen zum Erstellen eines Gruppenbereichs mit der Google Chat API finden Sie unter Gruppenbereich erstellen. Informationen zum Erstellen eines Gruppenbereichs in Chat finden Sie in der Hilfe .
Apps Script
- Ein Google Workspace-Konto für Unternehmen mit Zugriff auf Google Chat.
- Umgebung einrichten:
- Google Cloud-Projekt erstellen.
- OAuth-Zustimmungsbildschirm konfigurieren.
- Aktivieren und konfigurieren Sie die Google Chat API mit einem Namen, Symbol und einer Beschreibung für Ihre Chat-App.
- Erstellen Sie ein eigenständiges Apps Script-Projekt, und aktivieren Sie den erweiterten Chat-Dienst.
- In dieser Anleitung müssen Sie entweder die Nutzer oder die App-Authentifizierung verwenden. Wenn Sie sich als Chat-App authentifizieren möchten, erstellen Sie Anmeldedaten für das Dienstkonto. Eine Anleitung finden Sie unter Als Google Chat-App authentifizieren und autorisieren.
- Wählen Sie einen Autorisierungsbereich aus, je nachdem, ob Sie sich als Nutzer oder als die Chat-App authentifizieren möchten.
- Ein Google Chat-Gruppenbereich. Informationen zum Erstellen eines Gruppenbereichs mit der Google Chat API finden Sie unter Gruppenbereich erstellen. Informationen zum Erstellen eines Gruppenbereichs in Chat finden Sie in der Hilfe .
Nachrichten als Nutzer auflisten
Wenn Sie Nachrichten mit Nutzerauthentifizierung, auflisten möchten, übergeben Sie Folgendes in Ihrer Anfrage:
- Geben Sie den
chat.messages.readonlyoderchat.messagesAutorisierungsbereich an. - Rufen Sie die
ListMessages()Methode auf.
Im folgenden Beispiel werden Nachrichten in einem Chat-Gruppenbereich aufgelistet:
Node.js
Python
Java
Apps Script
Ersetzen Sie SPACE_NAME durch die ID aus
dem Feld
name
des Gruppenbereichs, um dieses Beispiel auszuführen. Sie können die ID abrufen, indem Sie die
ListSpaces()
Methode aufrufen oder die URL des Gruppenbereichs verwenden.
Die Chat API gibt eine
Liste der Nachrichten
zurück, die im angegebenen Gruppenbereich gesendet wurden. Wenn keine Nachrichten aus der Anfrage vorhanden sind, gibt die Chat API-Antwort ein leeres Objekt zurück. Bei Verwendung einer REST/HTTP-Schnittstelle enthält die Antwort ein leeres JSON-Objekt: {}.
Nachrichten als Chat-App auflisten
Für die App-Authentifizierung ist eine einmalige Genehmigung durch den Administrator erforderlich.
Wenn Sie Nachrichten aus einem Gruppenbereich mit App-Authentifizierung über die Chat REST API, auflisten möchten, übergeben Sie Folgendes in Ihrer Anfrage:
- Geben Sie einen der folgenden Autorisierungsbereiche an:
https://www.googleapis.com/auth/chat.app.messages.readonly
- Rufen Sie die
listMethode für diemessagesRessource auf. - Übergeben Sie den
namedes Gruppenbereichs, aus dem Nachrichten aufgelistet werden sollen.
Skript zum Aufrufen der Chat API schreiben
So listen Sie Nachrichten mit App-Authentifizierung und der Chat REST API auf:
Python
- Erstellen Sie in Ihrem Arbeitsverzeichnis eine Datei mit dem Namen
chat_messages_list_app.py. Fügen Sie den folgenden Code in
chat_messages_list_app.pyein:from google.oauth2 import service_account from apiclient.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.app.messages.readonly"] def main(): ''' Authenticates with Chat API using app authentication, then lists messages from a specified space. ''' # Specify service account details. creds = ( service_account.Credentials.from_service_account_file('credentials.json') .with_scopes(SCOPES) ) # 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 to list messages from. # # Replace SPACE_NAME with a space name. # Obtain the space name from the spaces resource of Chat API, # or from a space's URL. parent='spaces/SPACE_NAME' ).execute() # Print Chat API's response in your command line interface. print(result) if __name__ == '__main__': main()Ersetzen Sie im Code Folgendes:
SPACE_NAME: Ein Gruppenbereichsname, den Sie mit derspaces.listMethode in der Chat API oder über die URL eines Gruppenbereichs abrufen können.
Erstellen Sie das Beispiel in Ihrem Arbeitsverzeichnis und führen Sie es aus:
python3 chat_messages_list_app.py
Die Chat API gibt eine
Liste der Nachrichten
zurück, die im angegebenen Gruppenbereich gesendet wurden. Wenn keine Nachrichten aus der Anfrage vorhanden sind, gibt die Chat API-Antwort ein leeres Objekt zurück. Bei Verwendung einer REST/HTTP-Schnittstelle enthält die Antwort ein leeres JSON-Objekt: {}.
Weitere Informationen
- Nachricht formatieren.
- Nachricht löschen.
- Details zu einer Nachricht abrufen.
- Nachricht aktualisieren.
- Nachricht senden.