REST Resource: spaces

Zasób: przestrzeń

Pokoju w Google Chat. Pokoje to rozmowy między co najmniej 2 użytkownikami lub wiadomości 1 na 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,
  "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 przypisany do pokoju przez system. Identyfikator pokoju możesz uzyskać, wywołując metodę spaces.list() lub korzystając z adresu URL pokoju. Jeśli na przykład adres URL pokoju to https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA, jego identyfikator to AAAAAAAAA.
type
(deprecated)

enum (Type)

Tylko dane wyjściowe. Wycofane: użyj w zastępstwie tego spaceType. Typ pokoju.
spaceType

enum (SpaceType)

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

boolean

Opcjonalnie: Czy pokój to czat między botem a jedną osobą.
threaded
(deprecated)

boolean

Tylko dane wyjściowe. Wycofane: użyj w zastępstwie tego spaceThreadingState. czy wiadomości są w tym pokoju uporządkowane w wątki.
displayName

string

Opcjonalnie: Wyświetlana nazwa pokoju. Wymagany podczas tworzenia pokoju z spaceType o wartości SPACE. Jeśli podczas tworzenia pokoju lub aktualizowania displayName pojawi się komunikat o błędzie ALREADY_EXISTS, spróbuj użyć innego displayName. Ta wyświetlana nazwa może być już używana w przypadku istniejącego pokoju w organizacji Google Workspace.

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

Obsługuje do 128 znaków.
externalUserAllowed

boolean

Opcjonalnie: Niezmienna. Określa, czy ten pokój pozwala na dodawanie dowolnego użytkownika Google Chat jako członka. Dane wprowadzane podczas tworzenia pokoju w organizacji Google Workspace. Pomiń to pole podczas tworzenia pokoi w tych warunkach:

  • Użytkownik uwierzytelniony korzysta z konta klienta (niezarządzanego konta użytkownika). Domyślnie pokój utworzony przez konto użytkownika indywidualnego jest dostępny dla każdego użytkownika Google Chat.

W przypadku istniejących pokoi to pole jest tylko do odczytu.
spaceThreadingState

enum (SpaceThreadingState)

Tylko dane wyjściowe. Stan wątku 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 i wątków w tym pokoju;
importMode

boolean

Opcjonalnie: Czy ten pokój został utworzony w Import Mode w ramach migracji danych do Google Workspace. Podczas importowania pokoi są one niewidoczne dla użytkowników, dopóki proces importowania nie zostanie ukończony.

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

string (Timestamp format)

Opcjonalnie: Niezmienna. w przypadku pokoi utworzonych w Google Chat – czas utworzenia pokoju; To pole jest tylko wyjściowe, z wyjątkiem sytuacji, gdy jest używane w pomieszczeniach w trybie importowania.

W przypadku pokoi w trybie importowania ustaw to pole na historyczny znacznik czasu, w którym pokój został utworzony w źródle, aby zachować pierwotny czas utworzenia.

Jest wypełniane w wyniku tylko wtedy, gdy wartość parametru 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 pokoju czatu z aplikacją Google Chat sprawdź, czy pokój został utworzony przez administratora Google Workspace. Administratorzy mogą instalować i konfigurować czat w aplikacji Google Chat w imieniu użytkowników w organizacji.

Aby umożliwić instalację przez administratora, aplikacja Google Chat musi obsługiwać wiadomości bezpośrednie.
membershipCount

object (MembershipCount)

Tylko dane wyjściowe. Liczba wspierających pogrupowanych według typu wspierającego. Wypełniane, gdy wartość właściwości spaceType to SPACE, DIRECT_MESSAGE lub GROUP_CHAT.
accessSettings

object (AccessSettings)

Opcjonalnie: Określa ustawienie dostępu pokoju. Wypełniane tylko wtedy, gdy wartość spaceType to SPACE.
spaceUri

string

Tylko dane wyjściowe. Identyfikator URI umożliwiający użytkownikowi dostęp do pokoju.
importModeExpireTime

string (Timestamp format)

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

Każdy pokój utworzony w trybie importowania musi wyjść z tego trybu przed upływem tego czasu za pomocą spaces.completeImport.

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

string

Opcjonalnie: Niezmienna. Identyfikator klienta domeny pokoju. Wymagane tylko podczas tworzenia pokoju z uwierzytelnianiem aplikacji i wartością SpaceType SPACE. W przeciwnym razie nie należy go ustawiać.

W formacie customers/{customer}, gdzie customer to id z [zasobu klienta w Admin SDK]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Aplikacje prywatne mogą też używać aliasu customers/my_customer do tworzenia przestrzeni 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łniane tylko wtedy, gdy wartość space_type to SPACE.

Wymaga uwierzytelniania użytkownika. space_permission_settings może być tylko jednym z tych elementów:
predefinedPermissionSettings

enum (PredefinedPermissionSettings)

Opcjonalnie: Tylko dane wejściowe. wstępnie zdefiniowane ustawienia uprawnień pokoju, które można określić tylko podczas tworzenia pokoju; Jeśli pole nie jest ustawione, tworzony jest pokój współpracy. Po utworzeniu pokoju ustawienia zostaną wypełnione w polu PermissionSettings.
permissionSettings

object (PermissionSettings)

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

Typ

Wycofane: użyj w zastępstwie tego SpaceType.

Wartości w polu enum
TYPE_UNSPECIFIED Zarezerwowane.
ROOM rozmowy między co najmniej 2 osobami,
DM Czat indywidualny między człowiekiem a aplikacją do obsługi czatu, w którym wszystkie wiadomości są równe. Pamiętaj, że nie dotyczy to wiadomości na czacie między dwoma 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 wysyłają wiadomości, udostępniają pliki i współpracują. 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 dwoma osobami lub między osobą a aplikacją Google Chat;

SpaceThreadingState

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

Wartości w polu enum
SPACE_THREADING_STATE_UNSPECIFIED Zarezerwowane.
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 miała kontekst oryginalnej 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 3 lub większą liczbą osób.

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, cel lub uczestników pokoju.

Obsługuje do 150 znaków.
guidelines

string

Opcjonalnie: zasady, oczekiwania i etykietę 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 jest włączona. Reguły przechowywania Vault organizacji określają, jak długo wiadomości i wątki są przechowywane.

MembershipCount

Reprezentuje liczbę członkostw w pokoju, pogrupowanych według kategorii.

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

integer

Tylko dane wyjściowe. Liczba użytkowników, którzy bezpośrednio dołączyli do pokoju, bez uwzględnienia użytkowników, którzy dołączyli do pokoju jako członkowie grupy.
joinedGroupCount

integer

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

AccessSettings

Reprezentuje ustawienie dostępu 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łączyć do niego i wyświetlić podgląd wiadomości w pokoju. Jeśli nie jest ustawiona, dostęp do pokoju mają tylko użytkownicy lub grupy dyskusyjne Google, które zostały zaproszone indywidualnie lub dodane do pokoju. Więcej informacji znajdziesz w artykule Ustawianie pokoju w taki sposób, aby był on możliwy do znalezienia przez grupę odbiorców.

Format: audiences/{audience}

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

Czytanie informacji o grupie odbiorców umożliwia:

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

Aby ustawić grupę odbiorców, musisz uwierzytelnić 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 Dostęp do pokoju mają tylko użytkownicy lub grupy dyskusyjne Google, którzy zostali dodani indywidualnie lub zaproszeni przez innych użytkowników albo administratorów Google Workspace.
DISCOVERABLE

Menedżer pokoju przyznał grupie odbiorców dostęp do pokoju. Użytkownicy lub grupy dyskusyjne Google, które zostały dodane indywidualnie lub zaproszone do pokoju, również mogą go znaleźć i uzyskać do niego dostęp. Więcej informacji znajdziesz w artykule Ustawianie pokoju jako możliwego do znalezienia dla określonych użytkowników.

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

PredefinedPermissionSettings

wstępnie zdefiniowane ustawienia uprawnień, które możesz określić tylko podczas tworzenia pokoju o nazwie; W przyszłości możemy dodać więcej ustawień. Szczegółowe informacje o ustawieniach uprawnień w przypadku pokoi o nazwie 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 powoduje, że pokój staje się miejscem współpracy, w którym wszyscy użytkownicy mogą publikować wiadomości.
ANNOUNCEMENT_SPACE Ustawienie, które powoduje, ż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 o nazwie.

Aby ustawić ustawienia uprawnień podczas tworzenia pokoju, w żądaniu podaj 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 dotyczące 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 zarządzania webhookami w pokoju.
postMessages

object (PermissionSetting)

Tylko dane wyjściowe. Ustawienie dotyczące 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: Określa, czy użytkownicy, którzy nie są menedżerami, mają to uprawnienie.

Metody

completeImport

 Zakończy proces importowania w przypadku wybranego pokoju i sprawi, że będzie on widoczny dla użytkowników.

create

 Tworzy pokój.

delete

 usuwa pokój nazwany;

findDirectMessage

 Zwraca istniejące bezpośrednie wiadomości z określonym użytkownikiem.

get

 Zwraca szczegóły pokoju.

list

 Lista pokoi, których użytkownik jest członkiem.

patch

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

setup

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