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,
  "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 della 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 uno spazio.
spaceType

enum (SpaceType)

Facoltativo. Il tipo di spazio. Obbligatorio per la creazione o l'aggiornamento del tipo di uno spazio. Output solo per altri utilizzi.
singleUserBotDm

boolean

Facoltativo. Indica se lo spazio è un messaggio diretto tra un'app 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

Facoltativo. Il nome visualizzato dello spazio. Obbligatorio quando crei uno spazio con un spaceType pari a SPACE. Se ricevi il messaggio di errore ALREADY_EXISTS durante la creazione di uno spazio o l'aggiornamento del displayName, prova un displayName diverso. 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 essere membro. Input da inserire 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 è solo di output.
spaceThreadingState

enum (SpaceThreadingState)

Solo output. Lo stato della conversazione in 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 in Google Workspace. Durante l'importazione, gli spazi non sono visibili agli utenti finché l'operazione non è completata.

La creazione di uno spazio in Import Moderichiede 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 lo spazio è stato creato nell'origine per preservare l'ora di creazione originale.

Viene 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 con messaggi diretti (DM) con un'app di Chat, indica 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 amministratore, l'app Chat deve includere la messaggistica diretta.
membershipCount

object (MembershipCount)

Solo output. Il numero di abbonamenti uniti raggruppati per tipo di abbonamento. Viene compilato quando spaceType è SPACE, DIRECT_MESSAGE o GROUP_CHAT.
accessSettings

object (AccessSettings)

Facoltativo. Specifica l'impostazione di accesso dello spazio. Viene compilato solo quando spaceType è SPACE.
spaceUri

string

Solo output. L'URI per consentire a un utente di accedere allo spazio.
customer

string

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

Nel formato customers/{customer}, dove customer è id della [risorsa cliente dell'SDK Admin]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). 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 di autorizzazione di uno spazio. Viene compilato solo quando space_type è SPACE.

Richiede l'autenticazione utente. space_permission_settings può essere solo uno dei seguenti:
predefinedPermissionSettings

enum (PredefinedPermissionSettings)

Facoltativo. Solo input. Impostazioni predefinite per le autorizzazioni dello spazio, da inserire 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 inserite nel campo PermissionSettings.
permissionSettings

object (PermissionSettings)

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

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

SpaceType

Il tipo di spazio. Obbligatorio quando si crea o aggiorna 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 tra una persona e un'app di chat.

SpaceThreadingState

Specifica il tipo di stato di threading 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 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, tra cui descrizione e regole.

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

string

Facoltativo. Una descrizione dello spazio. Ad esempio, descrivi l'argomento della discussione, lo scopo funzionale o i partecipanti dello spazio.

Supporta fino a 150 caratteri.
guidelines

string

Facoltativo. Le regole, le aspettative e il galateo dello spazio.

Supporta fino a 5000 caratteri.

HistoryState

Lo stato della cronologia per messaggi e spazi. Specifica per quanto tempo conservare 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 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 adesioni a uno spazio, raggruppate in categorie.

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

integer

Solo output. Numero di utenti che si sono uniti direttamente allo spazio, esclusi gli utenti che si sono uniti tramite l'iscrizione a un gruppo unito.
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ò trovare lo spazio, partecipare e visualizzare l'anteprima dei messaggi. Se non è impostato, solo gli utenti o i gruppi Google che sono stati invitati o aggiunti singolarmente allo spazio possono accedervi. Per maggiori dettagli, vedi Rendere uno spazio rilevabile da un pubblico di destinazione.

Formato: audiences/{audience}

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

La lettura del pubblico di destinazione supporta:

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

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

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 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 aggiunti o invitati singolarmente allo spazio possono trovarlo e accedervi. Per scoprire di più, vedi Rendere uno spazio rilevabile per utenti specifici.

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

PredefinedPermissionSettings

Impostazioni di autorizzazione 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 con nome, vedi Informazioni 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 di autorizzazione che puoi specificare quando aggiorni uno spazio denominato esistente.

Per impostare le impostazioni di autorizzazione 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 aggiornare il nome, l'avatar, la descrizione e le 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 degli 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 di autorizzazione per lo spazio.

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

boolean

Facoltativo. Indica se i gestori degli spazi dispongono di questa autorizzazione.
membersAllowed

boolean

Facoltativo. Indica se i membri non gestori dispongono di questa autorizzazione.

Metodi

completeImport

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

create

 Crea uno spazio.

delete

 Consente di eliminare 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 l'utente che chiama è 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 aggiunge gli utenti specificati.