REST Resource: spaces

Ressource : Espace

Un espace dans Google Chat. Les espaces sont des conversations entre deux utilisateurs ou plus, ou des messages privés entre un utilisateur et une application Chat.

Représentation JSON 
{
  "name": string,
  "type": enum (Type),
  "spaceType": enum (SpaceType),
  "singleUserBotDm": boolean,
  "threaded": boolean,
  "displayName": string,
  "externalUserAllowed": boolean,
  "spaceThreadingState": enum (SpaceThreadingState),
  "spaceDetails": {
    object (SpaceDetails)
  },
  "spaceHistoryState": enum (HistoryState),
  "importMode": boolean,
  "createTime": string,
  "lastActiveTime": string,
  "adminInstalled": boolean,
  "membershipCount": {
    object (MembershipCount)
  },
  "accessSettings": {
    object (AccessSettings)
  },
  "spaceUri": string,
  "importModeExpireTime": string,
  "customer": string,

  // Union field space_permission_settings can be only one of the following:
  "predefinedPermissionSettings": enum (PredefinedPermissionSettings),
  "permissionSettings": {
    object (PermissionSettings)
  }
  // End of list of possible types for union field space_permission_settings.
}
Champs
name

string

Identifiant. Nom de ressource de l'espace.

Format : spaces/{space}

Où {space} représente l'ID attribué par le système pour l'espace. Vous pouvez obtenir l'ID de l'espace en appelant la méthode spaces.list() ou à partir de l'URL de l'espace. Par exemple, si l'URL de l'espace est https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA, l'ID de l'espace est AAAAAAAAA.
type
(deprecated)

enum (Type)

Uniquement en sortie. Obsolète : utilisez plutôt spaceType. Type d'espace.
spaceType

enum (SpaceType)

Facultatif. Type d'espace. Obligatoire lors de la création d'un espace ou de la modification de son type. Sortie uniquement pour les autres utilisations.
singleUserBotDm

boolean

Facultatif. Indique si l'espace est un message privé entre une application Chat et un seul utilisateur.
threaded
(deprecated)

boolean

Uniquement en sortie. Obsolète : utilisez plutôt spaceThreadingState. Si les messages sont organisés en fils de discussion dans cet espace.
displayName

string

Facultatif. Nom à afficher de l'espace. Obligatoire lors de la création d'un espace avec un spaceType de SPACE. Si le message d'erreur ALREADY_EXISTS s'affiche lorsque vous créez un espace ou que vous mettez à jour le displayName, essayez un autre displayName. Il est possible qu'un espace existant dans l'organisation Google Workspace utilise déjà ce nom à afficher.

Pour les messages privés, ce champ peut être vide.

Jusqu'à 128 caractères.
externalUserAllowed

boolean

Facultatif. Immuable. Indique si cet espace autorise tout utilisateur Google Chat à en devenir membre. Saisie lors de la création d'un espace dans une organisation Google Workspace. Omettez ce champ lorsque vous créez des espaces dans les conditions suivantes :

  • L'utilisateur authentifié utilise un compte personnel (compte utilisateur non géré). Par défaut, un espace créé avec un compte personnel est accessible à tous les utilisateurs Google Chat.

Pour les espaces existants, ce champ est en sortie uniquement.
spaceThreadingState

enum (SpaceThreadingState)

Uniquement en sortie. État des fils de discussion dans l'espace Chat.
spaceDetails

object (SpaceDetails)

Facultatif. Informations sur l'espace, y compris sa description et ses règles.
spaceHistoryState

enum (HistoryState)

Facultatif. État de l'historique des messages et des fils de discussion dans cet espace.
importMode

boolean

Facultatif. Cet espace a été créé dans Import Mode lors d'une migration de données vers Google Workspace. Pendant l'importation des espaces, les utilisateurs ne peuvent pas les voir tant qu'elle n'est pas terminée.

Pour créer un espace dans Import Mode, vous devez authentifier l'utilisateur.
createTime

string (Timestamp format)

Facultatif. Immuable. Pour les espaces créés dans Chat, il s'agit de la date et de l'heure de création de l'espace. Ce champ est en sortie seule, sauf lorsqu'il est utilisé dans des espaces en mode importation.

Pour les espaces en mode importation, définissez ce champ sur le code temporel historique auquel l'espace a été créé dans la source afin de conserver l'heure de création d'origine.

N'est renseigné dans la sortie que lorsque spaceType est GROUP_CHAT ou SPACE.
lastActiveTime

string (Timestamp format)

Uniquement en sortie. Code temporel du dernier message dans l'espace.
adminInstalled

boolean

Uniquement en sortie. Pour les espaces de messages privés avec une application Chat, indique si l'espace a été créé par un administrateur Google Workspace. Les administrateurs peuvent installer et configurer un message privé avec une application Chat au nom des utilisateurs de leur organisation.

Pour que l'installation par l'administrateur soit possible, votre application Chat doit proposer la messagerie privée.
membershipCount

object (MembershipCount)

Uniquement en sortie. Nombre d'abonnements souscrits, regroupés par type de membre. Renseigné lorsque spaceType est SPACE, DIRECT_MESSAGE ou GROUP_CHAT.
accessSettings

object (AccessSettings)

Facultatif. Spécifie le paramètre d'accès de l'espace. Renseigné uniquement lorsque spaceType est SPACE.
spaceUri

string

Uniquement en sortie. URI permettant à un utilisateur d'accéder à l'espace.
importModeExpireTime

string (Timestamp format)

Uniquement en sortie. Heure à laquelle l'espace sera automatiquement supprimé par le système s'il reste en mode importation.

Chaque espace créé en mode importation doit quitter ce mode avant l'expiration du délai à l'aide de spaces.completeImport.

Ce champ n'est renseigné que pour les espaces créés en mode importation.
customer

string

Facultatif. Immuable. ID client du domaine de l'espace. Obligatoire uniquement lors de la création d'un espace avec authentification de l'application et SpaceType est SPACE. Sinon, ne doit pas être défini.

Au format customers/{customer}, où customer correspond à id de la ressource client du SDK Admin. Les applications privées peuvent également utiliser l'alias customers/my_customer pour créer l'espace dans la même organisation Google Workspace que l'application.

Pour les messages privés, ce champ n'est pas renseigné.
Champ d'union space_permission_settings. Représente les paramètres d'autorisation d'un espace. Renseigné uniquement lorsque space_type est SPACE. space_permission_settings ne peut être qu'un des éléments suivants :
predefinedPermissionSettings

enum (PredefinedPermissionSettings)

Facultatif. Uniquement en entrée. Paramètres d'autorisation prédéfinis pour un espace, à saisir uniquement lors de la création d'un espace. Si le champ n'est pas défini, un espace de collaboration est créé. Une fois l'espace créé, les paramètres sont renseignés dans le champ PermissionSettings.

La définition de paramètres d'autorisation prédéfinis permet :
permissionSettings

object (PermissionSettings)

Facultatif. Paramètres d'autorisation des espaces existants. Entrée permettant de mettre à jour les paramètres d'autorisation exacts d'un espace, en remplaçant les paramètres d'autorisation existants. Le résultat liste les paramètres d'autorisation actuels.

La lecture et la mise à jour des paramètres d'autorisation sont compatibles avec :

Type

Obsolète : utilisez plutôt SpaceType.

Enums
TYPE_UNSPECIFIED Réservé.
ROOM Conversations entre deux personnes ou plus
DM Message privé entre un utilisateur et une application de chat, où tous les messages sont au même niveau. Notez que cela n'inclut pas les messages privés entre deux personnes.

SpaceType

Type d'espace. Obligatoire lors de la création ou de la modification d'un espace. Sortie uniquement pour les autres utilisations.

Enums
SPACE_TYPE_UNSPECIFIED Réservé.
SPACE Un espace où les utilisateurs peuvent envoyer des messages, partager des fichiers et collaborer. Un SPACE peut inclure des applications Chat.
GROUP_CHAT Conversations de groupe entre trois personnes ou plus. Un GROUP_CHAT peut inclure des applications Chat.
DIRECT_MESSAGE Messages privés entre deux personnes ou entre une personne et une application Chat

SpaceThreadingState

Spécifie le type d'état de thread dans l'espace de discussion.

Enums
SPACE_THREADING_STATE_UNSPECIFIED Réservé.
THREADED_MESSAGES Espaces nommés compatibles avec les fils de discussion. Lorsque les utilisateurs répondent à un message, ils peuvent le faire dans le même fil de discussion, ce qui permet de conserver le contexte du message d'origine.
GROUPED_MESSAGES Espaces nommés où la conversation est organisée par sujet. Les sujets et leurs réponses sont regroupés.
UNTHREADED_MESSAGES Messages privés entre deux personnes et conversations de groupe entre trois personnes ou plus

SpaceDetails

Informations sur l'espace, y compris sa description et ses règles.

Représentation JSON 
{
  "description": string,
  "guidelines": string
}
Champs
description

string

Facultatif. Description de l'espace. Par exemple, décrivez le thème de discussion de l'espace, son objectif fonctionnel ou ses participants.

Jusqu'à 150 caractères.
guidelines

string

Facultatif. les règles, les attentes et l'étiquette de l'espace.

Jusqu'à 5 000 caractères sont acceptés.

HistoryState

État de l'historique des messages et des espaces. Spécifie la durée de conservation des messages et des fils de discussion après leur création.

Enums
HISTORY_STATE_UNSPECIFIED Valeur par défaut. Ne pas utiliser.
HISTORY_OFF Historique désactivé. Les messages et les fils de discussion sont conservés pendant 24 heures.
HISTORY_ON Historique activé. Les règles de conservation Vault de l'organisation spécifient la durée de conservation des messages et des fils de discussion.

MembershipCount

Représente le nombre d'abonnements à un espace, regroupés par catégories.

Représentation JSON 
{
  "joinedDirectHumanUserCount": integer,
  "joinedGroupCount": integer
}
Champs
joinedDirectHumanUserCount

integer

Uniquement en sortie. Nombre d'utilisateurs humains qui ont rejoint directement l'espace, sans compter les utilisateurs qui l'ont rejoint en étant membres d'un groupe.
joinedGroupCount

integer

Uniquement en sortie. Nombre de tous les groupes ayant rejoint directement l'espace.

AccessSettings

Représente le paramètre d'accès de l'espace.

Représentation JSON 
{
  "accessState": enum (AccessState),
  "audience": string
}
Champs
accessState

enum (AccessState)

Uniquement en sortie. Indique l'état d'accès à l'espace.
audience

string

Facultatif. Nom de ressource de l'audience cible qui peut découvrir l'espace, le rejoindre et prévisualiser les messages qu'il contient. Si cette option n'est pas définie, seuls les utilisateurs ou les groupes Google qui ont été ajoutés ou invités individuellement à l'espace peuvent y accéder. Pour en savoir plus, consultez Rendre un espace détectable par une audience cible.

Format : audiences/{audience}

Pour utiliser l'audience cible par défaut de l'organisation Google Workspace, définissez la valeur sur audiences/default.

La lecture de l'audience cible permet :

Ce champ n'est pas renseigné lorsque vous utilisez le champ d'application chat.bot avec l'authentification de l'application.

La définition de l'audience cible nécessite une authentification de l'utilisateur.

AccessState

Représente l'état d'accès à l'espace.

Enums
ACCESS_STATE_UNSPECIFIED L'état d'accès est inconnu ou non pris en charge dans cette API.
PRIVATE Seuls les utilisateurs ou les groupes Google qui ont été ajoutés ou invités individuellement par d'autres utilisateurs ou administrateurs Google Workspace peuvent découvrir l'espace et y accéder.
DISCOVERABLE

Un gestionnaire d'espace a accordé l'accès à l'espace à une audience cible. Les utilisateurs ou les groupes Google qui ont été ajoutés ou invités individuellement à l'espace peuvent également le découvrir et y accéder. Pour en savoir plus, consultez Rendre un espace visible pour des utilisateurs spécifiques.

Pour créer des espaces visibles, vous devez authentifier les utilisateurs.

PredefinedPermissionSettings

Paramètres d'autorisation prédéfinis que vous ne pouvez spécifier que lorsque vous créez un espace nommé. D'autres paramètres pourront être ajoutés à l'avenir. Pour en savoir plus sur les paramètres d'autorisation pour les espaces nommés, consultez À propos des espaces.

Enums
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED Non spécifié. Ne pas utiliser.
COLLABORATION_SPACE Paramètre permettant de faire de l'espace un espace de collaboration où tous les membres peuvent publier des messages.
ANNOUNCEMENT_SPACE Paramètre permettant de faire de l'espace un espace d'annonces où seuls les gestionnaires peuvent publier des messages.

PermissionSettings

Paramètres d'autorisation que vous pouvez spécifier lorsque vous modifiez un espace nommé existant.

Pour définir les paramètres d'autorisation lors de la création d'un espace, spécifiez le champ PredefinedPermissionSettings dans votre requête.

Représentation JSON 
{
  "manageMembersAndGroups": {
    object (PermissionSetting)
  },
  "modifySpaceDetails": {
    object (PermissionSetting)
  },
  "toggleHistory": {
    object (PermissionSetting)
  },
  "useAtMentionAll": {
    object (PermissionSetting)
  },
  "manageApps": {
    object (PermissionSetting)
  },
  "manageWebhooks": {
    object (PermissionSetting)
  },
  "postMessages": {
    object (PermissionSetting)
  },
  "replyMessages": {
    object (PermissionSetting)
  }
}
Champs
manageMembersAndGroups

object (PermissionSetting)

Facultatif. Paramètre permettant de gérer les membres et les groupes dans un espace.
modifySpaceDetails

object (PermissionSetting)

Facultatif. Paramètre permettant de modifier le nom, l'avatar, la description et les consignes de l'espace.
toggleHistory

object (PermissionSetting)

Facultatif. Paramètre permettant d'activer ou de désactiver l'historique des espaces.
useAtMentionAll

object (PermissionSetting)

Facultatif. Paramètre permettant d'utiliser @tous dans un espace.
manageApps

object (PermissionSetting)

Facultatif. Paramètre permettant de gérer les applications dans un espace.
manageWebhooks

object (PermissionSetting)

Facultatif. Paramètre permettant de gérer les webhooks dans un espace.
postMessages

object (PermissionSetting)

Uniquement en sortie. Paramètre permettant de publier des messages dans un espace.
replyMessages

object (PermissionSetting)

Facultatif. Paramètre permettant de répondre aux messages dans un espace.

PermissionSetting

Représente un paramètre d'autorisation d'espace.

Représentation JSON 
{
  "managersAllowed": boolean,
  "membersAllowed": boolean
}
Champs
managersAllowed

boolean

Facultatif. Indique si les gestionnaires d'espaces disposent de cette autorisation.
membersAllowed

boolean

Facultatif. Indique si les membres non administrateurs disposent de cette autorisation.

Méthodes

completeImport

 Finalise le processus d'importation pour l'espace spécifié et le rend visible pour les utilisateurs.

create

 Crée un espace.

delete

 Supprime un espace nommé.

findDirectMessage

 Renvoie le message privé existant avec l'utilisateur spécifié.

get

 Renvoie des informations sur un espace.

list

 Liste les espaces dont l'appelant est membre.

patch

 Met à jour un espace.
Renvoie la liste des espaces d'une organisation Google Workspace en fonction de la recherche d'un administrateur.

setup

 Crée un espace et y ajoute les utilisateurs spécifiés.