REST Resource: spaces

Risorsa: Space

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,
  "sessionState": enum (SpaceSessionState),
  "sessionEnableTime": string,
  "importModeExpireTime": string,
  "customer": string,

  "predefinedPermissionSettings": enum (PredefinedPermissionSettings),
  "permissionSettings": {
    object (PermissionSettings)
  }
}
Campi
name

string

Identificatore. Nome della risorsa dello spazio.

Formato: spaces/{space}

Dove {space} rappresenta l'ID assegnato dal sistema per lo 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. Ritirato: utilizza invece 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. Indica se lo spazio è un DM tra un'app di Chat e un singolo essere umano.
threaded
(deprecated)

boolean

Solo output. Ritirato: utilizza invece spaceThreadingState. Indica 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 displayName, prova con 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 consente l'accesso a qualsiasi utente di Google Chat.

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

enum (SpaceThreadingState)

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

object (SpaceDetails)

Facoltativo. Dettagli sullo spazio, tra cui 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. Indica se questo spazio è stato creato in Import Mode nell'ambito di una migrazione dei dati a Google Workspace. Durante l'importazione, gli spazi non sono visibili agli utenti fino al completamento dell'operazione.

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

string (Timestamp format)

Facoltativo. Immutabile. Per gli spazi creati in Chat, l'ora in cui è stato creato lo spazio. Questo campo è di solo 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 lo spazio è stato creato 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 loro organizzazione.

Per supportare l'installazione da parte dell'amministratore, l'app di Chat deve disporre della funzionalità di messaggistica diretta.
membershipCount

object (MembershipCount)

Solo output. Il numero di abbonamenti sottoscritti raggruppati per tipo di abbonato. 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 che un utente può utilizzare per accedere allo spazio.
sessionState

enum (SpaceSessionState)

Solo output. Stato della sessione dello spazio.
sessionEnableTime

string (Timestamp format)

Solo output. Timestamp in cui lo stato del supporto della sessione dello spazio diventa supportato. Non impostato se lo spazio non ha il supporto delle sessioni abilitato.
importModeExpireTime

string (Timestamp format)

Solo output. L'ora 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 è il 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.

Questo campo non viene compilato per i messaggi diretti o quando lo spazio viene creato da utenti non Google Workspace.
Rappresenta le impostazioni delle autorizzazioni di uno spazio. Compilato solo quando space_type è SPACE. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi:
predefinedPermissionSettings

enum (PredefinedPermissionSettings)

Facoltativo. Solo input. Impostazioni dei set di autorizzazioni dello spazio predefinite, inserite solo durante la 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.

La configurazione di set di autorizzazioni predefiniti supporta:
permissionSettings

object (PermissionSettings)

Facoltativo. Impostazioni delle autorizzazioni per gli spazi esistenti. Input per l'aggiornamento delle impostazioni di autorizzazione esatte dello spazio, in cui le impostazioni di autorizzazione esistenti vengono sostituite. L'output elenca le impostazioni di autorizzazione correnti.

La lettura e l'aggiornamento delle impostazioni delle autorizzazioni supportano:
Fine dei campi che si escludono a vicenda.

Tipo

Ritirato: utilizza invece SpaceType.

Enum
TYPE_UNSPECIFIED Riservato.
ROOM Conversazioni tra due o più persone.
DM Messaggio diretto 1:1 tra un essere umano e un'app di Chat, in cui tutti i messaggi sono piatti. Tieni presente che questo non include i messaggi diretti tra due persone.

SpaceType

Il tipo di spazio. Obbligatorio quando crei o aggiorni 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 dei thread nello spazio di Chat.

Enum
SPACE_THREADING_STATE_UNSPECIFIED Riservato.
THREADED_MESSAGES Spazi che supportano i thread di messaggi. Quando gli utenti rispondono a un messaggio, possono farlo all'interno del 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

Spazi che non supportano i thread di messaggi. Questo stato dei thread dello spazio viene utilizzato solo per casi speciali, tra cui:

  • Chat continua della riunione in cui i thread sono disattivati intenzionalmente.
  • Conversazioni di gruppo legacy create prima del 2022.

SpaceDetails

Dettagli sullo spazio, tra cui 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 4096 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 i messaggi e i thread di conversazione vengono conservati 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 numero di iscrizioni a uno spazio, raggruppate in categorie.

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

integer

Solo output. Numero di utenti umani che hanno partecipato direttamente allo spazio, esclusi gli utenti che hanno partecipato perché membri di un gruppo che ha partecipato.
joinedGroupCount

integer

Solo output. Numero di tutti i gruppi che hanno partecipato direttamente allo spazio.

AccessSettings

Rappresenta l'impostazione di accesso dello spazio.

Rappresentazione JSON 
{
  "accessState": enum (AccessState),
  "audience": string,
  "accessPermissionSettings": {
    object (AccessPermissionSettings)
  }
}
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 al suo interno. Se non viene impostato, solo gli utenti o i gruppi Google che sono stati invitati o aggiunti singolarmente allo spazio possono accedervi. Per maggiori dettagli, vedi Rendi uno spazio rilevabile per un pubblico di destinazione.

Formato: audiences/{audience}

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

La lettura del pubblico di destinazione supporta:

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

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

object (AccessPermissionSettings)

Facoltativo. Accedi alle impostazioni dei set di autorizzazioni per lo spazio.

Per impostare il pubblico di destinazione durante la creazione di uno spazio, specifica il campo accessSettings.audience nella richiesta.

AccessState

Rappresenta lo stato di accesso dello spazio.

Enum
ACCESS_STATE_UNSPECIFIED Lo stato di accesso è sconosciuto o non supportato in questa API.
PRIVATE Solo gli utenti o i gruppi Google che sono stati 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 l'accesso allo spazio a un pubblico di destinazione. Anche gli utenti o i gruppi Google che sono stati aggiunti o invitati singolarmente allo spazio possono trovarlo e accedervi. Per saperne di più, vedi Rendi uno spazio rilevabile per utenti specifici.

La creazione di spazi rilevabili richiede l'autenticazione dell'utente.

AccessPermissionSettings

Accedi alle impostazioni dei set di autorizzazioni per uno spazio.

Rappresentazione JSON 
{
  "discoverSpaceSetting": {
    object (AccessPermissionSetting)
  },
  "joinSpaceSetting": {
    object (AccessPermissionSetting)
  },
  "viewSpaceMembershipSetting": {
    object (AccessPermissionSetting)
  }
}
Campi
discoverSpaceSetting

object (AccessPermissionSetting)

Facoltativo. Impostazione del set di autorizzazioni per la scoperta dello spazio.
joinSpaceSetting

object (AccessPermissionSetting)

Facoltativo. Impostazione del set di autorizzazioni per partecipare allo spazio.
viewSpaceMembershipSetting

object (AccessPermissionSetting)

Facoltativo. Impostazione dell'autorizzazione di accesso per la visualizzazione dell'iscrizione allo spazio. Deve essere specificato insieme a PermissionSettings.view_space_membership nella maschera di aggiornamento e nel corpo della richiesta quando si aggiorna chi può visualizzare l'iscrizione allo spazio. Quando concedi l'accesso in visualizzazione a un pubblico di destinazione, devi anche concedere PermissionSettings.view_space_membership a tutti i membri nella stessa richiesta. Per rimuovere un pubblico di destinazione esistente (ad esempio, per limitare l'accesso in visualizzazione solo ai gestori o ai gestori assistenti dello spazio), specifica un AccessPermissionSetting vuoto (senza principals).

AccessPermissionSetting

Un'impostazione delle autorizzazioni di accesso.

Rappresentazione JSON 
{
  "principals": [
    {
      object (Principal)
    }
  ]
}
Campi
principals[]

object (Principal)

Facoltativo. Elenco non ordinato. Entità consentite per questa autorizzazione.

Entità

Un'entità che rappresenta un'entità a cui è stato concesso l'accesso.

Rappresentazione JSON 
{

  "audience": {
    object (Audience)
  }
}
Campi
Il tipo di entità. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi:
audience

object (Audience)

Un segmento di pubblico.
Fine dei campi che si escludono a vicenda.

Pubblico

Un pubblico di destinazione in Google Chat. Un pubblico di destinazione rappresenta un gruppo di utenti all'interno di un'organizzazione Google Workspace, definito da un amministratore. I segmenti di pubblico di destinazione vengono utilizzati per configurare le impostazioni di accesso e visibilità per le risorse, ad esempio per rendere uno spazio rilevabile da un gruppo specifico di utenti.

Per maggiori dettagli, vedi Pubblico di destinazione e Rendere uno spazio rilevabile da un pubblico di destinazione.

Rappresentazione JSON 
{
  "name": string
}
Campi
name

string

Il nome della risorsa del pubblico di destinazione che può scoprire o partecipare allo spazio. Per maggiori dettagli, vedi Rendi uno spazio rilevabile per un pubblico di destinazione. Formato: audiences/{audience}

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

PredefinedPermissionSettings

Impostazioni di autorizzazione predefinite che puoi specificare solo durante la creazione di uno spazio con nome. In futuro è possibile che vengano aggiunte altre impostazioni. Per maggiori dettagli sulle impostazioni di autorizzazione per gli spazi con nome, consulta Scopri di più sugli spazi.

Enum
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED Non specificato. Non utilizzare.
COLLABORATION_SPACE Impostazione per rendere lo spazio uno spazio di collaborazione in cui tutti i membri possono pubblicare messaggi.
ANNOUNCEMENT_SPACE Impostazione per rendere lo spazio 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 con nome esistente.

Per impostare le 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)
  },
  "viewSpaceMembership": {
    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 @all 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.
viewSpaceMembership

object (PermissionSetting)

Facoltativo. Impostazione per la visualizzazione dell'abbonamento allo spazio. Deve essere specificato insieme a AccessPermissionSettings.view_space_membership_setting nella maschera di aggiornamento e nel corpo della richiesta quando si aggiorna chi può visualizzare l'iscrizione allo spazio. Quando limiti l'accesso in visualizzazione a ruoli specifici (ad esempio, solo gestori dello spazio o assistenti gestori), specifica qui le autorizzazioni del ruolo desiderate e fornisci un AccessPermissionSettings.view_space_membership_setting vuoto nella stessa richiesta. Se in AccessPermissionSettings.view_space_membership_setting è configurato un pubblico di destinazione, questa impostazione deve essere concessa a tutti i membri.

PermissionSetting

Rappresenta un set di autorizzazioni per uno spazio.

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

boolean

Facoltativo. Indica se i proprietari dello spazio (ROLE_MANAGER) dispongono di questa autorizzazione.
membersAllowed

boolean

Facoltativo. Indica se i membri di base dello spazio (ROLE_MEMBER) dispongono di questa autorizzazione.
assistantManagersAllowed

boolean

Facoltativo. Se i gestori dello spazio ROLE_ASSISTANT_MANAGER) dispongono di questa autorizzazione.

SpaceSessionState

Stato della sessione dello spazio.

Enum
SPACE_SESSION_STATE_UNSPECIFIED Non specificato. Non utilizzare.
NOT_SUPPORTED Lo spazio non supporta le sessioni.
THREAD Lo spazio supporta la sessione basata su thread.

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 con nome.

findDirectMessage

 Restituisce il messaggio diretto esistente con l'utente specificato.

findGroupChats

 Restituisce tutti gli spazi con spaceType == GROUP_CHAT, le cui iscrizioni umane contengono esattamente l'utente chiamante e gli utenti specificati in FindGroupChatsRequest.users.

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.

setup

 Crea uno spazio e vi aggiunge gli utenti specificati.