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
}
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 to czat między aplikacją do obsługi czatu a jedną osobą.
threaded
(deprecated)

boolean

Tylko dane wyjściowe. Wycofane: użyj atrybutu spaceThreadingState. 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 displayName pojawi się komunikat o błędzie ALREADY_EXISTS, spróbuj użyć innego rozwiązania displayName. Ta wyświetlana nazwa może już istnieć w organizacji Google Workspace.

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

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

boolean

Stała. Określa, czy do pokoju może dołączyć dowolny użytkownik Google Chat. Pole 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. W pokojach w trybie importowania mogą uczestniczyć tylko użytkownicy z tej samej organizacji Google Workspace.

W przypadku istniejących pokoi to pole wyświetla się tylko w danych wyjściowych.
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 Import Mode w ramach migracji danych do Google Workspace. Podczas importowania pokoi nie będą widoczne dla użytkowników, dopóki import się nie zakończy.

createTime

string (Timestamp format)

Opcjonalnie. w przypadku pokoi utworzonych w Google Chat, data utworzenia pokoju; To pole wyświetla się tylko w danych wyjściowych, chyba że jest używane w importowanych pokojach.

W przypadku zaimportowanych pokoi ustaw w tym polu historyczną sygnaturę czasową, w której 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.

adminInstalled

boolean

Tylko dane wyjściowe. Wskazuje, czy aplikacja Google Chat została zainstalowana przez administratora Google Workspace. Administratorzy mogą zainstalować aplikację do obsługi czatu dla swojej domeny, jednostki organizacyjnej lub grupy użytkowników.

Administratorzy mogą instalować aplikacje do obsługi czatu tylko w przypadku czatów między użytkownikami a aplikacją. Aby aplikacja była instalowana przez administratora, musi obsługiwać czat.

Typ

Wycofane: użyj atrybutu 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 Google Chat, w której wszystkie wiadomości są płaskie. Pamiętaj, że nie dotyczy to czatów między 2 osobami.

Typ Przestrzeni

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

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

SpaceThreadingState

Określa typ stanu podziału na wątki w pokoju czatu.

Wartości w polu enum
SPACE_THREADING_STATE_UNSPECIFIED Zarezerwowany.
THREADED_MESSAGES Pokoje z nazwą obsługujące wątki wiadomości. Gdy użytkownicy odpowiadają na wiadomość, mogą odpowiedzieć w wątku, co zachowa swoją odpowiedź w kontekście pierwotnej 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.

Szczegóły pokoju

szczegółowe informacje o pokoju, w tym jego opis i reguły;

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

string

Opcjonalnie. Opis pokoju. Na przykład opisz temat dyskusji w pokoju, jego funkcję lub uczestników.

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

string

Opcjonalnie. Zasady, oczekiwania i etykieta pokoju.

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

Metody

completeImport

 Przeprowadza proces importowania dla określonego pokoju i udostępni go użytkownikom.

create

 Tworzy pokój nazwany.

delete

 Usuwa pokój nazwany.

findDirectMessage

 Zwraca dotychczasowy czat z określonym użytkownikiem.

get

 Zwraca 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.