In diesem Leitfaden wird beschrieben, wie Sie die Methode patch()
für die Space
-Ressource der Google Chat API verwenden, um einen Gruppenbereich zu aktualisieren. Sie können einen Gruppenbereich aktualisieren, um Attribute wie den für Nutzer sichtbaren Anzeigenamen, die Beschreibung und die Richtlinien zu ändern.
Wenn Sie Google Workspace-Administrator sind, können Sie die Methode patch()
aufrufen, um einen vorhandenen Gruppenbereich in Ihrer Google Workspace-Organisation zu aktualisieren.
Die Ressource Space
ist ein Ort, an dem Nutzer und Chat-Apps Nachrichten senden, Dateien teilen und zusammenarbeiten können. Es gibt verschiedene Arten von Gruppenbereichen:
- Direktnachrichten sind Unterhaltungen zwischen zwei Nutzern oder einem Nutzer und einer Chat-App.
- Gruppenchats sind Unterhaltungen zwischen drei oder mehr Nutzern und Chat-Apps.
- Namensgruppenbereiche sind persistente Orte, an denen Nutzer Nachrichten senden, Dateien teilen und zusammenarbeiten können.
Vorbereitung
Node.js
- Ein Business- oder Enterprise Google Workspace-Konto mit Zugriff auf Google Chat.
- 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, Symbol und einer Beschreibung für Ihre Chat-App.
- Installieren Sie die Node.js-Cloud-Clientbibliothek.
-
OAuth-Client-ID-Anmeldedaten für eine Desktopanwendung erstellen Wenn Sie das Beispiel in dieser Anleitung ausführen möchten, speichern Sie die Anmeldedaten als JSON-Datei mit dem Namen
client_secrets.json
in Ihrem lokalen Verzeichnis.
- Wählen Sie einen Autorisierungsbereich aus, der die Nutzerauthentifizierung unterstützt.
- Einen Google Chat-Bereich Informationen zum Erstellen mit der Google Chat API finden Sie unter Gruppenbereich erstellen. Informationen zum Erstellen eines Kontos in Google Chat finden Sie in der Google Chat-Hilfe.
Python
- Ein Business- oder Enterprise Google Workspace-Konto mit Zugriff auf Google Chat.
- 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, einem Symbol und einer Beschreibung für Ihre Chat-App.
- Installieren Sie die Cloud-Clientbibliothek für Python.
-
OAuth-Client-ID-Anmeldedaten für eine Desktopanwendung erstellen Wenn Sie das Beispiel in dieser Anleitung ausführen möchten, speichern Sie die Anmeldedaten als JSON-Datei mit dem Namen
client_secrets.json
in Ihrem lokalen Verzeichnis.
- Wählen Sie einen Autorisierungsbereich aus, der die Nutzerauthentifizierung unterstützt.
- Einen Google Chat-Bereich Informationen zum Erstellen mit der Google Chat API finden Sie unter Gruppenbereich erstellen. Eine Anleitung zum Erstellen in Google Chat finden Sie in der Hilfe.
Java
- Ein Google Workspace-Konto für Unternehmen oder Organisationen mit Zugriff auf Google Chat.
- 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, einem Symbol und einer Beschreibung für Ihre Chat-App.
- Installieren Sie die Java-Cloud-Clientbibliothek.
-
Erstellen Sie OAuth-Client-ID-Anmeldedaten für eine Desktopanwendung. Wenn Sie das Beispiel in dieser Anleitung ausführen möchten, speichern Sie die Anmeldedaten als JSON-Datei mit dem Namen
client_secrets.json
in Ihrem lokalen Verzeichnis.
- Wählen Sie einen Autorisierungsbereich aus, der die Nutzerauthentifizierung unterstützt.
- Ein Google Chat-Bereich Informationen zum Erstellen mit der Google Chat API finden Sie unter Gruppenbereich erstellen. Eine Anleitung zum Erstellen in Google Chat finden Sie in der Hilfe.
Apps Script
- Ein Google Workspace-Konto für Unternehmen oder Organisationen mit Zugriff auf Google Chat.
- 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, einem Symbol und einer Beschreibung für Ihre Chat-App.
- Erstellen Sie ein eigenständiges Apps Script-Projekt und aktivieren Sie den erweiterten Chatdienst.
- Wählen Sie einen Autorisierungsbereich aus, der die Nutzerauthentifizierung unterstützt.
- Einen Google Chat-Bereich Informationen zum Erstellen mit der Google Chat API finden Sie unter Gruppenbereich erstellen. Eine Anleitung zum Erstellen in Google Chat finden Sie in der Hilfe.
Gruppenbereich als Nutzer aktualisieren
Wenn Sie einen vorhandenen Gruppenbereich in Google Chat mit Nutzerauthentifizierung aktualisieren möchten, geben Sie Folgendes in Ihrer Anfrage an:
- Geben Sie den Autorisierungsbereich für
chat.spaces
an. - Rufen Sie die Methode
UpdateSpace()
auf. Geben Sie in Ihrer Anfrage das Feldname
für den Gruppenbereich, das FeldupdateMask
mit einem oder mehreren zu aktualisierenden Feldern und einbody
mit den aktualisierten Informationen zum Gruppenbereich an.
Sie können u. a. den Anzeigenamen, den Gruppenbereichstyp und den Verlaufsstatus aktualisieren. Eine vollständige Liste der Felder, die Sie aktualisieren können, finden Sie in der Referenzdokumentation.
So aktualisieren Sie das Feld displayName
eines vorhandenen Gruppenbereichs:
Node.js
Python
Java
Apps Script
Wenn Sie dieses Beispiel ausführen möchten, ersetzen Sie SPACE_NAME
durch die ID aus dem Feld name
des Gruppenbereichs. Sie erhalten die ID durch Aufrufen der Methode ListSpaces()
oder über die URL des Bereichs.
Die Google Chat API gibt eine Instanz von Space
zurück, die die Aktualisierungen widerspiegelt.
Gruppenbereich als Google Workspace-Administrator aktualisieren
Wenn Sie Google Workspace-Administrator sind, können Sie die Methode UpdateSpace()
aufrufen, um einen beliebigen Gruppenbereich in Ihrer Google Workspace-Organisation zu aktualisieren.
So rufen Sie diese Methode als Google Workspace-Administrator auf:
- Rufen Sie die Methode mit Nutzerauthentifizierung auf und geben Sie einen Autorisierungsbereich an, der den Aufruf der Methode mit Administratorberechtigungen unterstützt.
- Geben Sie in Ihrer Anfrage den Abfrageparameter
useAdminAccess
antrue
.
Weitere Informationen und Beispiele finden Sie unter Google Chat-Gruppenbereiche als Google Workspace-Administrator verwalten.
Gruppenbereich als Chat-App aktualisieren
Für die App-Authentifizierung ist eine einmalige Administratorgenehmigung erforderlich.
Wenn Sie einen vorhandenen Gruppenbereich in Google Chat mit der App-Authentifizierung aktualisieren möchten, geben Sie Folgendes in Ihrer Anfrage an:
- Geben Sie den Autorisierungsbereich
chat.app.spaces
an. Bei der App-Authentifizierung können Sie nur Gruppenbereiche aktualisieren, die von Chat-Apps erstellt wurden. - Rufen Sie die Methode
patch
für die RessourceSpace
auf. Geben Sie in Ihrer Anfrage das Feld „name
“ für den Gruppenbereich, das Feld „updateMask
“ mit einem oder mehreren zu aktualisierenden Feldern und ein „body
“ mit den aktualisierten Informationen zum Gruppenbereich an.
Sie können unter anderem den Anzeigenamen, den Space-Typ, den Verlaufsstatus und die Berechtigungseinstellungen aktualisieren. Eine vollständige Liste der Felder, die Sie aktualisieren können, finden Sie in der Referenzdokumentation.
API-Schlüssel erstellen
Wenn Sie eine API-Methode der Entwicklervorschau aufrufen möchten, müssen Sie eine nicht öffentliche Entwicklervorschauversion des API-Discovery-Dokuments verwenden. Zum Authentifizieren der Anfrage müssen Sie einen API-Schlüssel übergeben.
Öffnen Sie zum Erstellen des API-Schlüssels das Google Cloud-Projekt Ihrer App und führen Sie die folgenden Schritte aus:
- Öffnen Sie in der Google Cloud Console das Dreistrich-Menü > APIs und Dienste > Anmeldedaten.
- Klicken Sie auf Anmeldedaten erstellen > API-Schlüssel.
- Ihr neuer API-Schlüssel wird angezeigt.
- Klicken Sie auf „Kopieren“ , um den API-Schlüssel zur Verwendung im Code Ihrer App zu kopieren. Den API-Schlüssel finden Sie auch im Bereich „API-Schlüssel“ der Anmeldedaten Ihres Projekts.
- Klicken Sie auf Schlüssel einschränken, um die erweiterten Einstellungen zu aktualisieren und die Verwendung Ihres API-Schlüssels einzuschränken. Weitere Informationen finden Sie unter Einschränkungen für API-Schlüssel anwenden.
Script zum Aufrufen der Chat API schreiben
So aktualisieren Sie das Feld spaceDetails
eines vorhandenen Gruppenbereichs:
Python
- Erstellen Sie in Ihrem Arbeitsverzeichnis eine Datei mit dem Namen
chat_space_update_app.py
. Fügen Sie den folgenden Code in
chat_space_update_app.py
ein: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.spaces"] def main(): ''' Authenticates with Chat API using app authentication, then updates the specified space description and guidelines. ''' # 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, discoveryServiceUrl='https://chat.googleapis.com/$discovery/rest?version=v1&labels=DEVELOPER_PREVIEW&key=API_KEY') # Use the service endpoint to call Chat API. result = chat.spaces().patch( # The space to update, and the updated space details. # # Replace {space} with a space name. # Obtain the space name from the spaces resource of Chat API, # or from a space's URL. name='spaces/SPACE', updateMask='spaceDetails', body={ 'spaceDetails': { 'description': 'This description was updated with Chat API!', 'guidelines': 'These guidelines were updated with Chat API!' } } ).execute() # Prints details about the updated space. print(result) if __name__ == '__main__': main()
Ersetzen Sie im Code Folgendes:
API_KEY
: API-Schlüssel, den Sie zum Erstellen des Dienstendpunkts für die Chat API erstellt haben.SPACE
durch einen Namen für den Gruppenbereich, den Sie über die Methodespaces.list
in der Chat API oder über die URL eines Gruppenbereichs abrufen können.
Erstellen und führen Sie das Beispiel in Ihrem Arbeitsverzeichnis aus:
python3 chat_space_update_app.py
Die Google Chat API gibt eine Instanz der Ressource Space
zurück, die die Aktualisierungen widerspiegelt.
Weitere Informationen
- Details zu einem Gruppenbereich abrufen
- Gruppenbereiche auflisten
- Gruppenbereich löschen
- Richten Sie einen Gruppenbereich ein.
- Suchen Sie einen Gruppenbereich für Direktnachrichten.
- Sie können einen Gruppenbereich für bestimmte Nutzer sichtbar machen.