Nachricht aktualisieren

In dieser Anleitung wird erläutert, wie Sie mit der Methode patch für die Ressource Message der Google Chat API eine Text- oder Kartennachricht in einem Gruppenbereich aktualisieren. Aktualisieren Sie eine Nachricht, um Nachrichtenattribute wie den Inhalt oder den Inhalt einer Karte zu ändern. Du kannst einer Kartennachricht auch eine Textnachricht voranstellen oder eine Karte an eine Textnachricht anhängen.

Die Chat API unterstützt auch die Methode update. Wir empfehlen jedoch dringend, die Methode patch aufzurufen, da sie eine PATCH-HTTP-Anfrage und update eine PUT-HTTP-Anfrage verwendet. Weitere Informationen finden Sie im Abschnitt zu PATCH und PUT von AIP-134.

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 google-auth
  • 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:

    • Beim Aktualisieren einer Textnachricht werden die beiden folgenden Authentifizierungsmethoden unterstützt:
      • Mit der Nutzerauthentifizierung mit dem Autorisierungsbereich chat.messages können von diesem Nutzer erstellte Nachrichten aktualisiert werden.
      • Bei der App-Authentifizierung mit dem Autorisierungsbereich chat.bot können Nachrichten aktualisiert werden, die von dieser Anwendung erstellt wurden.
    • Zum Aktualisieren einer Kartennachricht ist eine Anwendungsauthentifizierung mit dem Autorisierungsbereich chat.bot erforderlich.

Mit Nutzerauthentifizierung eine SMS aktualisieren oder einer Kartennachricht eine Textnachricht voranstellen

Übergeben Sie in Ihrer Anfrage Folgendes, um eine Textnachricht mit der Nutzerauthentifizierung zu aktualisieren:

  • Der Autorisierungsbereich chat.messages.
  • Der name der zu aktualisierenden Nachricht.
  • updateMask='text'
  • Ein body, der die aktualisierte Nachricht angibt.

Wenn es sich bei der aktualisierten Nachricht um eine Kartennachricht handelt, wird die Textnachricht der Kartennachricht vorangestellt (die weiterhin angezeigt wird).

So kannst du mit der Nutzerauthentifizierung eine Textnachricht aktualisieren oder einer Kartennachricht eine Textnachricht voranstellen:

Python

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

  2. Fügen Sie den folgenden Code in chat_update_text_message_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"]

def main():
    '''
    Authenticates with Chat API via user credentials,
    then updates 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)

    # Update a Chat message.
    result = chat.spaces().messages().patch(

      # The message to update, and the updated message.
      #
      # 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',
      updateMask='text',
      body={'text': 'Updated 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_update_text_message_user.py

Mit App-Authentifizierung eine SMS aktualisieren oder einer Kartennachricht eine Textnachricht voranstellen

Wenn Sie eine Textnachricht mit der Anwendungsauthentifizierung aktualisieren möchten, übergeben Sie in der Anfrage Folgendes:

  • Der Autorisierungsbereich chat.bot.
  • Der name der zu aktualisierenden Nachricht.
  • updateMask='text'
  • Ein body, der die aktualisierte Nachricht angibt.

Wenn es sich bei der aktualisierten Nachricht um eine Kartennachricht handelt, wird die Textnachricht der Kartennachricht vorangestellt (die weiterhin angezeigt wird).

So aktualisierst du eine Textnachricht in eine Textnachricht oder kannst einer Kartennachricht mithilfe der App-Authentifizierung eine Textnachricht voranstellen:

Python

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

  2. Fügen Sie den folgenden Code in chat_update_text_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)

# Update a Chat message.
result = chat.spaces().messages().patch(

  # The message to update, and the updated message.
  #
  # 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',
  updateMask='text',
  body={'text': 'Updated message!'}

).execute()

# Print Chat API's response in your command line interface.
print(result)

  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_update_text_message_app.py

Kartennachricht aktualisieren oder an SMS anhängen

Übergeben Sie in Ihrer Anfrage Folgendes, um eine Kartennachricht zu aktualisieren:

  • Der Autorisierungsbereich chat.bot. Zum Aktualisieren einer Kartennachricht ist eine App-Authentifizierung erforderlich.
  • Der name der zu aktualisierenden Nachricht.
  • updateMask='cardsV2'
  • Ein body, der die aktualisierte Nachricht angibt.

Wenn es sich bei der aktualisierten Nachricht um eine Textnachricht handelt, wird eine Karte an die Textnachricht angehängt (die weiterhin angezeigt wird). Wenn die aktualisierte Meldung selbst eine Karte ist, wird die angezeigte Karte aktualisiert.

So aktualisierst du eine Nachricht in eine Kartennachricht:

Python

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

  2. Fügen Sie den folgenden Code in chat_update_card_message.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)

# Update a Chat message.
result = chat.spaces().messages().patch(

  # The message to update, and the updated message.
  #
  # 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',
  updateMask='cardsV2',
  body=
  {
    'cardsV2': [{
      'cardId': 'updateCardMessage',
      'card': {
        'header': {
          'title': 'An Updated Card Message!',
          'subtitle': 'Updated with Chat REST API',
          'imageUrl': 'https://developers.google.com/chat/images/chat-product-icon.png',
          'imageType': 'CIRCLE'
        },
        'sections': [
          {
            'widgets': [
              {
                'buttonList': {
                  'buttons': [
                    {
                      'text': 'Read the docs!',
                      'onClick': {
                        'openLink': {
                          'url': 'https://developers.google.com/chat'
                        }
                      }
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
    }]
  }

).execute()

# Print Chat API's response in your command line interface.
print(result)

  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_update_card_message.py

Die Chat API gibt eine Instanz von Message zurück, in der die aktualisierte Nachricht angegeben ist.

Nachricht mit mehreren Feldpfaden gleichzeitig aktualisieren

Wenn eine Nachricht aktualisiert wird, können Sie mehrere Nachrichtenfeldpfade gleichzeitig aktualisieren. Beispielsweise können Sie in einer Anfrage für eine Aktualisierungsnachricht gleichzeitig eine Änderung an den Feldpfaden text und cardsv2 angeben, wodurch sowohl der Text der Nachricht als auch die Karte aktualisiert werden. Wenn die Nachricht nur Text und keine Karte enthält, wird ihr eine Karte hinzugefügt. Weitere Informationen zu den unterstützten Feldpfaden finden Sie unter updateMask-Parameter.

Um sowohl den text als auch den card einer Nachricht mit Nutzerauthentifizierung zu aktualisieren, übergeben Sie in Ihrer Anfrage Folgendes:

  • Der Autorisierungsbereich chat.messages.
  • Der name der zu aktualisierenden Nachricht.

  • Ein updateMask, der die zu aktualisierenden Nachrichtenfeldpfade angibt, getrennt durch Kommas: updateMask='text', 'cardsV2'.

  • Ein body, der die aktualisierte Nachricht einschließlich aller aktualisierten Feldpfade angibt.

So aktualisieren Sie die Feldpfade text und cardsV2 in einer Nachricht mit der Nutzerauthentifizierung:

Python

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

  2. Fügen Sie den folgenden Code in chat_update_text_message_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"]

def main():
    '''
    Authenticates with Chat API via user credentials,
    then updates 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)

    # Update a Chat message.
    result = chat.spaces().messages().patch(

      # The message to update, and the updated message.
      #
      # 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',
      updateMask='text,cardsV2',
      body=
      {'text': 'Updated message!',
            'cardsV2': [{
              'cardId': 'updateCardMessage',
              'card': {
                'header': {
                  'title': 'An Updated Card Message!',
                  'subtitle': 'Updated with Chat REST API',
                  'imageUrl': 'https://developers.google.com/chat/images/chat-product-icon.png',
                  'imageType': 'CIRCLE'
                },
                'sections': [
                  {
                    'widgets': [
                      {
                        'buttonList': {
                          'buttons': [
                            {
                              'text': 'Read the docs!',
                              'onClick': {
                                'openLink': {
                                  'url': 'https://developers.google.com/chat'
                                }
                              }
                            }
                          ]
                        }
                      }
                    ]
                  }
                ]
              }
            }]
      }

    ).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_update_text_message_user.py