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,
  "adminInstalled": boolean
}
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 ou modifier le type d'un espace. Sortie uniquement pour une autre utilisation.

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 organisé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 un autre displayName. Un espace existant de l'organisation Google Workspace utilise peut-être déjà ce nom à afficher.

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

Jusqu'à 128 caractères.

externalUserAllowed

boolean

Immuable. Indique si l'espace autorise les utilisateurs de Google Chat à devenir membre. À saisir 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 Google. Par défaut, tous les utilisateurs de Google Chat sont autorisés à accéder à l'espace.

  • Cet espace permet d'importer des données dans Google Chat. Les espaces en mode Importation ne doivent autoriser que les membres de la même organisation Google Workspace.

Pour les espaces existants, ce champ n'est généré qu'en sortie.

spaceThreadingState

enum (SpaceThreadingState)

Uniquement en sortie. État des threads dans l'espace Chat.

spaceDetails

object (SpaceDetails)

Détails concernant l'espace, y compris la description et les 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 de la migration de données vers Google Workspace. Pendant l'importation des espaces, les utilisateurs ne pourront pas les voir tant que l'importation ne sera pas terminée.

createTime

string (Timestamp format)

Facultatif. Heure de création des espaces créés dans Chat. Ce champ est uniquement en sortie, sauf lorsqu'il est utilisé dans des espaces importés.

Pour les espaces importés, définissez ce champ sur l'horodatage historique correspondant à la date de création de l'espace 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.

adminInstalled

boolean

Uniquement en sortie. Indique si l'application Chat a été installée par un administrateur Google Workspace. Les administrateurs peuvent installer une application Chat pour leur domaine, leur unité organisationnelle ou un groupe d'utilisateurs.

Les administrateurs ne peuvent installer que des applications Chat pour envoyer des messages privés entre les utilisateurs et l'application. Pour permettre l'installation administrateur, votre application doit inclure la messagerie directe.

Type

Obsolète: utilisez plutôt SpaceType.

Enums
TYPE_UNSPECIFIED
ROOM Conversations entre deux personnes ou plus
DM Messages privés entre un humain et une application de chat, où tous les messages sont statiques Notez que cela n'inclut pas les messages privés entre deux personnes.

Type d'espace

Type d'espace. Obligatoire pour la création ou la mise à jour d'un espace. Sortie uniquement pour une autre utilisation.

Enums
SPACE_TYPE_UNSPECIFIED Réservée.
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 humains ou entre deux personnes et une application Chat

EspaceThreadingState

Spécifie le type d'état des threads dans l'espace Chat.

Enums
SPACE_THREADING_STATE_UNSPECIFIED Réservée.
THREADED_MESSAGES Espaces nommés compatibles avec les fils de discussion Lorsque les utilisateurs répondent à un message, ils peuvent le faire 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 où 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

Détails de l'espace

Détails concernant l'espace, y compris la description et les règles.

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

string

Facultatif. Description de l'espace. Par exemple, décrivez le sujet de discussion, l'objectif fonctionnel ou les participants de l'espace.

Jusqu'à 150 caractères.

guidelines

string

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

Jusqu'à 5 000 caractères.

État de l'historique

État de l'historique des messages et des espaces. Indique 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 l'utilisez pas.
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 indiquent la durée de conservation des messages et des fils de discussion.

Méthodes

completeImport

Achète le processus d'importation de l'espace spécifié et le rend visible pour 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.