Method: spaces.setup

Crée un espace et y ajoute les utilisateurs spécifiés. L'utilisateur à l'origine de l'appel est automatiquement ajouté à l'espace. Il ne doit pas être spécifié comme membre de la requête. Pour obtenir un exemple, consultez Configurer un espace.

Pour spécifier les membres humains à ajouter, ajoutez des adhésions avec le member.name approprié dans le SetUpSpaceRequest. Pour ajouter un utilisateur humain, utilisez users/{user}, où {user} peut être l'adresse e-mail de l'utilisateur. Pour les utilisateurs d'une même organisation Workspace, {user} peut également indiquer id de la personne dans l'API People ou id de l'utilisateur dans l'API Directory. Par exemple, si l'ID de profil de personne de l'API People pour user@example.com est 123456789, vous pouvez ajouter l'utilisateur à l'espace en définissant membership.member.name sur users/user@example.com ou users/123456789.

Pour un espace ou un chat de groupe, si l'appelant bloque ou est bloqué par certains membres, ceux-ci ne sont pas ajoutés à l'espace créé.

Pour créer un message privé (MP) entre l'utilisateur appelant et un autre utilisateur humain, spécifiez un seul appartenance pour le représenter. Si un utilisateur bloque l'autre utilisateur, la requête échoue et le MP n'est pas créé.

Pour créer un MP entre l'utilisateur appelant et l'application appelante, définissez Space.singleUserBotDm sur true et ne spécifiez aucune adhésion. Vous ne pouvez utiliser cette méthode que pour configurer un MP avec l'application appelante. Pour ajouter l'application appelante en tant que membre d'un espace ou en tant que MP existant entre deux utilisateurs humains, consultez la section Créer un abonnement.

Si un MP existe déjà entre deux utilisateurs, même lorsqu'un utilisateur bloque l'autre au moment de la demande, le MP existant est renvoyé.

Les espaces avec des réponses organisées en fils de discussion ne sont pas acceptés. Si le message d'erreur ALREADY_EXISTS s'affiche lorsque vous configurez un espace, essayez un autre displayName. Il est possible qu'un espace existant de l'organisation Google Workspace utilise déjà ce nom à afficher.

Nécessite une authentification utilisateur.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON
{
  "space": {
    object (Space)
  },
  "requestId": string,
  "memberships": [
    {
      object (Membership)
    }
  ]
}
Champs
space

object (Space)

Obligatoire. Le champ Space.spaceType est obligatoire.

Pour créer un espace, définissez Space.spaceType sur SPACE et Space.displayName. Si le message d'erreur ALREADY_EXISTS s'affiche lorsque vous configurez un espace, essayez un autre displayName. Il est possible qu'un espace existant de l'organisation Google Workspace utilise déjà ce nom à afficher.

Pour créer un chat de groupe, définissez Space.spaceType sur GROUP_CHAT. Ne définissez pas Space.displayName.

Pour créer une conversation privée, définissez Space.spaceType sur DIRECT_MESSAGE et Space.singleUserBotDm sur false. Ne définissez pas Space.displayName ni Space.spaceDetails.

Pour créer une conversation privée entre un humain et l'application Chat qui est à l'origine de l'appel, définissez Space.spaceType sur DIRECT_MESSAGE et Space.singleUserBotDm sur true. Ne définissez pas Space.displayName ni Space.spaceDetails.

Si un espace DIRECT_MESSAGE existe déjà, il est renvoyé au lieu d'en créer un autre.

requestId

string

Facultatif. Identifiant unique pour cette requête. Un UUID aléatoire est recommandé. Si vous spécifiez un ID de requête existant, l'espace créé avec cet ID est renvoyé au lieu d'en créer un. Si vous spécifiez un ID de requête existant depuis la même application Chat avec un autre utilisateur authentifié, une erreur est renvoyée.

memberships[]

object (Membership)

Facultatif. Utilisateurs de Google Chat à inviter à rejoindre l'espace. Omettez l'utilisateur appelant, car il est ajouté automatiquement.

L'ensemble autorise actuellement jusqu'à 20 abonnements (en plus de l'appelant).

Le champ Membership.member doit contenir un user avec name renseigné (format: users/{user}) et type défini sur User.Type.HUMAN. Vous ne pouvez ajouter des utilisateurs que lorsque vous configurez un espace. L'ajout d'applications Chat n'est possible que pour les messages privés configurés avec l'application d'appel. Vous pouvez également ajouter des membres en utilisant l'adresse e-mail de l'utilisateur comme alias pour {user}. Par exemple, user.name peut être users/example@gmail.com. Pour pouvoir inviter des utilisateurs Gmail ou des utilisateurs de domaines Google Workspace externes, l'adresse e-mail de l'utilisateur doit être utilisée pour {user}.

Facultatif lorsque vous définissez Space.spaceType sur SPACE.

Obligatoire si vous définissez Space.spaceType sur GROUP_CHAT et au moins deux abonnements.

Obligatoire lorsque vous définissez Space.spaceType sur DIRECT_MESSAGE avec un utilisateur humain, avec exactement une adhésion.

Ce champ doit être vide lors de la création d'une conversation privée entre un humain et l'application Chat qui est à l'origine de l'appel (lorsque Space.spaceType est défini sur DIRECT_MESSAGE et Space.singleUserBotDm sur true).

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de Space.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

Pour en savoir plus, consultez le guide relatif aux autorisations.