Details zu einer Nachricht abrufen

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.

In der Chat API wird eine Chatnachricht durch das Message-Ressource Chat-Nutzer können zwar nur Nachrichten senden, die Text enthalten, Chat-Apps können viele andere Messaging-Funktionen nutzen, darunter Anzeige statischer oder interaktiver Benutzeroberflächen, das Erfassen von Informationen und Nachrichten privat zu übermitteln. Weitere Informationen zur Nachrichtenfunktion die für die Chat API zur Verfügung stehen, finden Sie in der Nachrichten in Google Chat

Vorbereitung

Python

Nachricht mit Nutzerauthentifizierung abrufen

Um Details zu einer Nachricht mit Nutzerauthentifizierung Übergeben Sie in Ihrer Anfrage Folgendes:

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

Im folgenden Beispiel wird eine Nachricht mit Nutzerauthentifizierung:

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 message.
        print(result)
    
    if __name__ == '__main__':
        main()
    
  3. Ersetzen Sie im Code Folgendes:

    • SPACE: ein Name für den Gruppenbereich, den Sie über die Methode spaces.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 der API benutzerdefinierter Name der Nachricht bei der Erstellung zugewiesen ist.
  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 die die jeweilige Nachricht enthält.

Nachricht mit App-Authentifizierung erhalten

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 am Message-Ressource.
  • Legen Sie name auf den Ressourcennamen der abzurufenden Nachricht fest.

Im folgenden Beispiel wird eine Nachricht mit App-Authentifizierung:

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: die name des Gruppenbereichs, in dem der veröffentlicht wird. Diesen finden Sie im spaces.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 der API benutzerdefinierter Name der Nachricht bei der Erstellung zugewiesen ist.

  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 die die jeweilige Nachricht enthält.