- Ressource: Espace
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Type
- SpaceType
- SpaceThreadingState
- SpaceDetails
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- HistoryState
- MembershipCount
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- AccessSettings
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- AccessState
- PredefinedPermissionSettings
- PermissionSettings
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- PermissionSetting
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Méthodes
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 ( |
Champs | |
---|---|
name |
Nom de ressource de l'espace. Format : |
type |
Uniquement en sortie. Obsolète: utilisez plutôt |
spaceType |
Type d'espace. Obligatoire pour créer un espace ou modifier son type. Sortie uniquement pour les autres utilisations. |
singleUserBotDm |
Facultatif. Indique si l'espace est un MP entre une application Chat et une seule personne. |
threaded |
Uniquement en sortie. Obsolète: utilisez plutôt |
displayName |
Nom à afficher de l'espace. Obligatoire lors de la création d'un espace. Si le message d'erreur Pour les messages privés, ce champ peut être vide. Il peut contenir jusqu'à 128 caractères. |
externalUserAllowed |
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:
Pour les espaces existants, ce champ n'est fourni qu'en sortie. |
spaceThreadingState |
Uniquement en sortie. État des fils de discussion dans l'espace Chat. |
spaceDetails |
Informations sur l'espace, y compris sa description et ses règles |
spaceHistoryState |
État de l'historique des messages et des fils de discussion de cet espace. |
importMode |
Facultatif. Indique si cet espace est créé dans |
createTime |
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 |
lastActiveTime |
Uniquement en sortie. Code temporel du dernier message de l'espace. |
adminInstalled |
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 |
Uniquement en sortie. Nombre d'adhésions membres, regroupées par type de membre. Renseigné lorsque |
accessSettings |
Facultatif. Spécifie le paramètre d'accès de l'espace. Renseigné uniquement lorsque |
spaceUri |
Uniquement en sortie. URI permettant à un utilisateur d'accéder à 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 |
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 |
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 |
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 les conversations sont organisées 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 |
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 |
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. 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 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ésentation JSON |
---|
{ "joinedDirectHumanUserCount": integer, "joinedGroupCount": integer } |
Champs | |
---|---|
joinedDirectHumanUserCount |
Nombre d'utilisateurs humains ayant directement rejoint l'espace (sans compter ceux qui ont rejoint un groupe). |
joinedGroupCount |
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 ( |
Champs | |
---|---|
accessState |
Uniquement en sortie. Indique l'état d'accès de l'espace. |
audience |
Facultatif. Nom de ressource de l'audience cible qui peut découvrir l'espace, le rejoindre et y prévisualiser les messages. Si cette règle n'est pas configurée, seuls les utilisateurs ou les groupes Google qui ont été invités ou ajoutés individuellement à l'espace peuvent y accéder. Pour en savoir plus, consultez Rendre un espace visible auprès d'une audience cible. Format : Pour utiliser l'audience cible par défaut de l'organisation Google Workspace, définissez-la sur |
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 |
Seuls les utilisateurs ou les groupes Google ajoutés ou invités individuellement par d'autres utilisateurs ou par des administrateurs Google Workspace peuvent le découvrir et y accéder. |
DISCOVERABLE |
Un gestionnaire de l'espace a autorisé une audience cible à accéder à l'espace. Les utilisateurs ou les groupes Google qui ont été individuellement ajoutés ou invités à l'espace peuvent également le découvrir et y accéder. Pour en savoir plus, consultez Rendre un espace visible par des utilisateurs spécifiques. |
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 |
Non spécifié. 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 ( |
Champs | |
---|---|
manageMembersAndGroups |
Paramètre permettant de gérer les membres et les groupes d'un espace. |
modifySpaceDetails |
Paramètre permettant de modifier le nom, l'avatar, la description et les consignes de l'espace. |
toggleHistory |
Paramètre permettant d'activer et de désactiver l'historique des espaces. |
useAtMentionAll |
Paramètre permettant d'utiliser @tous dans un espace. |
manageApps |
Paramètre permettant de gérer les applications d'un espace. |
manageWebhooks |
Paramètre permettant de gérer les webhooks dans un espace. |
postMessages |
Uniquement en sortie. Paramètre permettant de publier des messages dans un espace. |
replyMessages |
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 |
Indique si les gestionnaires de l'espace disposent de cette autorisation. |
membersAllowed |
Indique si les membres non administrateurs disposent de cette autorisation. |
Méthodes |
|
---|---|
|
Effectue le processus d'importation de l'espace spécifié et le rend visible par les utilisateurs. |
|
Crée un espace nommé. |
|
Supprime un espace nommé. |
|
Renvoie le message privé existant avec l'utilisateur spécifié. |
|
Affiche les détails d'un espace. |
|
Répertorie les espaces dont l'appelant est membre. |
|
Met à jour un espace. |
|
|
|
Crée un espace et y ajoute les utilisateurs spécifiés. |