Method: spaces.setup

Crea uno spazio a cui vengono aggiunti utenti specifici. L'utente chiamante viene aggiunto automaticamente allo spazio e non deve essere specificato come membro della richiesta. Per un esempio, vedi Configurare uno spazio con membri iniziali.

Per specificare i membri umani da aggiungere, aggiungi gli abbonamenti con l'attributo member.name appropriato in SetUpSpaceRequest. Per aggiungere un utente umano, utilizza users/{user}, dove {user} può essere l'indirizzo email dell'utente. Per gli utenti della stessa organizzazione Workspace, {user} può anche essere id per l'utente dall'API People o id per l'utente nell'API Directory. Ad esempio, se l'ID profilo 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 uno spazio o una chat di gruppo, se il chiamante blocca o è bloccato da alcuni membri, questi non vengono aggiunti allo spazio creato.

Per creare un messaggio diretto tra l'utente chiamante e un altro utente umano, specifica esattamente un'appartenenza che rappresenti l'utente umano. Se un utente blocca l'altro, la richiesta non riesce e il messaggio diretto non viene creato.

Per creare un messaggio diretto tra l'utente chiamante e l'app per le chiamate, imposta Space.singleUserBotDm su true e non specificare alcun abbonamento. Puoi utilizzare questo metodo solo per configurare un messaggio diretto con l'app per le chiamate. Per aggiungere l'app per le chiamate come membro di uno spazio o come membro di un messaggio diretto esistente tra due utenti umani, vedi Invitare o aggiungere un utente o un'app a uno spazio.

Se esiste già un messaggio diretto tra due utenti, anche se un utente blocca l'altro nel momento in cui viene effettuata una richiesta, viene restituito il messaggio diretto esistente.

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

Richiede l'autenticazione degli utenti.

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 Space.displayName. Se ricevi il messaggio di errore ALREADY_EXISTS quando configuri uno spazio, prova con un altro displayName. Uno spazio esistente all'interno dell'organizzazione Google Workspace potrebbe utilizzare già 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 per le chiamate, 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, verrà restituito questo spazio anziché crearne uno nuovo.
requestId

string

Campo 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é creare un nuovo spazio. Se specifichi un ID richiesta esistente dalla stessa app di Chat con un utente autenticato diverso, viene restituito un errore.
memberships[]

object (Membership)

Campo facoltativo. Gli utenti di Google Chat da invitare a partecipare allo spazio. Ometti l'utente chiamante, perché viene aggiunto automaticamente.

Al momento, l'insieme consente fino a 20 membri (oltre al chiamante).

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

Facoltativo quando il criterio Space.spaceType viene impostato su SPACE.

Obbligatorio quando imposti Space.spaceType su GROUP_CHAT, insieme ad almeno due abbonamenti.

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

Il campo deve essere vuoto quando si crea una conversazione 1:1 tra una persona e l'app di chat per le chiamate (quando si imposta il criterio Space.spaceType 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.