REST Resource: spaces

Risorsa: spazio

Uno spazio in Google Chat. Gli spazi sono conversazioni tra due o più utenti o messaggi 1:1 tra un utente e un'app di Chat.

Rappresentazione 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)
  },
  "spaceUri": string
}
Campi
name

string

Nome della risorsa dello spazio.

Formato: spaces/{space}
type
(deprecated)

enum (Type)

Solo output. Deprecato: utilizza spaceType. Il tipo di spazio.
spaceType

enum (SpaceType)

Il tipo di spazio. Opzione obbligatoria quando crei uno spazio o ne aggiorni il tipo. Output solo per altri utilizzi.
singleUserBotDm

boolean

Campo facoltativo. Se lo spazio è un messaggio diretto tra un'app di Chat e una singola persona.
threaded
(deprecated)

boolean

Solo output. Deprecato: utilizza spaceThreadingState. Indica se i messaggi sono organizzati in thread in questo spazio.
displayName

string

Il nome visualizzato dello spazio. Obbligatorio durante la creazione di uno spazio. Se ricevi il messaggio di errore ALREADY_EXISTS durante la creazione di uno spazio o l'aggiornamento di displayName, prova con un altro displayName. Uno spazio esistente all'interno dell'organizzazione Google Workspace potrebbe utilizzare già questo nome visualizzato.

Per i messaggi diretti, questo campo potrebbe essere vuoto.

Supporta fino a 128 caratteri.
externalUserAllowed

boolean

Immutabile. Indica se questo spazio consente a qualsiasi utente di Google Chat di diventare membro. Input durante la creazione di uno spazio in un'organizzazione Google Workspace. Ometti questo campo quando crei spazi nelle seguenti condizioni:

  • L'utente autenticato utilizza un account consumer (account utente non gestito). Per impostazione predefinita, uno spazio creato da un account consumer consente a qualsiasi utente di Google Chat.

  • Lo spazio viene utilizzato per importare dati in Google Chat perché gli spazi in modalità di importazione devono autorizzare solo i membri della stessa organizzazione Google Workspace. Tuttavia, nell'ambito del Programma Anteprima per gli sviluppatori di Google Workspace, gli spazi in modalità di importazione possono consentire a qualsiasi utente di Google Chat, quindi questo campo può essere impostato per gli spazi in modalità di importazione.

Per gli spazi esistenti, questo campo è solo di output.
spaceThreadingState

enum (SpaceThreadingState)

Solo output. Lo stato dell'organizzazione in thread nello spazio di Chat.
spaceDetails

object (SpaceDetails)

Dettagli sullo spazio, incluse la descrizione e le regole.
spaceHistoryState

enum (HistoryState)

Lo stato della cronologia dei messaggi per i messaggi e i thread in questo spazio.
importMode

boolean

Campo facoltativo. Indica se questo spazio viene creato in Import Mode nell'ambito di una migrazione dei dati in Google Workspace. Durante l'importazione, gli spazi non sono visibili agli utenti fino al completamento dell'importazione.
createTime

string (Timestamp format)

Campo facoltativo. Immutabile. Per gli spazi creati in Chat, la data e l'ora di creazione dello spazio. Questo campo è solo di output, tranne quando è utilizzato negli spazi in modalità di importazione.

Per gli spazi in modalità di importazione, imposta questo campo sul timestamp storico in cui è stato creato lo spazio nell'origine per preservare la data e l'ora di creazione originale.

Compilato nell'output solo quando spaceType è GROUP_CHAT o SPACE.
adminInstalled

boolean

Solo output. Se l'app Chat è stata installata da un amministratore di Google Workspace. Gli amministratori possono installare un'app di chat per il proprio dominio, la propria unità organizzativa o un gruppo di utenti.

Gli amministratori possono installare app di chat solo per la messaggistica diretta tra gli utenti e l'app. Per supportare l'installazione come amministratore, l'app deve includere la messaggistica diretta.
accessSettings

object (AccessSettings)

Campo facoltativo. Specifica l'impostazione di accesso dello spazio. Compilato solo quando spaceType è SPACE.

spaceUri

string

Solo output. L'URI dello spazio.

Tipo

Deprecato: utilizza SpaceType.

Enum
TYPE_UNSPECIFIED Riservato.
ROOM Conversazioni tra due o più persone.
DM Messaggio diretto 1:1 tra una persona e un'app di Chat, in cui tutti i messaggi sono flat. Tieni presente che non sono inclusi i messaggi diretti tra due persone.

SpaceType

Il tipo di spazio. Obbligatorio quando crei o aggiorni uno spazio. Output solo per altri utilizzi.

Enum
SPACE_TYPE_UNSPECIFIED Riservato.
SPACE Un luogo in cui le persone inviano messaggi, condividono file e collaborano. Un SPACE può includere app di chat.
GROUP_CHAT Conversazioni di gruppo tra 3 o più persone. Un GROUP_CHAT può includere app di chat.
DIRECT_MESSAGE Messaggi 1:1 tra due persone o una persona e un'app di chat.

SpaceThreadingState

Specifica il tipo di stato dei thread nello spazio di Chat.

Enum
SPACE_THREADING_STATE_UNSPECIFIED Riservato.
THREADED_MESSAGES Spazi con nome che supportano i thread di messaggi. Quando gli utenti rispondono a un messaggio, possono rispondere in-thread, mantenendo la risposta nel contesto del messaggio originale.
GROUPED_MESSAGES Spazi con nome in cui la conversazione è organizzata per argomento. Gli argomenti e le relative risposte vengono raggruppati.
UNTHREADED_MESSAGES Messaggi diretti tra due persone e conversazioni di gruppo tra tre o più persone.

SpaceDetails

Dettagli sullo spazio, incluse la descrizione e le regole.

Rappresentazione JSON 
{
  "description": string,
  "guidelines": string
}
Campi
description

string

Campo facoltativo. Una descrizione dello spazio. Ad esempio, descrivi l'argomento di discussione, lo scopo funzionale o i partecipanti dello spazio.

Supporta fino a 150 caratteri.
guidelines

string

Campo facoltativo. Regole, aspettative ed etichetta dello spazio.

Supporta fino a 5000 caratteri.

HistoryState

Lo stato della cronologia di messaggi e spazi. Specifica per quanto tempo vengono conservati i messaggi e i thread di conversazione dopo la creazione.

Enum
HISTORY_STATE_UNSPECIFIED Valore predefinito. Non utilizzare.
HISTORY_OFF Cronologia disattivata. Messaggi e thread vengono conservati per 24 ore.
HISTORY_ON Cronologia attiva. Le regole di conservazione di Vault dell'organizzazione specificano per quanto tempo vengono conservati i messaggi e i thread.

AccessSettings

Rappresenta l'impostazione di accesso dello spazio.

Rappresentazione JSON 
{
  "accessState": enum (AccessState),
  "audience": string
}
Campi
accessState

enum (AccessState)

Solo output. Indica lo stato di accesso allo spazio.
audience

string

Campo facoltativo. Il nome della risorsa del pubblico di destinazione che può accedere allo spazio. Imposta questo campo su un ID pubblico di destinazione valido per rendere lo spazio rilevabile oppure utilizza l'alias audiences/default per configurarlo con l'impostazione di accesso predefinita nella Console di amministrazione. Per saperne di più, vedi Rendere uno spazio rilevabile da un pubblico di destinazione. Annulla l'impostazione di questo campo per rendere lo spazio limitato. Compilato solo quando lo spazio è rilevabile. Formato: audiences/{audience}, audiences/default può essere utilizzato come alias dell'impostazione di condivisione predefinita della chat.

AccessState

Rappresenta lo stato di accesso allo spazio.

Enum
ACCESS_STATE_UNSPECIFIED Lo stato dell'accesso è sconosciuto o non supportato in questa API.
PRIVATE Lo spazio può essere trovato dai membri o dai gruppi aggiunti o invitati.
DISCOVERABLE Lo spazio può essere trovato dal pubblico di destinazione selezionato, nonché dai membri o gruppi aggiunti o invitati.

Metodi

completeImport

 Completa la procedura di importazione per lo spazio specificato e lo rende visibile agli utenti.

create

 Crea uno spazio con nome.

delete

 Elimina uno spazio denominato.

findDirectMessage

 Restituisce il messaggio diretto esistente con l'utente specificato.

get

 Restituisce i dettagli su uno spazio.

list

 Elenca gli spazi di cui è membro il chiamante.

patch

 Aggiorna uno spazio.

setup

 Crea uno spazio a cui vengono aggiunti utenti specifici.