In diesem Leitfaden wird erläutert, wie Sie die Methode get
für die Ressource Message
von
die Google Chat API verwenden, um Details zu einer Text- oder Kartennachricht zurückzugeben.
Die
Message
-Ressource
steht für ein
Text
oder
Karte
in Google Chat. Sie können
create
, get
, update
oder delete
eine Nachricht in der Google Chat API durch den Aufruf von
entsprechenden Methoden. Weitere Informationen zu Text- und Kartennachrichten finden Sie unter
Nachrichten in Google Chat
Vorbereitung
Python
- Unternehmen Google Workspace-Konto mit Zugriff auf Google Chat:
- Python 3.6 oder höher
- Paketverwaltungstool pip
- Die neuesten Google-Clientbibliotheken So installieren oder aktualisieren Sie sie:
Führen Sie in der Befehlszeile den folgenden Befehl aus:
pip3 install --upgrade google-api-python-client google-auth-oauthlib
- Richten Sie Ihre Umgebung ein:
- Google Cloud-Projekt erstellen
- Konfigurieren Sie den OAuth-Zustimmungsbildschirm.
- Aktivieren und konfigurieren Sie die Google Chat API mit einem Namen, und eine Beschreibung der Chat App.
- Erstellen Sie Anmeldedaten für den Zugriff entsprechend der Authentifizierung in Ihrer Google Chat API-Anfrage:
- So authentifizieren Sie sich als Chat-Nutzer:
OAuth-Client-ID erstellen
Anmeldedaten und speichern Sie die Anmeldedaten als JSON-Datei mit dem Namen
client_secrets.json
in Ihr lokales Verzeichnis. - So authentifizieren Sie sich als Chat-App: Dienstkonto erstellen Anmeldedaten
- So authentifizieren Sie sich als Chat-Nutzer:
OAuth-Client-ID erstellen
Anmeldedaten und speichern Sie die Anmeldedaten als JSON-Datei mit dem Namen
- Wählen Sie einen Autorisierungsbereich aus, je nachdem, ob Sie sich als Nutzer oder als Chat-App.
Nachricht mit Nutzerauthentifizierung abrufen
Um Details zu einer Nachricht mit Nutzerauthentifizierung Übergeben Sie in Ihrer Anfrage Folgendes:
- Geben Sie den Autorisierungsbereich
chat.messages.readonly
oderchat.messages
an. - Rufen Sie die Methode
get
-Methode amMessage
-Ressource. - Legen Sie
name
auf den Ressourcennamen der abzurufenden Nachricht fest.
Im folgenden Beispiel wird eine Nachricht mit Nutzerauthentifizierung:
Python
- Erstellen Sie in Ihrem Arbeitsverzeichnis eine Datei mit dem Namen
chat_message_get_user.py
. Fügen Sie den folgenden Code in
chat_message_get_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.messages.readonly"] def main(): ''' Authenticates with Chat API via user credentials, then gets a message. ''' # 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().get( # The message 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 MESSAGE with a message name. # Obtain the message name from the response body returned # after creating a message asynchronously with Chat REST API. name = 'spaces/SPACE/messages/MESSAGE' ).execute() # Prints details about the message. print(result) if __name__ == '__main__': main()
Ersetzen Sie im Code Folgendes:
SPACE
: ein Name für den Gruppenbereich, den Sie über die Methodespaces.list
in der Chat API oder über die URL eines Gruppenbereichs.MESSAGE
: ein Nachrichtenname, den Sie abrufen können aus dem Antworttext, der nach dem asynchronen Erstellen einer Nachricht zurückgegeben wurde mit der Chat API oder mit der benutzerdefinierter Name der Nachricht bei der Erstellung zugewiesen ist.
Erstellen Sie das Beispiel in Ihrem Arbeitsverzeichnis und führen Sie es aus:
python3 chat_message_get_user.py
Die Chat API gibt eine Instanz von
Message
die die jeweilige Nachricht enthält.
Nachricht mit App-Authentifizierung abrufen
Um Details zu einer Nachricht mit App-Authentifizierung Übergeben Sie in Ihrer Anfrage Folgendes:
- Geben Sie den Autorisierungsbereich
chat.bot
an. - Rufen Sie die Methode
get
-Methode amMessage
-Ressource. - Legen Sie
name
auf den Ressourcennamen der abzurufenden Nachricht fest.
Im folgenden Beispiel wird eine Nachricht mit App-Authentifizierung:
Python
- Erstellen Sie in Ihrem Arbeitsverzeichnis eine Datei mit dem Namen
chat_get_message_app.py
. Fügen Sie den folgenden Code in
chat_get_message_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) # Get a Chat message. result = chat.spaces().messages().get( # The message 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 MESSAGE with a message name. # Obtain the message name from the response body returned # after creating a message asynchronously with Chat REST API. name='spaces/SPACE/messages/MESSAGE' ).execute() # Print Chat API's response in your command line interface. print(result)
Ersetzen Sie im Code Folgendes:
SPACE
:name
des Gruppenbereichs, in dem der veröffentlicht wird. Diesen finden Sie imspaces.list
-Methode in der Chat API oder über die URL eines Gruppenbereichs.MESSAGE
: der Name der Nachricht, den Sie abrufen können aus dem Antworttext, der nach dem asynchronen Erstellen einer Nachricht zurückgegeben wurde mit der Chat API oder mit der benutzerdefinierter Name der Nachricht bei der Erstellung zugewiesen ist.
Erstellen Sie das Beispiel in Ihrem Arbeitsverzeichnis und führen Sie es aus:
python3 chat_get_message_app.py
Die Chat API gibt eine Instanz von
Message
die die jeweilige Nachricht enthält.
Weitere Informationen
- Nachricht formatieren
- Nachricht löschen
- Nachrichten in einem Gruppenbereich auflisten
- Nachricht aktualisieren
- Nachricht senden: