Method: spaces.setup

Crea uno spazio e vi 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 appartenenze 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 di Workspace, {user} può essere anche l'id della persona dell'API People o l'id dell'utente nell'API Directory. Ad esempio, se l'ID del profilo Person 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 appartenenze 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 di ricerca di Cloud Identity Groups per recuperare l'ID 123456789 per l'email del gruppo group@example.com, quindi puoi aggiungere il gruppo allo spazio impostando membership.group_member.name su groups/123456789. L'email del 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 o viene bloccato da alcuni membri o non ha l'autorizzazione per aggiungere alcuni membri, questi non vengono aggiunti allo spazio creato.

Per creare un messaggio diretto (DM) tra l'utente che effettua la chiamata 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 chiamante e l'app di chiamate, imposta Space.singleUserBotDm su true e non specificare alcuna appartenenza. Puoi utilizzare questo metodo solo per configurare un messaggio diretto con l'app di chiamate. Per aggiungere l'app di chiamate come membro di uno spazio o 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 al momento dell'invio di 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 a utilizzare un displayName diverso. Uno spazio esistente all'interno dell'organizzazione Google Workspace potrebbe già utilizzare questo nome visualizzato.

Richiede l'autenticazione dell'utente con uno dei seguenti ambiti di autorizzazione:

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

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 durante la configurazione di uno spazio, prova a utilizzare un displayName diverso. 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 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 questo spazio anziché crearne uno nuovo.
requestId

string

Facoltativo. Un ID univoco per questa richiesta. Si consiglia di utilizzare un UUID casuale. La specifica di un ID richiesta rende la richiesta idempotente, il che garantisce che più richieste identiche con lo stesso ID richiesta comportino la creazione di un solo spazio. Le richieste successive con lo stesso ID richiesta restituiscono lo spazio esistente e non lo aggiornano, anche se i dettagli richiesti differiscono dallo stato attuale.

Per utilizzare questo campo in modo efficace:

  • Assicurati che le richieste successive siano identiche e utilizzino le stesse credenziali di autenticazione della richiesta originale.
  • Se è già stato creato uno spazio con l'ID richiesta fornito, la richiesta restituisce questo spazio. Tieni presente che lo spazio restituito potrebbe non essere completamente compilato; l'API riproduce lo spazio nella richiesta con il nome della risorsa assegnato dal sistema. Per recuperare i metadati più recenti dello spazio, chiama spaces.get.
  • Il riutilizzo di un ID richiesta esistente con un utente autenticato diverso genera un errore.
memberships[]

object (Membership)

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

Il set attualmente consente fino a 49 appartenenze (oltre al 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 utenti umani solo durante la configurazione di uno spazio (l'aggiunta di app Chat è supportata solo per la configurazione di messaggi diretti con l'app di chiamate). Puoi anche aggiungere membri utilizzando l'email dell'utente come alias per {user}. Ad esempio, user.name può essere users/example@gmail.com. Per invitare utenti Gmail o utenti di domini Google Workspace esterni, è necessario utilizzare l'email dell'utente per {user}.

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

Facoltativo quando imposti Space.spaceType su SPACE.

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

Obbligatorio quando imposti Space.spaceType su DIRECT_MESSAGE con un utente umano, insieme a esattamente un'appartenenza.

Deve essere vuoto quando crei una conversazione 1:1 tra una persona e l'app Chat che effettua la chiamata (quando imposti 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.