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,
  "adminInstalled": boolean,
  "accessSettings": {
    object (AccessSettings)
  }
}
Pola
name

string

Nazwa zasobu pokoju.

Format: spaces/{space}

type
(deprecated)

enum (Type)

Tylko dane wyjściowe. Wycofane: użyj zasady 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ą do obsługi czatu a pojedynczym człowiekiem.

threaded
(deprecated)

boolean

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

displayName

string

Wyświetlana nazwa pokoju. Wymagane podczas tworzenia pokoju. Jeśli podczas tworzenia pokoju lub aktualizowania elementu displayName pojawi się komunikat o błędzie ALREADY_EXISTS, spróbuj użyć innej metody displayName. Ta wyświetlana nazwa może już być używana w istniejącym pokoju w organizacji Google Workspace.

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

Może mieć do 128 znaków.

externalUserAllowed

boolean

Stałe. Określa, czy do tego pokoju może dołączyć dowolny użytkownik Google Chat. Pole do wpisania podczas tworzenia pokoju w organizacji Google Workspace. Pomiń to pole podczas tworzenia pokoi w tych warunkach:

  • Uwierzytelniony użytkownik korzysta z konta Google. Domyślnie do pokoju mogą dołączać wszyscy użytkownicy Google Chat.

  • Pokój jest używany do importowania danych do Google Chat. Do pokoi w trybie importowania mogą dołączać tylko użytkownicy z tej samej organizacji Google Workspace.

W przypadku istniejących pokoi to pole zawiera tylko dane wyjściowe.

spaceThreadingState

enum (SpaceThreadingState)

Tylko dane wyjściowe. Stan podziału na wątki w pokoju czatu.

spaceDetails

object (SpaceDetails)

Szczegółowe informacje o pokoju, w tym jego opis i reguły.

spaceHistoryState

enum (HistoryState)

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

importMode

boolean

Opcjonalnie. Określa, czy pokój został utworzony w usłudze Import Mode w ramach migracji danych do Google Workspace. Podczas importowania pokoi nie będą widoczne dla użytkowników, dopóki importowanie nie zostanie ukończone.

createTime

string (Timestamp format)

Opcjonalnie. Stałe. w przypadku pokoi utworzonych w Google Chat data utworzenia pokoju; To pole podaje tylko dane wyjściowe, chyba że jest używane w trybie importowania.

W przypadku pokoi w trybie importowania ustaw w tym polu historyczną sygnaturę czasową utworzenia pokoju w źródle, aby zachować pierwotny czas utworzenia.

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

adminInstalled

boolean

Tylko dane wyjściowe. Wskazuje, czy aplikacja Google Chat została zainstalowana przez administratora Google Workspace. Administratorzy mogą zainstalować aplikację Google Chat w domenie, jednostce organizacyjnej lub grupie użytkowników.

Administratorzy mogą instalować aplikacje Google Chat tylko do prowadzenia czatów między użytkownikami a aplikacją. Aby można było przeprowadzić instalację przez administratora, aplikacja musi obsługiwać czat.

accessSettings

object (AccessSettings)

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

Typ

Wycofane: użyj zasady SpaceType.

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

SpaceType

Typ pokoju. Wymagane przy tworzeniu i aktualizowaniu 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 zawierać aplikacje Google Chat.
GROUP_CHAT rozmów grupowych z co najmniej 3 osobami. Element GROUP_CHAT może zawierać aplikacje Google Chat.
DIRECT_MESSAGE 1:1 między 2 osobami lub człowiekiem i aplikacją Google Chat.

SpaceThreadingState

Określa typ stanu podziału wątków w pokoju czatu.

Wartości w polu enum
SPACE_THREADING_STATE_UNSPECIFIED Zarezerwowane.
THREADED_MESSAGES Pokoje nazwane, które obsługują wątki wiadomości. Gdy użytkownik odpowie na wiadomość, może odpowiedzieć w wątku, co zachowa swoją odpowiedź w kontekście 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 między 2 osobami i rozmowy grupowe z co najmniej 3 osobami.

SpaceDetails

Szczegółowe informacje o pokoju, w tym jego opis i reguły.

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

string

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

Może mieć do 150 znaków.

guidelines

string

Opcjonalnie. Zasady, oczekiwania i etykieta.

Obsługuje do 5000 znaków.

HistoryState

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

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 są określone przez reguły przechowywania w Vault obowiązujące w organizacji.

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 ma dostęp do pokoju. Ustaw w tym polu prawidłowy identyfikator grupy odbiorców, aby pokój można było znaleźć, lub użyj aliasu audiences/default do skonfigurowania pokoju z domyślnym ustawieniem dostępu w konsoli administracyjnej. Więcej informacji znajdziesz w artykule Ustawianie pokoju jako wykrywalnego przez grupę odbiorców. Cofnij ustawienie tego pola, aby zmienić dostęp do pokoju jako ograniczony. Wypełniane tylko wtedy, gdy pokój jest możliwy do znalezienia. Format audiences/{audience}, audiences/default może być używany jako alias domyślnego ustawienia udostępniania w Google Chat.

AccessState

Reprezentuje stan dostępu do pokoju.

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

Metody

completeImport

Kończy proces importowania dotyczący określonego pokoju i czyni go widoczny dla użytkowników.

create

Tworzy pokój nazwany.

delete

Usuwa pokój nazwany.

findDirectMessage

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

get

Zwraca szczegółowe informacje o pokoju.

list

Wyświetla listę pokoi, których członkiem jest rozmówca.

patch

Aktualizuje pokój.

setup

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