- Ressource : Espace
- Représentation JSON
- Type
- SpaceType
- SpaceThreadingState
- SpaceDetails
- HistoryState
- MembershipCount
- AccessSettings
- AccessState
- PredefinedPermissionSettings
- PermissionSettings
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- PermissionSetting
- Méthodes
Ressource : Espace
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 ( |
Champs | |
---|---|
name |
Nom de ressource de l'espace. Format : Où |
type |
Uniquement en sortie. Obsolète: utilisez plutôt |
space |
Type d'espace. Obligatoire lors de la création d'un espace ou de la modification de son type. Sortie uniquement pour une autre utilisation. |
single |
Facultatif. Indique si l'espace est un message privé entre une application Chat et une personne. |
threaded |
Uniquement en sortie. Obsolète: utilisez plutôt |
display |
Nom à afficher de l'espace. Obligatoire lorsque vous créez un espace avec un Pour les messages privés, ce champ peut être vide. Peut contenir jusqu'à 128 caractères. |
external |
Immuable. Indique si cet espace autorise tout utilisateur Google Chat à en être membre. Saisie lors de la création d'un espace dans une organisation Google Workspace. Omettre ce champ lorsque vous créez des espaces dans les conditions suivantes :
Pour les espaces existants, ce champ n'est fourni qu'en sortie. |
space |
Uniquement en sortie. État des fils de discussion dans l'espace Chat. |
space |
Informations sur l'espace, y compris sa description et ses règles |
space |
État de l'historique des messages pour les messages et les fils de discussion de cet espace. |
import |
Facultatif. Indique si cet espace est créé dans Pour créer un espace dans |
create |
Facultatif. Immuable. Pour les espaces créés dans Chat, l'heure à laquelle ils ont été créés. 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 |
last |
Uniquement en sortie. Code temporel du dernier message de l'espace. |
admin |
Uniquement en sortie. Pour les espaces de messages privés (MP) 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 pour le compte des utilisateurs de leur organisation. Pour permettre l'installation par l'administrateur, votre application Chat doit comporter la messagerie privée. |
membership |
Uniquement en sortie. Nombre d'adhésions membres, regroupées par type de membre. Renseigné lorsque |
access |
Facultatif. Indique le paramètre d'accès de l'espace. N'est renseigné que lorsque |
space |
Uniquement en sortie. URI permettant à un utilisateur d'accéder à l'espace. |
customer |
Facultatif. Immuable. Numéro client du domaine de l'espace. Obligatoire uniquement lors de la création d'un espace avec authentification de l'application et lorsque Au format Pour les MP, ce champ n'est pas renseigné. |
Champ d'union Authentification des utilisateurs requise. |
|
predefined |
Facultatif. Uniquement en entrée. Paramètres d'autorisation prédéfinis pour l'espace, à saisir uniquement lors de la création d'un espace. Si ce 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 |
permission |
Facultatif. Paramètres d'autorisation pour les espaces existants. Saisie permettant de modifier les paramètres d'autorisation exacts de l'espace, où les paramètres d'autorisation existants sont remplacés. Le résultat liste les paramètres d'autorisation actuels. |
Type
Obsolète : utilisez SpaceType
à la place.
Enums | |
---|---|
TYPE_UNSPECIFIED |
Réservé. |
ROOM |
Conversations entre deux personnes ou plus. |
DM |
Message privé entre un humain et une application de 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 une autre utilisation.
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 de thread 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 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. 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 pendant laquelle les messages et les fils de discussion sont conservés 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 | |
---|---|
joined |
Nombre d'utilisateurs humains ayant rejoint directement l'espace, sans compter les utilisateurs qui y ont accédé en tant que membres d'un groupe associé. |
joined |
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 | |
---|---|
access |
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 par une audience cible. Format : Pour utiliser l'audience cible par défaut de l'organisation Google Workspace, définissez la valeur sur La lecture de l'audience cible permet de :
Ce champ n'est pas renseigné lorsque vous utilisez le champ d'application La définition de l'audience cible nécessite une authentification de l'utilisateur. |
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 qui ont été ajoutés ou invités individuellement par d'autres utilisateurs ou administrateurs Google Workspace peuvent découvrir et accéder à l'espace. |
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. La création d'espaces visibles nécessite une authentification de l'utilisateur. |
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 pourraient ê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 faire de l'espace un espace de collaboration où tous les membres peuvent publier des messages. |
ANNOUNCEMENT_SPACE |
Paramètre permettant de transformer l'espace en espace d'annonces où seuls les gestionnaires de l'espace peuvent publier des messages. |
PermissionSettings
Paramètres d'autorisation que vous pouvez spécifier lorsque vous modifiez un espace nommé existant.
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 | |
---|---|
manage |
Paramètre permettant de gérer les membres et les groupes d'un espace. |
modify |
Paramètre permettant de modifier le nom, l'avatar, la description et les consignes de l'espace. |
toggle |
Paramètre permettant d'activer et de désactiver l'historique des espaces. |
use |
Paramètre permettant d'utiliser @tous dans un espace. |
manage |
Paramètre permettant de gérer les applications d'un espace. |
manage |
Paramètre permettant de gérer les webhooks dans un espace. |
post |
Uniquement en sortie. Paramètre permettant de publier des messages dans un espace. |
reply |
Paramètre pour 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 | |
---|---|
managers |
Indique si les gestionnaires de l'espace disposent de cette autorisation. |
members |
Indique si les membres non administrateurs disposent de cette autorisation. |
Méthodes |
|
---|---|
|
Termine le processus d'importation pour l'espace spécifié et le rend visible pour les utilisateurs. |
|
Crée un espace sans membres. |
|
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. |
|
Affiche la liste des espaces d'une organisation Google Workspace en fonction d'une recherche effectuée par un administrateur. |
|
Crée un espace et y ajoute les utilisateurs spécifiés. |