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,

  // 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

Nome risorsa dello spazio.

Formato: spaces/{space}
type
(deprecated)

enum (Type)

Solo output. Deprecato: usa invece spaceType. Il tipo di uno spazio.
spaceType

enum (SpaceType)

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

boolean

Campo facoltativo. Indica se lo spazio è un messaggio diretto tra un'app di Chat e un singolo essere umano.
threaded
(deprecated)

boolean

Solo output. Deprecato: usa invece 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. Questo nome visualizzato potrebbe essere già utilizzato da uno spazio esistente all'interno dell'organizzazione Google Workspace.

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

Questo campo viene restituito solo per gli spazi esistenti.
spaceThreadingState

enum (SpaceThreadingState)

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

object (SpaceDetails)

Dettagli sullo spazio, tra cui descrizione e 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 è stato creato in Import Mode nell'ambito di una migrazione dei dati in Google Workspace. Durante l'importazione, gli spazi non saranno 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 viene solo generato, 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 in modo da 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 (DM) 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 degli amministratori, l'app Chat deve includere la messaggistica diretta.
membershipCount

object (MembershipCount)

Solo output. Il numero di iscrizioni raggruppate per tipo di membro. Compilato quando spaceType è SPACE, DIRECT_MESSAGE o GROUP_CHAT.

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.

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

enum (PredefinedPermissionSettings)

Campo facoltativo. Solo input. Impostazioni di autorizzazione dello spazio. Input per la creazione di uno spazio, se questo campo non viene impostato viene creato uno spazio di collaborazione. Dopo aver creato lo spazio, le impostazioni vengono compilate nel campo PermissionSettings.

permissionSettings

object (PermissionSettings)

Campo facoltativo. Impostazioni di autorizzazione esatte che possono essere impostate per aggiornare lo spazio. Input per l'aggiornamento di uno spazio. In caso contrario, solo output. Per la creazione dello spazio, usa invece predefinedPermissionSettings.

Tipo

Deprecato: usa invece SpaceType.

Enum
TYPE_UNSPECIFIED Riservato.
ROOM Conversazioni tra due o più persone.
DM Messaggio diretto 1:1 tra un utente e un'app di Chat, in cui tutti i messaggi sono piatti. 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, conservando 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 insieme.
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

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. 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 la durata di conservazione dei messaggi e dei thread.

MembershipCount

Rappresenta il numero di appartenenze a uno spazio, raggruppate in categorie.

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

integer

Numero di utenti umani che si sono uniti direttamente allo spazio, senza contare quelli che si sono uniti per aver aderito a un gruppo.
joinedGroupCount

integer

Numero di tutti i gruppi che sono entrati direttamente nello 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 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 configurare lo spazio con l'impostazione di accesso predefinita nella Console di amministrazione. Per saperne di più, consulta Rendere uno spazio rilevabile per un pubblico di destinazione. Annulla l'impostazione di questo campo per limitare lo spazio. Compilato solo quando lo spazio è rilevabile. Formato: audiences/{audience}, audiences/default può essere utilizzato come alias dell'impostazione di condivisione predefinita di 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 è rilevabile da membri o gruppi aggiunti o invitati.
DISCOVERABLE Lo spazio è rilevabile dal pubblico di destinazione selezionato e dai membri o gruppi aggiunti o invitati.

PredefinedPermissionSettings

Le impostazioni delle autorizzazioni per lo spazio che puoi specificare quando crei uno spazio denominato. In futuro potrebbero essere aggiunte altre impostazioni. Per maggiori dettagli sulle impostazioni delle autorizzazioni per gli spazi denominati, vedi 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 per uno spazio denominato. Per configurare le impostazioni di autorizzazione quando crei 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)

Impostazione per la gestione di membri e gruppi in uno spazio.
modifySpaceDetails

object (PermissionSetting)

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

object (PermissionSetting)

Impostazione per attivare e disattivare la cronologia degli spazi.
useAtMentionAll

object (PermissionSetting)

Impostazione per l'utilizzo di @tutti in uno spazio.
manageApps

object (PermissionSetting)

Impostazione per la gestione delle app in uno spazio.
manageWebhooks

object (PermissionSetting)

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)

Impostazione per rispondere ai messaggi in uno spazio.

PermissionSetting

Rappresenta un'impostazione di autorizzazione dello spazio.

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

boolean

Indica se i gestori degli spazi hanno questa autorizzazione.
membersAllowed

boolean

Indica se i membri non amministratori 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 denominato.

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.

setup

 Crea uno spazio e vi aggiunge utenti specificati.