Method: spaces.setup

Crée un espace et y ajoute les utilisateurs spécifiés. L'utilisateur appelant est automatiquement ajouté à l'espace et ne doit pas être spécifié comme membre dans la demande. Pour obtenir un exemple, consultez Configurer un espace avec des membres initiaux.

Pour spécifier les membres humains à ajouter, ajoutez des appartenances avec le membership.member.name approprié. Pour ajouter un utilisateur, utilisez users/{user}, où {user} peut être l'adresse e-mail de l'utilisateur. Pour les utilisateurs de la même organisation Workspace, {user} peut également correspondre au id de la personne à partir de l'API People ou au id pour l'utilisateur dans l'API Directory. Par exemple, si l'ID de profil Person 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 spécifier les groupes Google à ajouter, ajoutez des appartenances avec l'membership.group_member.name appropriée. Pour ajouter ou inviter un groupe Google, utilisez groups/{group}, où {group} est l'id du groupe de l'API Cloud Identity Groups. Par exemple, vous pouvez utiliser l'API Cloud Identity Groups lookup pour récupérer l'ID 123456789 de l'adresse e-mail de groupe group@example.com, puis ajouter le groupe à l'espace en définissant membership.group_member.name sur groups/123456789. Les adresses e-mail de groupe ne sont pas acceptées, et les groupes Google ne peuvent être ajoutés en tant que membres que dans des espaces nommés.

Pour un espace nommé ou un chat de groupe, si l'appelant bloque, est bloqué par certains membres ou n'est pas autorisé à ajouter des 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 exactement un abonnement pour le représenter. Si un utilisateur bloque l'autre, 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 n'indiquez 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 d'un MP existant entre deux utilisateurs humains, consultez Inviter ou ajouter un utilisateur ou une application à un espace.

Si un MP existe déjà entre deux utilisateurs, même si un utilisateur bloque l'autre au moment où une requête est effectuée, le MP existant est renvoyé.

Les espaces avec des réponses sous forme de fil de discussion ne sont pas acceptés. Si le message d'erreur ALREADY_EXISTS s'affiche lorsque vous configurez un espace, essayez avec un autre displayName. Un espace existant dans l'organisation Google Workspace utilise peut-être déjà ce nom à afficher.

Authentification des utilisateurs requise.

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 entre deux utilisateurs, 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 une personne 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à, cet espace est renvoyé au lieu d'en créer un autre.
requestId

string

Facultatif. Identifiant unique de cette requête. Nous vous recommandons d'utiliser un UUID aléatoire. 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 autre. Si vous spécifiez un ID de requête existant provenant de la même application Chat avec un autre utilisateur authentifié, une erreur est renvoyée.
memberships[]

object (Membership)

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

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

Pour l'appartenance à un groupe d'utilisateurs, 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 la configuration des messages privé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 inviter des utilisateurs Gmail ou des utilisateurs de domaines Google Workspace externes, vous devez utiliser leur adresse e-mail pour {user}.

Pour les membres d'un groupe Google, le champ Membership.group_member doit contenir un élément group avec le paramètre name renseigné (format groups/{group}). Vous ne pouvez ajouter des groupes Google que lorsque vous définissez Space.spaceType sur SPACE.

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

Obligatoire lorsque vous définissez Space.spaceType sur GROUP_CHAT, ainsi que pour au moins deux adhésions.

Obligatoire lorsque vous définissez Space.spaceType sur DIRECT_MESSAGE avec un utilisateur humain, ainsi qu'un seul abonnement.

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 vous définissez Space.spaceType 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.