Method: spaces.setup

Crea uno spazio e aggiunge gli utenti specificati. L'utente che effettua la chiamata viene aggiunto automaticamente allo spazio e non deve essere specificato come appartenenza nella richiesta. Per un esempio, vedi Configurare uno spazio con i membri iniziali.

Per specificare i membri umani da aggiungere, aggiungi le adesioni con l'membership.member.name appropriato. Per aggiungere un utente, utilizza users/{user}, dove {user} può essere l'indirizzo email dell'utente. Per gli utenti della stessa organizzazione Workspace, {user} può anche essere il id della persona dell'API People o il id dell'utente nell'API Directory. Ad esempio, se l'ID profilo della persona dell'API People per user@example.com è 123456789, puoi aggiungere l'utente allo spazio impostando membership.member.name su users/user@example.com o users/123456789.

Per specificare i gruppi Google da aggiungere, aggiungi le iscrizioni con l'membership.group_member.name appropriato. Per aggiungere o invitare un gruppo Google, utilizza groups/{group}, dove {group} è il id del gruppo dall'API Cloud Identity Groups. Ad esempio, puoi utilizzare l'API di ricerca dei gruppi Cloud Identity per recuperare l'ID 123456789 per l'indirizzo email del gruppo group@example.com, quindi aggiungere il gruppo allo spazio impostando membership.group_member.name su groups/123456789. L'email di gruppo non è supportata e i gruppi Google possono essere aggiunti come membri solo negli spazi con nome.

Per uno spazio denominato o una chat di gruppo, se chi chiama blocca o viene bloccato da alcuni membri oppure non dispone dell'autorizzazione per aggiungerne alcuni, questi membri non vengono aggiunti allo spazio creato.

Per creare un messaggio diretto (DM) tra l'utente che chiama e un altro utente, specifica esattamente un'appartenenza per rappresentare l'utente. Se un utente blocca l'altro, la richiesta non va a buon fine e il messaggio diretto non viene creato.

Per creare un messaggio diretto tra l'utente che effettua la chiamata e l'app di chiamata, imposta Space.singleUserBotDm su true e non specificare alcun gruppo di appartenenza. Puoi utilizzare questo metodo solo per configurare un messaggio diretto con l'app di chiamata. Per aggiungere l'app di chiamata come membro di uno spazio o di un messaggio diretto esistente tra due utenti umani, consulta Invitare o aggiungere un utente o un'app a uno spazio.

Se tra due utenti esiste già un messaggio diretto, anche se un utente blocca l'altro al momento della richiesta, viene restituito il messaggio diretto esistente.

Gli spazi con risposte in thread non sono supportati. Se ricevi il messaggio di errore ALREADY_EXISTS durante la configurazione di uno spazio, prova un altro displayName. Uno spazio esistente all'interno dell'organizzazione Google Workspace potrebbe già utilizzare questo nome visualizzato.

Richiede l'autenticazione utente.

Richiesta HTTP

POST https://chat.googleapis.com/v1/spaces:setup

L'URL utilizza la sintassi di transcodifica gRPC.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "space": {
    object (Space)
  },
  "requestId": string,
  "memberships": [
    {
      object (Membership)
    }
  ]
}
Campi
space

object (Space)

Obbligatorio. Il campo Space.spaceType è obbligatorio.

Per creare uno spazio, imposta Space.spaceType su SPACE e imposta Space.displayName. Se ricevi il messaggio di errore ALREADY_EXISTS durante la configurazione di uno spazio, prova un altro displayName. Uno spazio esistente all'interno dell'organizzazione Google Workspace potrebbe già utilizzare questo nome visualizzato.

Per creare una chat di gruppo, imposta Space.spaceType su GROUP_CHAT. Non impostare Space.displayName.

Per creare una conversazione 1:1 tra persone, imposta Space.spaceType su DIRECT_MESSAGE e Space.singleUserBotDm su false. Non impostare Space.displayName o Space.spaceDetails.

Per creare una conversazione 1:1 tra una persona e l'app di Chat che effettua la chiamata, imposta Space.spaceType su DIRECT_MESSAGE e Space.singleUserBotDm su true. Non impostare Space.displayName o Space.spaceDetails.

Se esiste già uno spazio DIRECT_MESSAGE, viene restituito anziché crearne uno nuovo.
requestId

string

Facoltativo. Un identificatore univoco per questa richiesta. È consigliabile utilizzare un UUID casuale. Se specifichi un ID richiesta esistente, viene restituito lo spazio creato con quell'ID anziché crearne uno nuovo. Se specifichi un ID richiesta esistente della stessa app Chat con un utente autenticato diverso, viene restituito un errore.
memberships[]

object (Membership)

Facoltativo. Gli utenti o i gruppi di Google Chat da invitare a partecipare allo spazio. Ometti l'utente che chiama, poiché viene aggiunto automaticamente.

Al momento, il set consente fino a 49 abbonamenti (oltre a quello del chiamante).

Per l'appartenenza umana, il campo Membership.member deve contenere un user con name compilato (formato: users/{user}) e type impostato su User.Type.HUMAN. Puoi aggiungere solo utenti umani durante la configurazione di uno spazio (l'aggiunta di app di Chat è supportata solo per la configurazione dei messaggi diretti con l'app di chiamata). Puoi anche aggiungere membri utilizzando l'indirizzo email dell'utente come alias per {user}. Ad esempio, user.name può essere users/example@gmail.com. Per invitare utenti di Gmail o di domini Google Workspace esterni, è necessario utilizzare l'indirizzo email dell'utente per {user}.

Per l'appartenenza al gruppo Google, il campo Membership.group_member deve contenere un group con name compilato (formato groups/{group}). Puoi aggiungere gruppi Google solo impostando Space.spaceType su SPACE.

Facoltativo quando imposti Space.spaceType su SPACE.

Obbligatorio quando Space.spaceType è impostato su GROUP_CHAT, insieme ad almeno due adesioni.

Obbligatorio quando imposti Space.spaceType su DIRECT_MESSAGE con un utente umano, insieme a un solo abbonamento.

Deve essere vuoto quando viene creata una conversazione 1:1 tra una persona e l'app Chat che effettua la chiamata (quando Space.spaceType è impostato su DIRECT_MESSAGE e Space.singleUserBotDm su true).

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene un'istanza di Space.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.create

Per ulteriori informazioni, consulta la Guida all'autorizzazione.