Details zu einer Nachricht abrufen

In dieser Anleitung wird erläutert, wie Sie die Methode get für die Ressource Message der Google Chat API verwenden, um Details zu einer Text- oder Kartennachricht zurückzugeben.

Die Ressource Message stellt eine Textnachricht oder eine Kartennachricht in Google Chat dar. Sie können eine Nachricht in der Google Chat API create, get, update oder delete senden, indem Sie die entsprechenden Methoden aufrufen. Weitere Informationen zu Text- und Kartennachrichten finden Sie unter Nachrichten in Google Chat.

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. Das Abrufen einer Nachricht unterstützt beide Authentifizierungsmethoden:

    • Mit der Nutzerauthentifizierung mit dem Autorisierungsbereich chat.messages.readonly oder chat.messages können Nachrichten abgerufen werden, auf die der Nutzer Zugriff hat.
    • Die App-Authentifizierung mit dem Autorisierungsbereich chat.bot kann Nachrichten abrufen, die an die Anwendung gesendet wurden.

Nachricht mit Nutzerauthentifizierung abrufen

Wenn Sie Details zu einer Nachricht mit der Nutzerauthentifizierung abrufen möchten, übergeben Sie in der Anfrage Folgendes:

  • Geben Sie den Autorisierungsbereich chat.messages.readonly oder chat.messages an.
  • Rufen Sie die Methode get für die Ressource Message auf.
  • Legen Sie für name den Ressourcennamen der abzurufenden Nachricht fest.

Im folgenden Beispiel wird eine Nachricht mit Nutzerauthentifizierung abgerufen:

Python

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

  2. 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 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.
    • MESSAGE: ein Nachrichtenname, den Sie aus dem Antworttext abrufen können, der zurückgegeben wurde, nachdem eine Nachricht asynchron mit der Chat API erstellt wurde, oder mit dem benutzerdefinierten Namen, der der Nachricht bei der Erstellung zugewiesen wurde.

  4. 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 zurück, die die angegebene Nachricht detailliert beschreibt.

Nachricht mit App-Authentifizierung erhalten

Wenn Sie Details zu einer Nachricht mit der Anwendungsauthentifizierung abrufen möchten, übergeben Sie in der Anfrage Folgendes:

  • Geben Sie den Autorisierungsbereich chat.bot an.
  • Rufen Sie die Methode get für die Ressource Message auf.
  • Legen Sie für name den Ressourcennamen der abzurufenden Nachricht fest.

Im folgenden Beispiel wird eine Nachricht mit App-Authentifizierung abgerufen:

Python

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

  2. 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)

  3. Ersetzen Sie im Code Folgendes:

    • SPACE: name des Gruppenbereichs, in dem die Nachricht gepostet wird. Sie können den Wert über die spaces.list-Methode in der Chat API oder über die URL eines Gruppenbereichs abrufen.

    • MESSAGE: der Nachrichtenname, den Sie aus dem Antworttext abrufen können, der zurückgegeben wurde, nachdem eine Nachricht asynchron mit der Chat API erstellt wurde, oder mit dem benutzerdefinierten Namen, der der Nachricht bei der Erstellung zugewiesen wurde.

  4. 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 zurück, die die angegebene Nachricht detailliert beschreibt.