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,
  "adminInstalled": boolean,
  "accessSettings": {
    object (AccessSettings)
  }
}
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 lors de la création d'un espace ou de la mise à jour du type d'espace. Sortie uniquement pour une autre utilisation.

singleUserBotDm

boolean

Facultatif. Indique si l'espace est un MP entre une application Chat et un seul humain.

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 vous recevez le message d'erreur ALREADY_EXISTS lors de la création d'un espace ou de la mise à jour de displayName, essayez un autre displayName. Il est possible qu'un espace existant de 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

Immuable. Indique si cet espace autorise tous les utilisateurs de Google Chat à devenir membres. Saisies 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 dans l'espace.

  • L'espace est utilisé pour 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 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 les voir qu'une fois l'importation terminée.

createTime

string (Timestamp format)

Facultatif. Immuable. Pour les espaces créés dans Chat, il s'agit de l'heure à laquelle ils ont été créés. Ce champ n'est généré qu'en 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.

Renseigné dans la sortie uniquement lorsque spaceType est défini sur 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 l'échange de messages privés entre les utilisateurs et l'application. Pour permettre l'installation administrateur, votre application doit inclure cette fonctionnalité.

accessSettings

object (AccessSettings)

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

Type

Obsolète: utilisez plutôt SpaceType.

Enums
TYPE_UNSPECIFIED
ROOM Les conversations entre deux personnes ou plus
DM Messages privés entre un humain 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 pour la création ou la mise à jour d'un espace. Sortie uniquement pour une autre utilisation.

Enums
SPACE_TYPE_UNSPECIFIED Réservé.
SPACE Un endroit où les gens envoient des messages, partagent des fichiers et collaborent. Un élément SPACE peut inclure des applications Chat.
GROUP_CHAT Des conversations de groupe entre trois personnes ou plus Un élément GROUP_CHAT peut inclure des applications Chat.
DIRECT_MESSAGE Messages 1:1 entre deux humains ou entre un humain 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 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

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 discussion, l'objectif fonctionnel ou les participants de l'espace.

Jusqu'à 150 caractères.

guidelines

string

Facultatif. Les règles, les attentes et les usages de l’espace.

Jusqu'à 5 000 caractères.

HistoryState

État de l'historique des messages et des espaces. Spécifie 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 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.

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 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 par une audience cible. Désactivez ce champ pour restreindre 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.

AccessState

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

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

Méthodes

completeImport

Finalise 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.