Method: spaces.patch

Aktualisiert einen Gruppenbereich. Ein Beispiel finden Sie unter Bereich aktualisieren.

Wenn Sie das Feld displayName aktualisieren und die Fehlermeldung ALREADY_EXISTS erhalten, versuchen Sie es mit einem anderen Anzeigenamen. Möglicherweise wird dieser Anzeigename bereits für einen vorhandenen Gruppenbereich in der Google Workspace-Organisation verwendet.

Unterstützt die folgenden Arten der Authentifizierung:

  • App-Authentifizierung mit Administratorgenehmigung und einem der folgenden Autorisierungsbereiche:

    • https://www.googleapis.com/auth/chat.app.spaces

  • Nutzerauthentifizierung mit einem der folgenden Autorisierungsbereiche:

    • https://www.googleapis.com/auth/chat.spaces
    • https://www.googleapis.com/auth/chat.import (nur Gruppenbereiche im Importmodus)
    • Bei der Nutzerauthentifizierung werden Administratorberechtigungen erteilt, wenn ein Administratorkonto authentifiziert wird, useAdminAccess gleich true ist und die folgenden Autorisierungsbereiche verwendet werden:
      • https://www.googleapis.com/auth/chat.admin.spaces

Für die App-Authentifizierung gelten die folgenden Einschränkungen:

  • Um space.predefined_permission_settings oder space.permission_settings zu aktualisieren, muss die App der Ersteller des Gruppenbereichs sein.
  • Das Aktualisieren der space.access_settings.audience wird für die App-Authentifizierung nicht unterstützt.

HTTP-Anfrage

PATCH https://chat.googleapis.com/v1/{space.name=spaces/*}

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
space.name

string

Kennung. Ressourcenname des Bereichs.

Format: spaces/{space}

Dabei steht {space} für die vom System zugewiesene ID für den Bereich. Sie können die Gruppenbereichs-ID abrufen, indem Sie die Methode spaces.list() aufrufen oder die Gruppenbereichs-URL verwenden. Wenn die URL des Bereichs beispielsweise https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA lautet, ist die Bereichs-ID AAAAAAAAA.

Abfrageparameter

Parameter
updateMask

string (FieldMask format)

Erforderlich. Die aktualisierten Feldpfade, durch Kommas getrennt, falls es mehrere gibt.

Sie können die folgenden Felder für einen Bereich aktualisieren:

spaceDetails: Aktualisiert die Beschreibung des Gruppenbereichs. Unterstützt bis zu 150 Zeichen.

displayName: Nur das Aktualisieren des Anzeigenamens für Bereiche wird unterstützt, in denen das Feld spaceType SPACE ist. Wenn Sie die Fehlermeldung ALREADY_EXISTS erhalten, versuchen Sie es mit einem anderen Wert. Möglicherweise wird dieser Anzeigename bereits für einen vorhandenen Gruppenbereich in der Google Workspace-Organisation verwendet.

spaceType: Es wird nur das Ändern eines GROUP_CHAT-Bereichstyps in SPACE unterstützt. Nehmen Sie displayName zusammen mit spaceType in die Aktualisierungsmaske auf und achten Sie darauf, dass der angegebene Space einen nicht leeren Anzeigenamen und den Space-Typ SPACE hat. Das Einbeziehen der spaceType-Maske und des SPACE-Typs im angegebenen Bereich beim Aktualisieren des Anzeigenamens ist optional, wenn der vorhandene Bereich bereits den SPACE-Typ hat. Wenn Sie versuchen, den Bereichstyp auf andere Weise zu aktualisieren, wird ein Fehler wegen eines ungültigen Arguments ausgegeben. spaceType wird mit useAdminAccess nicht unterstützt.

spaceHistoryState: Aktualisiert die Einstellungen für den Gruppenbereichsverlauf, indem der Verlauf für den Gruppenbereich aktiviert oder deaktiviert wird. Wird nur unterstützt, wenn die Verlaufseinstellungen für die Google Workspace-Organisation aktiviert sind. Wenn Sie den Status des Gruppenbereichs aktualisieren möchten, müssen Sie alle anderen Feldmasken in Ihrer Anfrage weglassen. spaceHistoryState wird mit useAdminAccess nicht unterstützt.

accessSettings.audience: Aktualisiert die Zugriffseinstellung für die Nutzer, die den benannten Gruppenbereich finden, ihm beitreten und die Nachrichten darin ansehen können, wenn das Feld spaceType den Wert SPACE hat. Wenn der vorhandene Gruppenbereich eine Zielgruppe hat, können Sie sie entfernen und den Zugriff auf den Gruppenbereich einschränken, indem Sie keinen Wert für diese Feldmaske angeben. Wenn Sie die Zugriffseinstellungen für einen Bereich aktualisieren möchten, muss der authentifizierende Nutzer ein Bereichsmanager sein und alle anderen Feldmasken in Ihrer Anfrage weglassen. Sie können dieses Feld nicht aktualisieren, wenn sich der Bereich im Importmodus befindet. Weitere Informationen finden Sie unter Projektbereich für bestimmte Nutzer auffindbar machen. accessSettings.audience wird mit useAdminAccess nicht unterstützt.

permissionSettings: Unterstützt das Ändern der Berechtigungseinstellungen eines Bereichs. Beim Aktualisieren von Berechtigungseinstellungen können Sie nur permissionSettings-Feldmasken angeben. Andere Feldmasken können nicht gleichzeitig aktualisiert werden. permissionSettings wird mit useAdminAccess nicht unterstützt. Die unterstützten Feldmasken sind:

  • permissionSettings.manageMembersAndGroups
  • permissionSettings.modifySpaceDetails
  • permissionSettings.toggleHistory
  • permissionSettings.useAtMentionAll
  • permissionSettings.manageApps
  • permissionSettings.manageWebhooks
  • permissionSettings.replyMessages
useAdminAccess

boolean

Optional. Wenn true, wird die Methode mit den Administratorberechtigungen des Google Workspace-Nutzers ausgeführt.

Der anrufende Nutzer muss ein Google Workspace-Administrator mit der Berechtigung Unterhaltungen in Chats und Gruppenbereichen verwalten sein.

Erfordert den chat.admin.spaces OAuth 2.0-Bereich.

Einige FieldMask-Werte werden mit Administratorzugriff nicht unterstützt. Weitere Informationen finden Sie in der Beschreibung von updateMask.

Anfragetext

Der Anfragetext enthält eine Instanz von Space.

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von Space.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.spaces

Weitere Informationen finden Sie im Autorisierungsleitfaden.