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,   "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. }
Campi
name

string

Identificatore. Nome risorsa dello spazio.

Formato: spaces/{space}

Dove {space} rappresenta l'ID assegnato dal sistema allo spazio. Puoi ottenere l'ID spazio chiamando il metodo spaces.list() o dall'URL dello spazio. Ad esempio, se l'URL dello spazio è https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA, l'ID spazio è AAAAAAAAA.

type
(deprecated)

enum (Type)

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

spaceType

enum (SpaceType)

(Facoltativo) Il tipo di spazio. Obbligatorio quando crei uno spazio o aggiorni il tipo di spazio. Solo output per altri utilizzi.

singleUserBotDm

boolean

(Facoltativo) Se lo spazio è un messaggio diretto tra un'app di chat e una singola persona.

threaded
(deprecated)

boolean

Solo output. Deprecato: utilizza spaceThreadingState. Se i messaggi sono organizzati in thread in questo spazio.

displayName

string

(Facoltativo) Il nome visualizzato dello spazio. Obbligatorio quando crei uno spazio con un spaceType di SPACE. Se ricevi il messaggio di errore ALREADY_EXISTS quando crei uno spazio o aggiorni il displayName, prova un altro displayName. Uno spazio esistente all'interno dell'organizzazione Google Workspace potrebbe già utilizzare questo nome visualizzato.

Per i messaggi diretti, questo campo potrebbe essere vuoto.

Supporta fino a 128 caratteri.

externalUserAllowed

boolean

(Facoltativo) 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 è aperto a qualsiasi utente di Google Chat.

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

spaceThreadingState

enum (SpaceThreadingState)

Solo output. Lo stato dei thread nello spazio di Chat.

spaceDetails

object (SpaceDetails)

(Facoltativo) Dettagli sullo spazio, inclusi descrizione e regole.

spaceHistoryState

enum (HistoryState)

(Facoltativo) Lo stato della cronologia dei messaggi per i messaggi e i thread in questo spazio.

importMode

boolean

(Facoltativo) 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 finché non viene completata.

La creazione di uno spazio in Import Mode richiede l'autenticazione dell'utente.

createTime

string (Timestamp format)

(Facoltativo) Immutabile. Per gli spazi creati in Chat, l'ora in cui è stato creato lo spazio. Questo campo è solo di output, tranne quando viene 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 conservare l'ora di creazione originale.

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

lastActiveTime

string (Timestamp format)

Solo output. Timestamp dell'ultimo messaggio nello spazio.

adminInstalled

boolean

Solo output. Per gli spazi di messaggi diretti con un'app di chat, se lo spazio è stato creato da un amministratore di Google Workspace. Gli amministratori possono installare e configurare un messaggio diretto con un'app di chat per conto degli utenti della propria organizzazione.

Per supportare l'installazione da parte dell'amministratore, l'app di chat deve includere la messaggistica diretta.

membershipCount

object (MembershipCount)

Solo output. Il conteggio degli abbonamenti sottoscritti raggruppati per tipo di membro. Viene compilato quando spaceType è SPACE, DIRECT_MESSAGE o GROUP_CHAT.

accessSettings

object (AccessSettings)

(Facoltativo) Specifica l'impostazione di accesso dello spazio. Compilato solo quando spaceType è SPACE.

spaceUri

string

Solo output. L'URI per l'accesso di un utente allo spazio.

importModeExpireTime

string (Timestamp format)

Solo output. Il momento in cui lo spazio verrà eliminato automaticamente dal sistema se rimane in modalità di importazione.

Ogni spazio creato in modalità di importazione deve uscire da questa modalità prima della scadenza utilizzando spaces.completeImport.

Questo campo viene compilato solo per gli spazi creati con la modalità di importazione.

customer

string

(Facoltativo) Immutabile. L'ID cliente del dominio dello spazio. Obbligatorio solo quando si crea uno spazio con autenticazione dell'app e SpaceType è SPACE, altrimenti non deve essere impostato.

Nel formato customers/{customer}, dove customer è id della risorsa cliente dell'SDK Admin. Le app private possono anche utilizzare l'alias customers/my_customer per creare lo spazio nella stessa organizzazione Google Workspace dell'app.

Per i messaggi diretti, questo campo non viene compilato.

Campo unione space_permission_settings. Rappresenta le impostazioni delle autorizzazioni di uno spazio. Compilato solo quando space_type è SPACE. space_permission_settings può essere solo uno dei seguenti:
predefinedPermissionSettings

enum (PredefinedPermissionSettings)

(Facoltativo) Solo input. Impostazioni delle autorizzazioni dello spazio predefinite, inserite solo al momento della creazione di uno spazio. Se il campo non è impostato, viene creato uno spazio di collaborazione. Dopo aver creato lo spazio, le impostazioni vengono compilate nel campo PermissionSettings.

L'impostazione di autorizzazioni predefinite supporta:

permissionSettings

object (PermissionSettings)

(Facoltativo) Impostazioni delle autorizzazioni dello spazio per gli spazi esistenti. Input per l'aggiornamento delle impostazioni delle autorizzazioni esatte per lo spazio, in cui le impostazioni delle autorizzazioni esistenti vengono sostituite. Elenca le impostazioni di autorizzazione correnti.

La lettura e l'aggiornamento delle impostazioni delle autorizzazioni supportano:

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 semplici. Tieni presente che non sono inclusi i messaggi diretti tra due persone.

SpaceType

Il tipo di spazio. Obbligatorio durante la creazione o l'aggiornamento di uno spazio. Solo output 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 tra una persona e un'app di chat.

SpaceThreadingState

Specifica il tipo di stato del 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 farlo all'interno del thread, in modo che la risposta rimanga nel contesto del messaggio originale.
GROUPED_MESSAGES Spazi denominati in cui la conversazione è organizzata per argomento. Gli argomenti e le relative risposte vengono raggruppati.
UNTHREADED_MESSAGES Messaggi diretti (DM) tra due persone e conversazioni di gruppo tra tre o più persone.

SpaceDetails

Dettagli sullo spazio, inclusi descrizione e regole.

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

string

(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

(Facoltativo) Le regole, le aspettative e l'etichetta dello spazio.

Supporta fino a 5000 caratteri.

HistoryState

Lo stato della cronologia per i messaggi e gli 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. I messaggi e i thread vengono conservati per 24 ore.
HISTORY_ON Cronologia attivata. Le regole di conservazione di Vault dell'organizzazione specificano per quanto tempo vengono conservati i messaggi e i thread.

MembershipCount

Rappresenta il conteggio delle iscrizioni a uno spazio, raggruppate in categorie.

Rappresentazione JSON
{   "joinedDirectHumanUserCount": integer,   "joinedGroupCount": integer }
Campi
joinedDirectHumanUserCount

integer

Solo output. Conteggio degli utenti umani che hanno aderito direttamente allo spazio, senza contare gli utenti che hanno aderito in quanto membri di un gruppo a cui è stato eseguito l'accesso.

joinedGroupCount

integer

Solo output. Conteggio di tutti i gruppi che hanno aderito direttamente allo spazio.

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 dello spazio.

audience

string

(Facoltativo) Il nome della risorsa del pubblico di destinazione che può scoprire lo spazio, parteciparvi e visualizzare l'anteprima dei messaggi nello spazio. Se non è impostato, possono accedervi solo gli utenti o i Google Gruppi che sono stati invitati o aggiunti singolarmente allo spazio. Per maggiori dettagli, vedi Rendere uno spazio rilevabile per un pubblico di destinazione.

Formato: audiences/{audience}

Per utilizzare il pubblico di destinazione predefinito per l'organizzazione Google Workspace, imposta il valore su audiences/default.

La lettura del pubblico di destinazione supporta:

Questo campo non viene compilato quando utilizzi l'ambito chat.bot con l'autenticazione dell'app.

L'impostazione del pubblico di destinazione richiede l'autenticazione utente.

AccessState

Rappresenta lo stato di accesso allo spazio.

Enum
ACCESS_STATE_UNSPECIFIED Lo stato di accesso è sconosciuto o non supportato in questa API.
PRIVATE Solo gli utenti o i Google Gruppi aggiunti o invitati singolarmente da altri utenti o amministratori di Google Workspace possono scoprire e accedere allo spazio.
DISCOVERABLE

Un gestore dello spazio ha concesso a un pubblico di destinazione l'accesso allo spazio. Anche gli utenti o i Google Gruppi che sono stati aggiunti o invitati singolarmente allo spazio possono scoprirlo e accedervi. Per saperne di più, vedi Rendere uno spazio rilevabile per utenti specifici.

La creazione di spazi rilevabili richiede l'autenticazione utente.

PredefinedPermissionSettings

Impostazioni delle autorizzazioni predefinite che puoi specificare solo quando crei uno spazio denominato. In futuro potrebbero essere aggiunte altre impostazioni. Per informazioni dettagliate sulle impostazioni delle autorizzazioni per gli spazi denominati, vedi Informazioni sugli spazi.

Enum
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED Non specificato. Non utilizzare.
COLLABORATION_SPACE Impostazione per trasformare lo spazio in uno spazio di collaborazione in cui tutti i membri possono pubblicare messaggi.
ANNOUNCEMENT_SPACE Impostazione per trasformare lo spazio in uno spazio per gli annunci in cui solo i gestori dello spazio possono pubblicare messaggi.

PermissionSettings

Impostazioni delle autorizzazioni che puoi specificare quando aggiorni uno spazio personale esistente.

Per impostare le impostazioni delle autorizzazioni durante la creazione di uno spazio, specifica il campo PredefinedPermissionSettings nella richiesta.

Rappresentazione 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)   } }
Campi
manageMembersAndGroups

object (PermissionSetting)

(Facoltativo) Impostazione per la gestione di membri e gruppi in uno spazio.

modifySpaceDetails

object (PermissionSetting)

(Facoltativo) Impostazione per l'aggiornamento del nome, dell'avatar, della descrizione e delle linee guida dello spazio.

toggleHistory

object (PermissionSetting)

(Facoltativo) Impostazione per attivare e disattivare la cronologia dello spazio.

useAtMentionAll

object (PermissionSetting)

(Facoltativo) Impostazione per l'utilizzo di @tutti in uno spazio.

manageApps

object (PermissionSetting)

(Facoltativo) Impostazione per la gestione delle app in uno spazio.

manageWebhooks

object (PermissionSetting)

(Facoltativo) Impostazione per la gestione dei webhook in uno spazio.

postMessages

object (PermissionSetting)

Solo output. Impostazione per la pubblicazione di messaggi in uno spazio.

replyMessages

object (PermissionSetting)

(Facoltativo) Impostazione per rispondere ai messaggi in uno spazio.

PermissionSetting

Rappresenta un'impostazione delle autorizzazioni dello spazio.

Rappresentazione JSON
{   "managersAllowed": boolean,   "membersAllowed": boolean }
Campi
managersAllowed

boolean

(Facoltativo) Se i gestori degli spazi dispongono di questa autorizzazione.

membersAllowed

boolean

(Facoltativo) Se i membri non gestori dispongono di questa autorizzazione.

Metodi

completeImport

Completa il processo di importazione per lo spazio specificato e lo rende visibile agli utenti.

create

Crea uno spazio.

delete

Elimina uno spazio denominato.

findDirectMessage

Restituisce il messaggio diretto esistente con l'utente specificato.

get

Restituisce i dettagli di uno spazio.

list

Elenca gli spazi di cui il chiamante è membro.

patch

Aggiorna uno spazio.
Restituisce un elenco di spazi in un'organizzazione Google Workspace in base alla ricerca di un amministratore.

setup

Crea uno spazio e vi aggiunge gli utenti specificati.