Method: spaces.patch

Aktualizuje pokój. Przykład znajdziesz w artykule Aktualizowanie przestrzeni.

Jeśli aktualizujesz pole displayName i pojawi się komunikat o błędzie ALREADY_EXISTS, spróbuj użyć innej wyświetlanej nazwy. Istniejący pokój w organizacji Google Workspace może już używać tej wyświetlanej nazwy.

Obsługuje te typy uwierzytelniania:

  • Uwierzytelnianie aplikacji z zatwierdzeniem przez administratora i jednym z tych zakresów autoryzacji:

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

  • Uwierzytelnianie użytkownika z jednym z tych zakresów autoryzacji:

    • https://www.googleapis.com/auth/chat.spaces
    • https://www.googleapis.com/auth/chat.import (tylko pokoje w trybie importowania)
    • Uwierzytelnianie użytkownika przyznaje uprawnienia administratora, gdy uwierzytelnione jest konto administratora, useAdminAccess jest true i używane są te zakresy autoryzacji:
      • https://www.googleapis.com/auth/chat.admin.spaces

Uwierzytelnianie aplikacji ma te ograniczenia:

  • Aby zaktualizować space.predefined_permission_settings lub space.permission_settings, aplikacja musi być twórcą pokoju.
  • Aktualizacja space.access_settings.audience nie jest obsługiwana w przypadku uwierzytelniania aplikacji.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
space.name

string

Identyfikator. Nazwa zasobu pokoju.

Format: spaces/{space}

gdzie {space} to identyfikator pokoju przypisany przez system. Identyfikator pokoju możesz uzyskać, wywołując metodę spaces.list() lub z adresu URL pokoju. Jeśli na przykład adres URL pokoju to https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA, identyfikator pokoju to AAAAAAAAA.

Parametry zapytania

Parametry
updateMask

string (FieldMask format)

Wymagane. Zaktualizowane ścieżki pól, rozdzielone przecinkami, jeśli jest ich kilka.

W przypadku pokoju możesz zaktualizować te pola:

spaceDetails: aktualizuje opis i wytyczne dotyczące pokoju. W żądaniu aktualizacji musisz przekazać zarówno opis, jak i wskazówki jako SpaceDetails. Jeśli chcesz zaktualizować tylko jedno z tych pól, przekaż istniejącą wartość drugiego pola.

displayName: obsługuje tylko aktualizowanie wyświetlanej nazwy w przestrzeniach, w których pole spaceType ma wartość SPACE. Jeśli pojawi się komunikat o błędzie ALREADY_EXISTS, spróbuj użyć innej wartości. Istniejący pokój w organizacji Google Workspace może już używać tej wyświetlanej nazwy.

spaceType: obsługuje tylko zmianę typu pokoju z GROUP_CHAT na SPACE. W masce aktualizacji uwzględnij displayName wraz z spaceType i upewnij się, że określona przestrzeń ma niepustą wyświetlaną nazwę i typ przestrzeni SPACE. Podczas aktualizowania wyświetlanej nazwy uwzględnienie maski spaceType i typu SPACE w określonej przestrzeni jest opcjonalne, jeśli istniejąca przestrzeń ma już typ SPACE. Próba zmiany typu pokoju w inny sposób spowoduje błąd nieprawidłowego argumentu. spaceType nie jest obsługiwany w przypadku useAdminAccess.

spaceHistoryState: aktualizuje ustawienia historii pokoju, włączając lub wyłączając historię pokoju. Ta opcja jest obsługiwana tylko wtedy, gdy w organizacji Google Workspace włączone są ustawienia historii. Aby zaktualizować stan historii pokoju, musisz pominąć w żądaniu wszystkie inne maski pól. spaceHistoryState nie jest obsługiwany w przypadku useAdminAccess.

accessSettings.audience: aktualizuje ustawienie dostępu określające, kto może znaleźć pokój, dołączyć do niego i wyświetlić podgląd wiadomości w pokoju z nazwą, w którym pole spaceType ma wartość SPACE. Jeśli istniejący pokój ma grupę odbiorców, możesz ją usunąć i ograniczyć dostęp do pokoju, pomijając wartość w tej masce pola. Aby zaktualizować ustawienia dostępu do pokoju, uwierzytelniony użytkownik musi być menedżerem pokoju i pominąć wszystkie inne maski pól w żądaniu. Nie możesz zaktualizować tego pola, jeśli pokój jest w trybie importowania. Więcej informacji znajdziesz w artykule Udostępnianie pokoju określonym użytkownikom. accessSettings.audience nie jest obsługiwany w przypadku useAdminAccess.

accessSettings.access_permission_settings: aktualizuje ustawienia uprawnień dostępu, które określają, kto może znaleźć pokój i do niego dołączyć, gdy pole spaceType ma wartość SPACE. Podmioty zabezpieczeń, które mogą dołączyć do pokoju, muszą mieć też możliwość jego wykrycia. Aby zaktualizować ustawienia uprawnień dostępu do pokoju, uwierzytelniony użytkownik musi być menedżerem lub asystentem menedżera pokoju i pominąć wszystkie inne maski pól w żądaniu. Nie możesz zaktualizować tego pola, jeśli pokój jest w trybie importowania. Więcej informacji znajdziesz w artykule Udostępnianie pokoju określonym użytkownikom. accessSettings.access_permission_settings nie jest obsługiwany w przypadku useAdminAccess. Obsługiwane maski pól to:

  • accessSettings.access_permission_settings.discoverSpaceSetting
  • accessSettings.access_permission_settings.joinSpaceSetting

permissionSettings: umożliwia zmianę ustawień uprawnień pokoju. Podczas aktualizowania ustawień uprawnień możesz określić tylko maski pól permissionSettings. Nie możesz jednocześnie aktualizować innych masek pól. Obsługiwane maski pól to:

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

boolean

Opcjonalnie. Gdy true, metoda jest uruchamiana z użyciem uprawnień administratora Google Workspace użytkownika.

Użytkownik dzwoniący musi być administratorem Google Workspace z uprawnieniami do zarządzania czatem i rozmowami w pokojach.

Wymaga chat.admin.spaces zakresu OAuth 2.0.

Niektóre wartości FieldMask nie są obsługiwane w przypadku dostępu administracyjnego. Więcej informacji znajdziesz w opisie updateMask.

Treść żądania

Treść żądania zawiera wystąpienie elementu Space.

Treść odpowiedzi

W przypadku powodzenia treść odpowiedzi obejmuje wystąpienie elementu Space.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

  • 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

Więcej informacji znajdziesz w przewodniku po autoryzacji.