Method: spaces.setup

Crea uno spazio e vi aggiunge utenti specificati. L'utente che chiama viene aggiunto automaticamente allo spazio e non deve essere specificato come iscrizione nella richiesta. Per un esempio, vedi Configurare uno spazio con membri iniziali.

Per specificare i membri da aggiungere, aggiungi abbonamenti con il membership.member.name appropriato. 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 il id per la persona dell'API People o il id per l'utente nell'API Directory. Ad esempio, se l'ID profilo persona dell'API People di 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 il membership.group_member.name appropriato. Per aggiungere o invitare un gruppo Google, utilizza groups/{group}, dove {group} è il id del gruppo dell'API Cloud Identity Groups. Ad esempio, puoi utilizzare l'API Cloud Identity Groups lookup per recuperare l'ID 123456789 per l'email di gruppo group@example.com e poi 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 solo come membri negli spazi denominati.

Per uno spazio denominato o una chat di gruppo, se il chiamante blocca, è bloccato da alcuni membri o non dispone dell'autorizzazione per aggiungere alcuni membri, questi membri non verranno aggiunti allo spazio creato.

Per creare un messaggio diretto tra l'utente chiamante e un altro utente umano, specifica esattamente un'appartenenza per rappresentare l'utente umano. 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 chiama e l'app per la chiamata, imposta Space.singleUserBotDm su true e non specificare alcuna iscrizione. 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 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 quando un utente blocca l'altro quando 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 durante la configurazione di uno spazio, prova con un altro displayName. Questo nome visualizzato potrebbe essere già utilizzato da uno spazio esistente all'interno dell'organizzazione Google Workspace.

Richiede l'autenticazione dell'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 con un altro displayName. Questo nome visualizzato potrebbe essere già utilizzato da uno spazio esistente all'interno dell'organizzazione Google Workspace.

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 imposta Space.singleUserBotDm su false. Non impostare Space.displayName o Space.spaceDetails.

Per creare una conversazione 1:1 tra una persona e l'app 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, viene restituito quel spazio invece di crearne uno nuovo.
requestId

string

(Facoltativo) Un identificatore univoco per questa richiesta. È consigliato un UUID casuale. Se viene specificato 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 di 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 ha chiamato perché viene aggiunto automaticamente.

L'impostazione attualmente consente fino a 20 abbonamenti (oltre al chiamante).

Per l'appartenenza umana, 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 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 per {user}. Ad esempio, user.name può essere users/example@gmail.com. Per invitare utenti di Gmail o utenti di domini Google Workspace esterni, è necessario utilizzare l'indirizzo email dell'utente per {user}.

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

Facoltativo se imposti Space.spaceType su SPACE.

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

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

Deve essere vuoto durante la creazione di una conversazione 1:1 tra una persona e l'app Chat per le chiamate (se 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.