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 |
Identifiant. Nom de la ressource de l'espace. Format : Où |
type |
Uniquement en sortie. Obsolète: utilisez |
space |
Facultatif. Type d'espace. Obligatoire lors de la création d'un espace ou de la mise à jour 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 |
display |
Facultatif. Nom à afficher de l'espace. Obligatoire lors de la création d'un espace avec un Pour les messages privés, ce champ peut être vide. Peut contenir jusqu'à 128 caractères. |
external |
Facultatif. Immuable. Indique si cet espace autorise tout utilisateur Google Chat à en être membre. Valeur à saisir lorsque vous créez 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 est de sortie uniquement. |
space |
Uniquement en sortie. État des fils de discussion dans l'espace Chat. |
space |
Facultatif. Informations sur l'espace, y compris sa description et ses règles |
space |
Facultatif. É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 La création d'un espace dans |
create |
Facultatif. Immuable. Pour les espaces créés dans Chat, l'heure à laquelle ils ont été créés. Ce champ est à usage exclusif 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 au moment de la 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 |
last |
Uniquement en sortie. Code temporel du dernier message dans 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 au nom des utilisateurs de leur organisation. Pour être compatible avec l'installation par administrateur, votre application Chat doit proposer les messages privés. |
membership |
Uniquement en sortie. Nombre d'adhésions 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. ID 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, saisis uniquement lors de la création de l'espace. Si le 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 des espaces 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. La sortie 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 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 |
Espace où les utilisateurs peuvent envoyer des messages, partager des fichiers et collaborer. Un SPACE peut inclure des applications Chat. |
GROUP_CHAT |
Les 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 entre 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 le faire dans le fil de discussion, ce qui permet de garder 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 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 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 Peut contenir 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 discussion après leur création.
Enums | |
---|---|
HISTORY_STATE_UNSPECIFIED |
Valeur par défaut. Ne pas utiliser. |
HISTORY_OFF |
L'historique est 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 discussions. |
MembershipCount
Représente le nombre d'adhésions à un espace, regroupées par catégories.
Représentation JSON |
---|
{ "joinedDirectHumanUserCount": integer, "joinedGroupCount": integer } |
Champs | |
---|---|
joined |
Uniquement en sortie. 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 |
Uniquement en sortie. Nombre de groupes ayant rejoint directement 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 la ressource de l'audience cible pouvant découvrir l'espace, le rejoindre et prévisualiser les messages qu'il contient. Si cette option n'est pas définie, 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 la portée Pour définir l'audience cible, vous devez vous authentifier. |
AccessState
Représente l'état d'accès de l'espace.
Enums | |
---|---|
ACCESS_STATE_UNSPECIFIED |
L'état d'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 d'espace a accordé à une audience cible l'accès à l'espace. Les utilisateurs ou groupes Google qui ont été ajoutés ou invités individuellement à l'espace peuvent également le découvrir et y accéder. Pour en savoir plus, consultez Rendre un espace visible pour 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 les paramètres d'autorisation lors de la création d'un espace, spécifiez le champ PredefinedPermissionSettings
dans votre requête.
Représentation JSON |
---|
{ "manageMembersAndGroups": { object ( |
Champs | |
---|---|
manage |
Facultatif. Paramètre permettant de gérer les membres et les groupes dans un espace. |
modify |
Facultatif. Paramètre permettant de modifier le nom, l'avatar, la description et les consignes de l'espace. |
toggle |
Facultatif. Paramètre permettant d'activer ou de désactiver l'historique des espaces. |
use |
Facultatif. Paramètre permettant d'utiliser @tous dans un espace. |
manage |
Facultatif. Paramètre permettant de gérer les applications dans un espace. |
manage |
Facultatif. 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 |
Facultatif. 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 |
Facultatif. Indique si les gestionnaires d'espaces disposent de cette autorisation. |
members |
Facultatif. 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é. |
|
Renvoie des informations sur un espace. |
|
Liste les espaces dont l'appelant est membre. |
|
Met à jour un espace. |
|
Renvoie la liste des espaces d'une organisation Google Workspace en fonction de la recherche d'un administrateur. |
|
Crée un espace et y ajoute les utilisateurs spécifiés. |