REST Resource: spaces

Zasób: Space

Pokoju w Google Chat. Pokoje to rozmowy między co najmniej 2 użytkownikami lub wiadomości 1:1 między użytkownikiem a aplikacją do obsługi czatu.

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,
  "importModeExpireTime": string,
  "customer": 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

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.
type
(deprecated)

enum (Type)

Tylko dane wyjściowe. Wycofana: zamiast niej używaj zasady spaceType. Typ pokoju.
spaceType

enum (SpaceType)

Opcjonalnie. Rodzaj pokoju. Wymagane podczas tworzenia pokoju lub aktualizowania jego typu. W przypadku innych zastosowań tylko dane wyjściowe.
singleUserBotDm

boolean

Opcjonalnie. Czy pokój to czat między aplikacją Chat a pojedynczym użytkownikiem.
threaded
(deprecated)

boolean

Tylko dane wyjściowe. Wycofana: zamiast niej używaj zasady spaceThreadingState. czy wiadomości w tym pokoju są wątkowane;
displayName

string

Opcjonalnie. Wyświetlana nazwa pokoju. Wymagany podczas tworzenia pokoju z wartością spaceType równą SPACE. Jeśli podczas tworzenia pokoju lub aktualizowania displayName pojawi się komunikat o błędzie ALREADY_EXISTS, spróbuj użyć innego 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

Opcjonalnie. Niezmienne. Określa, czy w tym pokoju może być dowolny użytkownik Google Chat. Podawane podczas tworzenia pokoju w organizacji Google Workspace. Pomiń to pole podczas tworzenia pokoi w tych warunkach:

  • Uwierzytelniony użytkownik korzysta z konta konsumenckiego (niezarządzanego konta użytkownika). Domyślnie pokój utworzony na koncie konsumenckim jest dostępny dla każdego użytkownika Google Chat.

W przypadku istniejących pokoi to pole jest tylko danymi wyjściowymi.
spaceThreadingState

enum (SpaceThreadingState)

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

object (SpaceDetails)

Opcjonalnie. Szczegóły dotyczące pokoju, w tym opis i zasady.
spaceHistoryState

enum (HistoryState)

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

boolean

Opcjonalnie. Czy ta przestrzeń została utworzona w Import Mode w ramach migracji danych do Google Workspace. Podczas importowania pokoje są niewidoczne dla użytkowników, dopóki importowanie nie zostanie ukończone.

Tworzenie pokoju w Import Mode wymaga uwierzytelniania użytkownika.
createTime

string (Timestamp format)

Opcjonalnie. Niezmienne. W przypadku pokoi utworzonych w Chat jest to czas utworzenia pokoju. To pole jest tylko polem wyjściowym, z wyjątkiem sytuacji, gdy jest używane w pokojach w trybie importowania.

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

Wypełniane w danych wyjściowych tylko wtedy, gdy wartość pola spaceType to 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 na czacie z aplikacją Google Chat, czy pokój został utworzony przez administratora Google Workspace. Administratorzy mogą instalować i konfigurować czat z aplikacją do obsługi czatu w imieniu użytkowników w organizacji.

Aby obsługiwać instalację przez administratora, aplikacja do obsługi czatu musi mieć funkcję czatu.
membershipCount

object (MembershipCount)

Tylko dane wyjściowe. Liczba dołączonych subskrypcji pogrupowanych według typu członka. Wypełniane, gdy element spaceType ma wartość SPACE, DIRECT_MESSAGE lub GROUP_CHAT.
accessSettings

object (AccessSettings)

Opcjonalnie. Określa ustawienie dostępu do pokoju. Wypełnione tylko wtedy, gdy pole spaceType ma wartość SPACE.
spaceUri

string

Tylko dane wyjściowe. Identyfikator URI, za pomocą którego użytkownik może uzyskać dostęp do pokoju.
importModeExpireTime

string (Timestamp format)

Tylko dane wyjściowe. Czas, po którym pokój zostanie automatycznie usunięty przez system, jeśli pozostanie w trybie importowania.

Każdy pokój utworzony w trybie importowania musi opuścić ten tryb przed upływem tego czasu za pomocą spaces.completeImport.

To pole jest wypełniane tylko w przypadku pokoi utworzonych w trybie importowania.
customer

string

Opcjonalnie. Niezmienne. Identyfikator klienta domeny pokoju. Wymagane tylko podczas tworzenia pokoju z uwierzytelnianiem aplikacji i gdy SpaceType ma wartość SPACE. W przeciwnym razie nie należy ustawiać tego pola.

W formacie customers/{customer}, gdzie customer to id z zasobu klienta pakietu Admin SDK. Aplikacje prywatne mogą też używać aliasu customers/my_customer, aby utworzyć przestrzeń w tej samej organizacji Google Workspace co aplikacja.

W przypadku czatów to pole nie jest wypełniane.
Pole unii space_permission_settings. Reprezentuje ustawienia uprawnień pokoju. Wypełnione tylko wtedy, gdy pole 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. Wstępnie zdefiniowane ustawienia uprawnień w pokoju, które można wprowadzić tylko podczas tworzenia pokoju. Jeśli to pole nie zostanie ustawione, zostanie utworzony pokój współpracy. Po utworzeniu pokoju ustawienia zostaną wypełnione w polu PermissionSettings.

Ustawianie predefiniowanych ustawień uprawnień obsługuje:
permissionSettings

object (PermissionSettings)

Opcjonalnie. Ustawienia uprawnień pokoju w przypadku istniejących pokoi. Dane wejściowe do aktualizowania dokładnych ustawień uprawnień dotyczących pokoju, w których istniejące ustawienia uprawnień są zastępowane. Wynik zawiera listę bieżących ustawień uprawnień.

Odczytywanie i aktualizowanie ustawień uprawnień obsługuje:

Typ

Wycofana: zamiast niej używaj zasady SpaceType.

Wartości w polu enum
TYPE_UNSPECIFIED Zarezerwowano.
ROOM Rozmowy między co najmniej 2 osobami.
DM Czat indywidualny między osobą a aplikacją do obsługi czatu, w którym wszystkie wiadomości są płaskie. Pamiętaj, że nie obejmuje to wiadomości na czacie między dwoma osobami.

SpaceType

Rodzaj pokoju. Wymagane podczas tworzenia lub aktualizowania pokoju. W przypadku innych zastosowań tylko dane wyjściowe.

Wartości w polu enum
SPACE_TYPE_UNSPECIFIED Zarezerwowano.
SPACE Miejsce, w którym użytkownicy mogą wysyłać wiadomości, udostępniać pliki i współpracować. SPACE może zawierać aplikacje Google Chat.
GROUP_CHAT rozmowy grupowe z co najmniej 3 osobami; GROUP_CHAT może zawierać aplikacje Google Chat.
DIRECT_MESSAGE Wiadomości 1:1 między 2 osobami lub między osobą a aplikacją w Google Chat.

SpaceThreadingState

Określa typ stanu wątku w pokoju Google Chat.

Wartości w polu enum
SPACE_THREADING_STATE_UNSPECIFIED Zarezerwowano.
THREADED_MESSAGES nazwane pokoje, które obsługują wątki wiadomości; Gdy użytkownicy odpowiadają na wiadomość, mogą to zrobić w wątku, dzięki czemu ich odpowiedź będzie powiązana z oryginalną wiadomością.
GROUPED_MESSAGES Nazwane pokoje, w których rozmowy są uporządkowane według tematu. Tematy i odpowiedzi na nie są grupowane.
UNTHREADED_MESSAGES czaty między 2 osobami i rozmowy grupowe z co najmniej 3 osobami;

SpaceDetails

Szczegóły dotyczące pokoju, w tym opis i zasady.

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

string

Opcjonalnie. Opis pokoju. Możesz na przykład opisać temat dyskusji w pokoju, jego funkcję lub uczestników.

Może zawierać maksymalnie 150 znaków.
guidelines

string

Opcjonalnie. zasady, oczekiwania i etykieta obowiązujące w pokoju;

Obsługuje 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. Reguły przechowywania w Vault organizacji określają, jak długo wiadomości i wątki są przechowywane.

MembershipCount

Reprezentuje liczbę członkostw w pokoju pogrupowanych w kategorie.

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

integer

Tylko dane wyjściowe. Liczba użytkowników, którzy dołączyli do pokoju bezpośrednio, bez uwzględniania użytkowników, którzy dołączyli w ramach członkostwa w grupie.
joinedGroupCount

integer

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

AccessSettings

Określa 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 może znaleźć pokój, do niego dołączyć i wyświetlić podgląd wiadomości w nim. Jeśli to ustawienie nie jest skonfigurowane, dostęp do pokoju mają tylko użytkownicy lub grupy dyskusyjne Google, którzy zostali indywidualnie zaproszeni lub dodani do pokoju. Więcej informacji znajdziesz w artykule Udostępnianie pokoju grupie odbiorców.

Format: audiences/{audience}

Aby używać domyślnej grupy odbiorców w organizacji Google Workspace, ustaw wartość audiences/default.

Odczytywanie grupy docelowej obsługuje:

To pole nie jest wypełniane, gdy używasz zakresu chat.bot z uwierzytelnianiem aplikacji.

Ustawienie grupy docelowej wymaga uwierzytelnienia użytkownika.

AccessState

Reprezentuje stan dostępu do pokoju.

Wartości w polu enum
ACCESS_STATE_UNSPECIFIED Stan dostępu jest nieznany lub nieobsługiwany w tym interfejsie API.
PRIVATE Tylko użytkownicy lub grupy dyskusyjne Google, które zostały indywidualnie dodane lub zaproszone przez innych użytkowników lub administratorów Google Workspace, mogą znaleźć pokój i uzyskać do niego dostęp.
DISCOVERABLE

Menedżer pokoju przyznał grupie odbiorców dostęp do pokoju. Użytkownicy lub grupy dyskusyjne Google, które zostały indywidualnie dodane do pokoju lub zaproszone do niego, również mogą go znaleźć i uzyskać do niego dostęp. Więcej informacji znajdziesz w artykule Udostępnianie pokoju konkretnym użytkownikom.

Tworzenie pokoi możliwych do znalezienia wymaga uwierzytelniania użytkownika.

PredefinedPermissionSettings

Wstępnie zdefiniowane ustawienia uprawnień, które można określić tylko podczas tworzenia pokoju z nazwą. W przyszłości możemy dodać więcej ustawień. Szczegółowe informacje o ustawieniach uprawnień w przypadku 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, które sprawia, że pokój staje się miejscem współpracy, w którym wszyscy użytkownicy mogą publikować wiadomości.
ANNOUNCEMENT_SPACE Ustawienie, które sprawia, że pokój staje się pokojem z ogłoszeniami, w którym tylko menedżerowie pokoju mogą publikować wiadomości.

PermissionSettings

Ustawienia uprawnień, które możesz określić podczas aktualizowania istniejącego pokoju z nazwą.

Aby ustawić uprawnienia podczas tworzenia pokoju, w żądaniu określ 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)

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

object (PermissionSetting)

Opcjonalnie. Ustawienie umożliwiające aktualizowanie nazwy pokoju, awatara, opisu i wytycznych.
toggleHistory

object (PermissionSetting)

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

object (PermissionSetting)

Opcjonalnie. Ustawienie dotyczące używania polecenia @all w pokoju.
manageApps

object (PermissionSetting)

Opcjonalnie. Ustawienie zarządzania aplikacjami w pokoju.
manageWebhooks

object (PermissionSetting)

Opcjonalnie. Ustawienie do zarządzania webhookami w pokoju.
postMessages

object (PermissionSetting)

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

object (PermissionSetting)

Opcjonalnie. Ustawienie odpowiadania na wiadomości w pokoju.

PermissionSetting

Reprezentuje ustawienie uprawnień pokoju.

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

boolean

Opcjonalnie. Czy menedżerowie pokoju mają to uprawnienie.
membersAllowed

boolean

Opcjonalnie. Czy członkowie grupy, którzy nie są menedżerami, mają to uprawnienie.

Metody

completeImport

 Kończy proces importowania w przypadku określonego pokoju i udostępnia go użytkownikom.

create

 Tworzy pokój.

delete

 Usuwa nazwany pokój.

findDirectMessage

 Zwraca istniejącą wiadomość na czacie z określonym użytkownikiem.

get

 Zwraca szczegóły pokoju.

list

 Wyświetla pokoje, których element wywołujący jest członkiem.

patch

 Aktualizuje pokój.
Zwraca listę przestrzeni w organizacji Google Workspace na podstawie wyszukiwania administratora.

setup

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