REST Resource: spaces

Zasób: przestrzeń

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ą 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,
  "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

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 atrybutu spaceType. Typ pokoju.
spaceType

enum (SpaceType)

Typ pokoju. Wymagane podczas tworzenia pokoju lub aktualizowania typu pokoju. 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 w zastępstwie zasady spaceThreadingState. Określa, czy wiadomości są podzielone na wątki w tym pokoju.
displayName

string

Wyświetlana nazwa pokoju. Wymagane podczas tworzenia pokoju z ustawieniem 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. 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

Niezmienna. Określa, czy ten pokój pozwala na dołączenie dowolnego użytkownika Google Chat. Dane wprowadzane podczas tworzenia pokoju w organizacji Google Workspace. Pomiń to pole podczas tworzenia pokoi w tych przypadkach:

  • 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 wszystkich użytkowników 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)

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

enum (HistoryState)

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 nie są one widoczne dla użytkowników, dopóki import się nie zakończy.

Tworzenie pokoju w Import Mode wymaga uwierzytelniania użytkownika.
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 to pole na historyczny znacznik czasu, w którym pokój został utworzony w źródle, aby zachować pierwotny czas utworzenia.

Wartość 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 czatów z poziomu aplikacji Google Chat określ, czy pokój został utworzony przez administratora Google Workspace. Administratorzy mogą instalować i konfigurować czat w aplikacji 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ść spaceType to 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 umożliwiający użytkownikowi dostęp do pokoju.
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 pakietu 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. Jest wypełnione tylko wtedy, gdy wartość space_type to SPACE.

Wymaga uwierzytelniania użytkownika. 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ń pokoju, które można określić tylko podczas tworzenia 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: Ustawienia uprawnień dla istniejących pokoi. Pole do aktualizowania dokładnych ustawień uprawnień dotyczących pokoju. Obecne ustawienia uprawnień są zastępowane. Dane wyjściowe zawierają listę bieżących ustawień uprawnień.

Typ

Wycofane: użyj atrybutu 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 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ć. SPACE może zawierać aplikacje Google Chat.
GROUP_CHAT rozmowy grupowe z 3 lub większą liczbą uczestników. GROUP_CHAT może zawierać aplikacje Google Chat.
DIRECT_MESSAGE wiadomości 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 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 z dwiema osobami i rozmowy grupowe z udziałem co najmniej 3 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.

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

string

Opcjonalnie: zasady, oczekiwania i etykietę obowiązujące w pokoju;

Obsługuje maksymalnie 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ę członkostw w pokoju, pogrupowanych według kategorii.

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 może wykryć pokój, dołączyć do pokoju 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 jako wykrywalnego dla grupy odbiorców.

Format: audiences/{audience}

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

Odczytywanie odbiorców docelowych pomaga:

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

Ustawienie grupy odbiorców wymaga uwierzytelniania 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, mogą również znaleźć pokój 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żna określić tylko 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, które powoduje, że pokój staje się miejscem współpracy, w którym wszyscy użytkownicy mogą publikować wiadomości.
ANNOUNCEMENT_SPACE Ustawienie, aby ten pokój stał się miejscem z ogłoszeniami, w którym tylko menedżerowie pokoju mogą publikować wiadomości.

PermissionSettings

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

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)

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

object (PermissionSetting)

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

object (PermissionSetting)

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

object (PermissionSetting)

Ustawienie dotyczące używania polecenia @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 dotyczące 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

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

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

create

 Tworzy pokój bez użytkowników.

delete

 usuwa pokój nazwany;

findDirectMessage

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

get

 Zwraca szczegóły pokoju.

list

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

patch

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

setup

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