In diesem Leitfaden wird erläutert, wie Sie die Methode patch
für die Ressource membership
verwenden.
der Google Chat API, um Attribute einer Mitgliedschaft zu ändern, z. B.
Mitglied eines Gruppenbereichs zu einem Administrator des Gruppenbereichs oder Ändern eines Administrators des Gruppenbereichs zu einem Mitglied des Gruppenbereichs.
Die
Membership
-Ressource
gibt an, ob ein menschlicher Nutzer oder die Google Chat App
Teil eines Leerzeichens oder fehlt.
Vorbereitung
Python
- Unternehmen Google Workspace-Konto mit Zugriff auf Google Chat:
- Richten Sie Ihre Umgebung ein:
<ph type="x-smartling-placeholder">
- </ph>
- 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.
- Installieren Sie die Python Google API-Clientbibliothek
- <ph type="x-smartling-placeholder"></ph>
Erstellen Sie OAuth-Client-ID-Anmeldedaten für eine Desktopanwendung. Um das Beispiel in diesem
sollten Sie die Anmeldedaten als JSON-Datei mit dem Namen
client_secrets.json
in Ihrem lokales Verzeichnis.
- <ph type="x-smartling-placeholder"></ph> Wählen Sie einen Autorisierungsbereich aus, der die Nutzerauthentifizierung unterstützt.
Node.js
- Unternehmen Google Workspace-Konto mit Zugriff auf Google Chat:
- Richten Sie Ihre Umgebung ein:
<ph type="x-smartling-placeholder">
- </ph>
- 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.
- Installieren Sie die Node.js Google API-Clientbibliothek
- <ph type="x-smartling-placeholder"></ph>
Erstellen Sie OAuth-Client-ID-Anmeldedaten für eine Desktopanwendung. Um das Beispiel in diesem
sollten Sie die Anmeldedaten als JSON-Datei mit dem Namen
client_secrets.json
in Ihrem lokales Verzeichnis.
- <ph type="x-smartling-placeholder"></ph> Wählen Sie einen Autorisierungsbereich aus, der die Nutzerauthentifizierung unterstützt.
Apps Script
- Unternehmen Google Workspace-Konto mit Zugriff auf Google Chat:
- Richten Sie Ihre Umgebung ein:
<ph type="x-smartling-placeholder">
- </ph>
- 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.
- Eigenständiges Apps Script-Projekt erstellen und aktivieren Sie den erweiterten Chatdienst.
- <ph type="x-smartling-placeholder"></ph> Wählen Sie einen Autorisierungsbereich aus, der die Nutzerauthentifizierung unterstützt.
Mitgliedschaft aktualisieren
Wenn Sie die Mitgliedschaft in einem Gruppenbereich aktualisieren möchten, geben Sie in Ihrer Anfrage Folgendes an:
- Geben Sie den Autorisierungsbereich
chat.memberships
an. - Rufen Sie die Methode
patch
-Methode für die RessourceMembership
und übergeben Sie diename
der zu aktualisierenden Mitgliedschaft sowie einenupdateMask
undbody
, die die aktualisierten Mitgliedschaftsattribute angeben. - Mit
updateMask
werden die Aspekte der zu aktualisierenden Mitgliedschaft angegeben. umfasst Folgendes: <ph type="x-smartling-placeholder">- </ph>
role
: Die Rolle des Nutzers in einem Chatbereich, die bestimmt, welche Aktionen im Gruppenbereich. Mögliche Werte sind: <ph type="x-smartling-placeholder">- </ph>
ROLE_MEMBER
: Ein Mitglied des Gruppenbereichs. Der Nutzer verfügt über grundlegende Berechtigungen, z. B. das Senden von Nachrichten in den Gruppenbereich. In Einzelgesprächen und unbenannten Gruppen Unterhaltungen haben, haben alle diese Rolle.ROLE_MANAGER
: Administrator des Gruppenbereichs Der Nutzer verfügt über alle grundlegenden Berechtigungen plus Administratorberechtigungen, mit denen sie den Gruppenbereich verwalten können, z. B. Mitglieder entfernen Wird nur in Gruppenbereichen unterstützt, in denen „spaceType
“ den Wert „SPACE
“ hat (benannte Gruppenbereiche).
Ein normales Mitglied des Gruppenbereichs zum Administrator des Gruppenbereichs machen
Im folgenden Beispiel wird ein reguläres Mitglied des Gruppenbereichs zum Administrator des Gruppenbereichs, indem Folgendes angegeben wird:
role
als ROLE_MANAGER
in der body
, die die aktualisierte Mitgliedschaft angibt
Attribute:
Python
- Erstellen Sie in Ihrem Arbeitsverzeichnis eine Datei mit dem Namen
chat_membership_update.py
. Fügen Sie den folgenden Code in
chat_membership_update.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.memberships"] def main(): ''' Authenticates with Chat API via user credentials, then updates a specified space member to change it from a regular member to a space manager. ''' # 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().members().patch( # The membership to update, and the updated role. # # Replace SPACE with a space name. # Obtain the space name from the spaces resource of Chat API, # or from a space's URL. # # Replace MEMBERSHIP with a membership name. # Obtain the membership name from the membership of Chat API. name='spaces/SPACE/members/MEMBERSHIP', updateMask='role', body={'role': 'ROLE_MANAGER'} ).execute() # Prints details about the updated membership. print(result) if __name__ == '__main__': main()
Ersetzen Sie im Code Folgendes:
SPACE
: ein Name für den Gruppenbereich, der erhalten Sie in der Methodespaces.list
in der Chat API oder über die URL eines Gruppenbereichs.MEMBERSHIP
: ein Mitgliedsname, der erhalten Sie in der Methodespaces.members.list
in der Chat API.
Erstellen Sie das Beispiel in Ihrem Arbeitsverzeichnis und führen Sie es aus:
python3 chat_membership_update.py
Node.js
- Erstellen Sie in Ihrem Arbeitsverzeichnis eine Datei mit dem Namen
chat_membership_update.js
. Fügen Sie den folgenden Code in
chat_membership_update.js
ein:const chat = require('@googleapis/chat'); const {authenticate} = require('@google-cloud/local-auth'); /** * Updates a membership in a Chat space to change it from * a space member to a space manager. * @return {!Promise<!Object>} */ async function updateSpace() { /** * Authenticate with Google Workspace * and get user authorization. */ const scopes = [ 'https://www.googleapis.com/auth/chat.memberships', ]; const authClient = await authenticate({scopes, keyfilePath: 'client_secrets.json'}); /** * Build a service endpoint for Chat API. */ const chatClient = await chat.chat({version: 'v1', auth: authClient}); /** * Use the service endpoint to call Chat API. */ return await chatClient.spaces.patch({ /** * The membership to update, and the updated role. * * Replace SPACE with a space name. * Obtain the space name from the spaces resource of Chat API, * or from a space's URL. * * Replace MEMBERSHIP with a membership name. * Obtain the membership name from the membership of Chat API. */ name: 'spaces/SPACE/members/MEMBERSHIP', updateMask: 'role', requestBody: { role: 'ROLE_MANAGER' } }); } /** * Use the service endpoint to call Chat API. */ updateSpace().then(console.log);
Ersetzen Sie im Code Folgendes:
SPACE
: ein Name für den Gruppenbereich, der erhalten Sie in der Methodespaces.list
in der Chat API oder über die URL eines Gruppenbereichs.MEMBERSHIP
: ein Mitgliedsname, der erhalten Sie in der Methodespaces.members.list
in der Chat API.
Erstellen Sie das Beispiel in Ihrem Arbeitsverzeichnis und führen Sie es aus:
python3 chat_membership_update.js
Apps Script
In diesem Beispiel wird die Chat API mit dem Erweiterter Chat-Dienst:
Fügen Sie den Autorisierungsbereich
chat.memberships
zum Dateiappsscript.json
des Apps Script-Projekts:"oauthScopes": [ "https://www.googleapis.com/auth/chat.memberships" ]
Fügen Sie dem Apps Script-Projekt eine Funktion wie diese Code:
/** * Updates a membership from space member to space manager. * @param {string} memberName The resource name of the membership. */ function updateMembershipToSpaceManager(memberName) { try { const body = {'role': 'ROLE_MANAGER'}; Chat.Spaces.Members.patch(memberName, body); } catch (err) { // TODO (developer) - Handle exception console.log('Failed to create message with error %s', err.message); } }
Die Google Chat API ändert die angegebene Mitgliedschaft in einen Administrator des Gruppenbereichs und gibt
eine Instanz von Membership
in der die Änderung detailliert erläutert wird.
Administrator eines Gruppenbereichs zu einem regulären Mitglied machen
Im folgenden Beispiel wird ein Administrator eines Gruppenbereichs zu einem regulären Mitglied, indem er Folgendes angibt:
role
als ROLE_MEMBER
in der body
, die die aktualisierte Mitgliedschaft angibt
Attribute:
Python
- Erstellen Sie in Ihrem Arbeitsverzeichnis eine Datei mit dem Namen
chat_membership_update.py
. Fügen Sie den folgenden Code in
chat_membership_update.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.memberships"] def main(): ''' Authenticates with Chat API via user credentials, then updates a specified space member to change it from a regular member to a space manager. ''' # 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().members().patch( # The membership to update, and the updated role. # # Replace SPACE with a space name. # Obtain the space name from the spaces resource of Chat API, # or from a space's URL. # # Replace MEMBERSHIP with a membership name. # Obtain the membership name from the membership of Chat API. name='spaces/SPACE/members/MEMBERSHIP', updateMask='role', body={'role': 'ROLE_MEMBER'} ).execute() # Prints details about the updated membership. print(result) if __name__ == '__main__': main()
Ersetzen Sie im Code Folgendes:
SPACE
: ein Name für den Gruppenbereich, der erhalten Sie in der Methodespaces.list
in der Chat API oder über die URL eines Gruppenbereichs.MEMBERSHIP
: ein Mitgliedsname, der erhalten Sie in der Methodespaces.members.list
in der Chat API.
Erstellen Sie das Beispiel in Ihrem Arbeitsverzeichnis und führen Sie es aus:
python3 chat_membership_update.py
Node.js
- Erstellen Sie in Ihrem Arbeitsverzeichnis eine Datei mit dem Namen
chat_membership_update.js
. Fügen Sie den folgenden Code in
chat_membership_update.js
ein:const chat = require('@googleapis/chat'); const {authenticate} = require('@google-cloud/local-auth'); /** * Updates a membership in a Chat space to change it from * a space manager to a space member. * @return {!Promise<!Object>} */ async function updateSpace() { /** * Authenticate with Google Workspace * and get user authorization. */ const scopes = [ 'https://www.googleapis.com/auth/chat.memberships', ]; const authClient = await authenticate({scopes, keyfilePath: 'client_secrets.json'}); /** * Build a service endpoint for Chat API. */ const chatClient = await chat.chat({version: 'v1', auth: authClient}); /** * Use the service endpoint to call Chat API. */ return await chatClient.spaces.patch({ /** * The membership to update, and the updated role. * * Replace SPACE with a space name. * Obtain the space name from the spaces resource of Chat API, * or from a space's URL. * * Replace MEMBERSHIP with a membership name. * Obtain the membership name from the membership of Chat API. */ name: 'spaces/SPACE/members/MEMBERSHIP', updateMask: 'role', requestBody: { role: 'ROLE_MEMBER' } }); } /** * Use the service endpoint to call Chat API. */ updateSpace().then(console.log);
Ersetzen Sie im Code Folgendes:
SPACE
: ein Name für den Gruppenbereich, der erhalten Sie in der Methodespaces.list
in der Chat API oder über die URL eines Gruppenbereichs.MEMBERSHIP
: ein Mitgliedsname, der erhalten Sie in der Methodespaces.members.list
in der Chat API.
Erstellen Sie das Beispiel in Ihrem Arbeitsverzeichnis und führen Sie es aus:
python3 chat_membership_update.js
Apps Script
In diesem Beispiel wird die Chat API mit dem Erweiterter Chat-Dienst:
Fügen Sie den Autorisierungsbereich
chat.memberships
zum Dateiappsscript.json
des Apps Script-Projekts:"oauthScopes": [ "https://www.googleapis.com/auth/chat.memberships" ]
Fügen Sie dem Apps Script-Projekt eine Funktion wie diese Code:
/** * Updates a membership from space manager to space member. * @param {string} memberName The resource name of the membership. */ function updateMembershipToSpaceMember(memberName) { try { const body = {'role': 'ROLE_MEMBER'}; Chat.Spaces.Members.patch(memberName, body); } catch (err) { // TODO (developer) - Handle exception console.log('Failed to create message with error %s', err.message); } }
Die Google Chat API ändert die angegebene Mitgliedschaft in einen Administrator des Gruppenbereichs und gibt
eine Instanz von Membership
eine detaillierte Beschreibung der Änderung.
Weitere Informationen
- Nutzer oder eine Google Chat App in einen Gruppenbereich einladen oder hinzufügen
- Details zur Mitgliedschaft eines Nutzers oder einer Chat-App abrufen
- Mitglieder in einem Gruppenbereich auflisten
- Einen Nutzer oder eine Chat-App aus einem Gruppenbereich entfernen