REST Resource: spaces

Ressource: Espace

Un espace dans Google Chat Les espaces sont des conversations entre deux utilisateurs ou plus, ou des messages 1:1 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,

  // 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

Nom de ressource de l'espace.

Format : spaces/{space}
type
(deprecated)

enum (Type)

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

enum (SpaceType)

Type d'espace. Obligatoire pour créer un espace ou modifier son type. Sortie uniquement pour les autres utilisations.
singleUserBotDm

boolean

Facultatif. Indique si l'espace est un MP entre une application Chat et une seule personne.
threaded
(deprecated)

boolean

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

string

Nom à afficher de l'espace. Obligatoire lors de la création d'un espace. Si le message d'erreur ALREADY_EXISTS s'affiche lorsque vous créez un espace ou modifiez le displayName, essayez avec un autre displayName. Un espace existant dans l'organisation Google Workspace utilise peut-être déjà ce nom à afficher.

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

Il peut contenir jusqu'à 128 caractères.
externalUserAllowed

boolean

Immuable. Indique si cet espace autorise tous les utilisateurs de Google Chat à 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éé par un compte personnel autorise tous les utilisateurs de Google Chat.

  • Cet espace sert à importer des données dans Google Chat, car les espaces en mode importation ne doivent autoriser que les membres de la même organisation Google Workspace. Toutefois, dans le cadre du programme Preview développeur Google Workspace, les espaces en mode importation peuvent autoriser n'importe quel utilisateur Google Chat à définir ce champ pour les espaces en mode importation.

Pour les espaces existants, ce champ n'est fourni qu'en sortie.
spaceThreadingState

enum (SpaceThreadingState)

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

object (SpaceDetails)

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

enum (HistoryState)

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

boolean

Facultatif. Indique si cet espace est 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 que l'importation n'est pas terminée.
createTime

string (Timestamp format)

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

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

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

string (Timestamp format)

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

adminInstalled

boolean

Uniquement en sortie. Pour les espaces de messages privés (MP) comportant une application Chat, qu'ils aient été créés par un administrateur Google Workspace Les administrateurs peuvent installer et configurer un message privé avec une application Chat pour le compte des utilisateurs de leur organisation.

Pour permettre l'installation par l'administrateur, votre application Chat doit comporter la messagerie privée.
membershipCount

object (MembershipCount)

Uniquement en sortie. Nombre d'adhésions membres, regroupées par type de membre. Renseigné lorsque spaceType est défini sur 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 défini sur SPACE.

spaceUri

string

Uniquement en sortie. URI de l'espace.

Champ d'union space_permission_settings. Représente les paramètres d'autorisation d'un espace. Renseigné uniquement lorsque space_type est défini sur SPACE. space_permission_settings ne peut être que l'un des éléments suivants:
predefinedPermissionSettings

enum (PredefinedPermissionSettings)

Facultatif. Uniquement en entrée. Paramètres d'autorisation de l'espace. Entrée pour la création d'un espace. Un espace de collaboration est créé si ce champ n'est pas défini. Une fois l'espace créé, les paramètres sont insérés dans le champ PermissionSettings.

permissionSettings

object (PermissionSettings)

Facultatif. Paramètres d'autorisation exacts qui peuvent être définis pour mettre à jour l'espace. Entrée pour la modification d'un espace. Sinon, il ne s'agit que de la sortie. Pour créer un espace, utilisez plutôt predefinedPermissionSettings.

Type

Obsolète: utilisez plutôt SpaceType.

Enums
TYPE_UNSPECIFIED Réservé.
ROOM Conversations entre deux personnes ou plus.
DM Message privé entre une personne et une application Chat, où tous les messages sont plats 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 mise à jour d'un espace. Sortie uniquement pour les autres utilisations.

Enums
SPACE_TYPE_UNSPECIFIED Réservé.
SPACE Un endroit 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 une personne et une application Chat

SpaceThreadingState

Spécifie le type d'état des fils de discussion dans l'espace Chat.

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 y répondre dans le fil de discussion, ce qui permet de conserver leur réponse dans le contexte du message d'origine.
GROUPED_MESSAGES Espaces nommés dans lesquels la conversation est organisée par sujet. Les sujets et leurs réponses sont regroupés.
UNTHREADED_MESSAGES Messages privés (MP) 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 sujet de la discussion, l'objectif fonctionnel ou les participants de l'espace.

Il peut contenir jusqu'à 150 caractères.
guidelines

string

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

Il peut comporter jusqu'à 5 000 caractères.

HistoryState

État de l'historique des messages et des espaces. Indique la durée de conservation des messages et des fils de conversation 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'adhésions à un espace, regroupées en catégories.

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

integer

Nombre d'utilisateurs humains ayant directement rejoint l'espace (sans compter ceux qui ont rejoint un groupe).
joinedGroupCount

integer

Nombre de groupes ayant directement rejoint 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 de l'espace.
audience

string

Facultatif. Nom de ressource de l'audience cible pouvant accéder à l'espace. Définissez ce champ sur un ID d'audience cible valide pour rendre l'espace visible, ou utilisez l'alias audiences/default pour définir l'espace avec le paramètre d'accès par défaut dans la console d'administration. Pour en savoir plus, consultez Rendre un espace visible auprès d'une audience cible. Désactivez ce champ pour limiter l'espace. Renseigné uniquement lorsque l'espace est visible. Format: audiences/{audience}, audiences/default peut être utilisé comme alias du paramètre de partage par défaut de Chat.

AccessState

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

Enums
ACCESS_STATE_UNSPECIFIED L'état de l'accès est inconnu ou non compatible avec cette API.
PRIVATE L'espace est visible par les membres ou les groupes ajoutés ou invités.
DISCOVERABLE L'espace est visible par l'audience cible sélectionnée, ainsi que par les membres ou groupes ajoutés ou invités.

PredefinedPermissionSettings

Paramètres d'autorisation de l'espace que vous pouvez spécifier 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 des espaces nommés, consultez En savoir plus sur les espaces.

Enums
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED URL indéterminée. Ne pas utiliser.
COLLABORATION_SPACE Paramètre permettant de transformer l'espace en espace de collaboration dans lequel tous les membres peuvent publier des messages.
ANNOUNCEMENT_SPACE Paramètre permettant de transformer l'espace en espace d'annonce dont seuls les gestionnaires peuvent publier des messages.

PermissionSettings

Paramètres d'autorisation pour un espace nommé Pour définir des paramètres d'autorisation lorsque vous créez 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)

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

object (PermissionSetting)

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

object (PermissionSetting)

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

object (PermissionSetting)

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

object (PermissionSetting)

Paramètre permettant de gérer les applications d'un espace.
manageWebhooks

object (PermissionSetting)

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)

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

Indique si les gestionnaires de l'espace disposent de cette autorisation.
membersAllowed

boolean

Indique si les membres non administrateurs disposent de cette autorisation.

Méthodes

completeImport

 Effectue le processus d'importation de l'espace spécifié et le rend visible par les utilisateurs.

create

 Crée un espace nommé.

delete

 Supprime un espace nommé.

findDirectMessage

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

get

 Affiche les détails d'un espace.

list

 Répertorie les espaces dont l'appelant est membre.

patch

 Met à jour un espace.

setup

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