REST Resource: spaces

Zasób: Space

Pokój w Google Chat. Pokoje to rozmowy między co najmniej 2 użytkownikami lub wiadomości 1:1 między użytkownikiem a aplikacją Google Chat.

Zapis JSON 
{
  "name": string,
  "type": enum (Type),
  "spaceType": enum (SpaceType),
  "singleUserBotDm": boolean,
  "threaded": boolean,
  "displayName": string,
  "externalUserAllowed": boolean,
  "spaceThreadingState": enum (SpaceThreadingState),
  "spaceDetails": {
    object (SpaceDetails)
  },
  "spaceHistoryState": enum (HistoryState),
  "importMode": boolean,
  "createTime": string,
  "lastActiveTime": string,
  "adminInstalled": boolean,
  "membershipCount": {
    object (MembershipCount)
  },
  "accessSettings": {
    object (AccessSettings)
  },
  "spaceUri": string,

  // Union field space_permission_settings can be only one of the following:
  "predefinedPermissionSettings": enum (PredefinedPermissionSettings),
  "permissionSettings": {
    object (PermissionSettings)
  }
  // End of list of possible types for union field space_permission_settings.
}
Pola
name

string

Nazwa zasobu pokoju.

Format: spaces/{space}
type
(deprecated)

enum (Type)

Tylko dane wyjściowe. Wycofane: użyj atrybutu spaceType. Typ pokoju.
spaceType

enum (SpaceType)

Typ pokoju. Wymagane podczas tworzenia pokoju lub aktualizowania jego typu. Dane wyjściowe tylko do innych zastosowań.
singleUserBotDm

boolean

Opcjonalnie. Określa, czy pokój jest czatem między aplikacją Google Chat a jednym człowiekiem.
threaded
(deprecated)

boolean

Tylko dane wyjściowe. Wycofane: użyj atrybutu spaceThreadingState. Określa, czy wiadomości są podzielone na wątki w tym pokoju.
displayName

string

Wyświetlana nazwa pokoju. Wymagane podczas tworzenia pokoju. Jeśli podczas tworzenia pokoju lub aktualizowania pokoju displayName zobaczysz komunikat o błędzie ALREADY_EXISTS, spróbuj użyć innego elementu displayName. Istniejący pokój w organizacji Google Workspace może już używać tej wyświetlanej nazwy.

W przypadku czatów to pole może być puste.

Może mieć do 128 znaków.
externalUserAllowed

boolean

Stała. Określa, czy ten pokój pozwala na dołączenie dowolnego użytkownika Google Chat. Wprowadź podczas tworzenia pokoju w organizacji Google Workspace. Pomiń to pole podczas tworzenia pokoi w tych warunkach:

  • Uwierzytelniony użytkownik używa konta klienta (niezarządzanego konta użytkownika). Domyślnie w pokoju utworzonym przez konto dla użytkowników indywidualnych zezwala każdy użytkownik Google Chat.

  • Pokój jest używany do importowania danych do Google Chat, ponieważ pokoje w trybie importowania mogą zezwalać tylko użytkownikom z tej samej organizacji Google Workspace. Jednak w ramach Programu podglądu dla programistów Google Workspace pokoje w trybie importowania mogą zezwalać każdemu użytkownikowi Google Chat. To pole można ustawić jako dostępne w pokojach w trybie importowania.

W przypadku dotychczasowych pokoi to pole zawiera tylko dane wyjściowe.
spaceThreadingState

enum (SpaceThreadingState)

Tylko dane wyjściowe. Stan wątku w pokoju czatu.
spaceDetails

object (SpaceDetails)

Informacje o pokoju, w tym opis i reguły.
spaceHistoryState

enum (HistoryState)

Stan historii wiadomości dla wiadomości i wątków w tym pokoju.
importMode

boolean

Opcjonalnie. Określa, czy ten pokój został utworzony w usłudze Import Mode w ramach migracji danych do Google Workspace. Podczas importowania pokoi nie są one widoczne dla użytkowników, dopóki import się nie zakończy.
createTime

string (Timestamp format)

Opcjonalnie. Stała. W przypadku pokoi utworzonych w Google Chat jest to czas utworzenia pokoju. To pole dotyczy tylko danych wyjściowych, chyba że jest używane w pokojach w trybie importowania.

W przypadku pokoi w trybie importowania ustaw w tym polu historyczną sygnaturę czasową, w której pokój został utworzony w źródle, aby zachować pierwotny czas utworzenia pokoju.

Wartość jest podawana w danych wyjściowych tylko wtedy, gdy spaceType ma wartość GROUP_CHAT lub SPACE.
lastActiveTime

string (Timestamp format)

Tylko dane wyjściowe. Sygnatura czasowa ostatniej wiadomości w pokoju.

adminInstalled

boolean

Tylko dane wyjściowe. w przypadku pokoi czatu z aplikacją Google Chat – informacja o tym, czy pokój został utworzony przez administratora Google Workspace; Administratorzy mogą zainstalować i skonfigurować czat w aplikacji Google Chat w imieniu użytkowników w swojej organizacji.

Aby instalacja była obsługiwana przez administratora, aplikacja Google Chat musi obsługiwać czat.
membershipCount

object (MembershipCount)

Tylko dane wyjściowe. Liczba osób, które dołączyły do grupy, pogrupowane według typu wspierającego. Wartość wypełniana, gdy spaceType ma wartość SPACE, DIRECT_MESSAGE lub GROUP_CHAT.

accessSettings

object (AccessSettings)

Opcjonalnie. Określa ustawienie dostępu do pokoju. Wartość jest podawana tylko wtedy, gdy spaceType ma wartość SPACE.

spaceUri

string

Tylko dane wyjściowe. Identyfikator URI pokoju.

Pole sumy space_permission_settings. Reprezentuje ustawienia uprawnień pokoju. Wartość jest podawana tylko wtedy, gdy space_type ma wartość SPACE. space_permission_settings może mieć tylko jedną z tych wartości:
predefinedPermissionSettings

enum (PredefinedPermissionSettings)

Opcjonalnie. Tylko dane wejściowe. Ustawienia uprawnień pokoju. Dane wejściowe do utworzenia pokoju. Jeśli to pole nie jest skonfigurowane, tworzony jest pokój współpracy. Po utworzeniu pokoju ustawienia zostaną wypełnione w polu PermissionSettings.

permissionSettings

object (PermissionSettings)

Opcjonalnie. Dokładne ustawienia uprawnień, które można skonfigurować w celu aktualizowania pokoju. Pole na aktualizowanie pokoju. W przeciwnym razie tylko dane wyjściowe. Aby utworzyć pokój, użyj predefinedPermissionSettings.

Typ

Wycofane: użyj atrybutu SpaceType.

Wartości w polu enum
TYPE_UNSPECIFIED Zarezerwowane.
ROOM Rozmowy między co najmniej 2 osobami.
DM Czat 1:1 między człowiekiem a aplikacją do obsługi czatu, gdzie wszystkie wiadomości są płaskie. Pamiętaj, że nie dotyczy to czatów między 2 osobami.

SpaceType

Typ pokoju. Wymagane podczas tworzenia lub aktualizowania pokoju. Dane wyjściowe tylko do innych zastosowań.

Wartości w polu enum
SPACE_TYPE_UNSPECIFIED Zarezerwowane.
SPACE Miejsce, w którym użytkownicy mogą wysyłać wiadomości, udostępniać pliki i współpracować. Element SPACE może obejmować aplikacje Google Chat.
GROUP_CHAT rozmów grupowych z co najmniej 3 osobami, Element GROUP_CHAT może obejmować aplikacje Google Chat.
DIRECT_MESSAGE rozmów 1:1 między 2 osobami lub człowiekiem i aplikacją Google Chat.

SpaceThreadingState

Określa typ stanu wątku w pokoju czatu.

Wartości w polu enum
SPACE_THREADING_STATE_UNSPECIFIED Zarezerwowane.
THREADED_MESSAGES Pokoje z nazwami obsługujące wątki wiadomości. Gdy użytkownicy odpowiedzą na wiadomość, będą mogli odpowiedzieć w wątku, co zachowa zgodność z kontekstem oryginalnej wiadomości.
GROUPED_MESSAGES Nazwane pokoje, w których rozmowa jest uporządkowana według tematów. Tematy i odpowiedzi na nie są grupowane.
UNTHREADED_MESSAGES Czaty z dwiema osobami i rozmowy grupowe z udziałem co najmniej 3 osób.

SpaceDetails

Informacje o pokoju, w tym opis i reguły.

Zapis JSON 
{
  "description": string,
  "guidelines": string
}
Pola
description

string

Opcjonalnie. Opis pokoju. Na przykład opisz temat rozmowy, przeznaczenie lub uczestników pokoju.

Może mieć do 150 znaków.
guidelines

string

Opcjonalnie. Zasady, oczekiwania i etykieta

Może mieć do 5000 znaków.

HistoryState

Stan historii wiadomości i pokoi. Określa, jak długo wiadomości i wątki rozmów są przechowywane po utworzeniu.

Wartości w polu enum
HISTORY_STATE_UNSPECIFIED Wartość domyślna. Nie używać.
HISTORY_OFF Historia wyłączona. Wiadomości i wątki są przechowywane przez 24 godziny.
HISTORY_ON Historia włączona. Okres przechowywania wiadomości i wątków określają reguły przechowywania w Vault obowiązujące w organizacji.

MembershipCount

Reprezentuje liczbę osób w pokoju pogrupowanych w kategorie.

Zapis JSON 
{
  "joinedDirectHumanUserCount": integer,
  "joinedGroupCount": integer
}
Pola
joinedDirectHumanUserCount

integer

Liczba użytkowników, którzy bezpośrednio dołączyli do pokoju, bez uwzględniania użytkowników, którzy zostali członkami grupy.
joinedGroupCount

integer

Liczba wszystkich grup, które bezpośrednio dołączyły do pokoju.

AccessSettings

Reprezentuje ustawienie dostępu do pokoju.

Zapis JSON 
{
  "accessState": enum (AccessState),
  "audience": string
}
Pola
accessState

enum (AccessState)

Tylko dane wyjściowe. Wskazuje stan dostępu do pokoju.
audience

string

Opcjonalnie. Nazwa zasobu grupy odbiorców, która ma dostęp do pokoju. Aby pokój można było znaleźć, podaj w tym polu prawidłowy identyfikator grupy odbiorców. Możesz też użyć aliasu audiences/default, aby ustawić pokój za pomocą domyślnego ustawienia dostępu w konsoli administracyjnej. Więcej informacji znajdziesz w artykule Ustawianie pokoju jako wykrywalnego dla grupy odbiorców. Odznacz to pole, aby ograniczyć zakres pokoju. Wartość wypełniana tylko wtedy, gdy pokój jest możliwy do znalezienia. Format: audiences/{audience} i audiences/default mogą być używane jako alias domyślnego ustawienia udostępniania Google Chat.

AccessState

Reprezentuje stan dostępu do pokoju.

Wartości w polu enum
ACCESS_STATE_UNSPECIFIED Stan dostępu jest nieznany lub nieobsługiwany przez ten interfejs API.
PRIVATE Pokój jest możliwy do znalezienia przez dodanych lub zaproszonych użytkowników albo grupy.
DISCOVERABLE Pokój jest wykrywalny dla wybranej grupy odbiorców, a także dla dodanych lub zaproszonych członków bądź grup.

PredefinedPermissionSettings

Ustawienia uprawnień pokoju, które możesz określić podczas tworzenia nazwanego pokoju. W przyszłości możemy dodać więcej ustawień. Szczegółowe informacje o ustawieniach uprawnień do nazwanych pokoi znajdziesz w artykule Więcej informacji o pokojach.

Wartości w polu enum
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED Nie określono. Nie używaj.
COLLABORATION_SPACE Ustawienie, dzięki któremu pokój stanie się przestrzenią współpracy, w której wszyscy użytkownicy mogą publikować wiadomości.
ANNOUNCEMENT_SPACE Ustawienie, aby zmienić pokój jako pokój z ogłoszeniami, w którym tylko menedżerowie pokoju mogą publikować wiadomości.

PermissionSettings

Ustawienia uprawnień do nazwanego pokoju. Aby skonfigurować ustawienia uprawnień podczas tworzenia pokoju, podaj w prośbie pole PredefinedPermissionSettings.

Zapis JSON 
{
  "manageMembersAndGroups": {
    object (PermissionSetting)
  },
  "modifySpaceDetails": {
    object (PermissionSetting)
  },
  "toggleHistory": {
    object (PermissionSetting)
  },
  "useAtMentionAll": {
    object (PermissionSetting)
  },
  "manageApps": {
    object (PermissionSetting)
  },
  "manageWebhooks": {
    object (PermissionSetting)
  },
  "postMessages": {
    object (PermissionSetting)
  },
  "replyMessages": {
    object (PermissionSetting)
  }
}
Pola
manageMembersAndGroups

object (PermissionSetting)

Ustawienie zarządzania użytkownikami i grupami w pokoju.
modifySpaceDetails

object (PermissionSetting)

Ustawienie do aktualizowania nazwy, awatara, opisu i wytycznych pokoju.
toggleHistory

object (PermissionSetting)

Ustawienie do włączania i wyłączania historii pokoju.
useAtMentionAll

object (PermissionSetting)

Ustawienie używania @all w pokoju.
manageApps

object (PermissionSetting)

Ustawienie zarządzania aplikacjami w pokoju.
manageWebhooks

object (PermissionSetting)

Ustawienie zarządzania webhookami w pokoju.
postMessages

object (PermissionSetting)

Tylko dane wyjściowe. Ustawienie publikowania wiadomości w pokoju.
replyMessages

object (PermissionSetting)

Ustawienie odpowiadania na wiadomości w pokoju.

PermissionSetting

Reprezentuje ustawienie uprawnień pokoju.

Zapis JSON 
{
  "managersAllowed": boolean,
  "membersAllowed": boolean
}
Pola
managersAllowed

boolean

Określa, czy menedżerowie pokoju mają to uprawnienie.
membersAllowed

boolean

Określa, czy użytkownicy, którzy nie są menedżerami, mają to uprawnienie.

Metody

completeImport

 Wykonuje proces importowania do określonego pokoju i sprawia, że jest on widoczny dla użytkowników.

create

 Tworzy nazwany pokój.

delete

 Usuwa nazwany pokój.

findDirectMessage

 Zwraca istniejący czat z określonym użytkownikiem.

get

 Zwraca szczegółowe informacje o pokoju.

list

 Wyświetla listę pokoi, do których należy rozmówca.

patch

 Aktualizuje pokój.

setup

 Tworzy pokój i dodaje do niego określonych użytkowników.