L'API Groups Settings met à jour et récupère les paramètres d'un groupe Google existant. L'API vous permet d'effectuer les opérations suivantes:
- Modifiez les paramètres d'un groupe pour l'accès interne et externe.
- Modifier les notifications du groupe
- Configurez l'archivage des discussions et la modération des messages.
- Personnalisez les groupes d'utilisateurs de votre compte.
Pour découvrir d'autres façons d'utiliser Google Groups ou de gérer d'autres types de groupes, consultez la documentation Cloud Identity.
Modèle de données de l'API Groups Settings
L'API Groups Settings fonctionne sur une ressource Groups, qui représente la façon dont les utilisateurs d'un compte communiquent et collaborent avec des groupes d'autres personnes. Chaque groupe est identifié par son adresse e-mail.
Le modèle de données de l'API est basé sur la collection Groups des groupes du compte. Chaque groupe dispose d'un ensemble unique de paramètres de configuration.
Opérations de l'API Groups Settings
Vous pouvez appeler des méthodes de paramètres de groupe dans l'API Groups Settings, comme décrit dans le tableau suivant:
| Opération | Description | Mappages HTTP REST |
|---|---|---|
get |
Récupère les paramètres d'un groupe pour le compte d'un client. Toutes les opérations de récupération doivent être autorisées par un utilisateur authentifié. | GET sur un URI de groupe. |
update |
Met à jour les paramètres d'un groupe pour le compte d'un client. Toutes les opérations de mise à jour doivent être autorisées par un utilisateur authentifié. | PUT sur un URI de groupe. |
Formats de données JSON et Atom
Par défaut, l'API Groups Settings renvoie les données au format JSON. La notation Atom est un autre format de données. Les formats de données JSON et Atom sont tous deux compatibles avec les fonctionnalités de lecture/écriture complètes.
JSON est un format Internet courant qui fournit une méthode pour représenter des structures de données arbitraires. Selon json.org, le format JSON est un format de texte complètement indépendant de la langue, mais qui utilise des conventions familières aux programmeurs de la famille de langages C, y compris C, C++, C#, Java, JavaScript, Perl et Python.
Pour modifier le format de données de l'API, incluez la chaîne de requête alt dans l'URI de votre requête, par exemple:
JSON
GET https://www.googleapis.com/groups/v1/groups/salesgroup@example.com?alt=json
Atom
GET https://www.googleapis.com/groups/v1/groups/salesgroup@example.com?alt=atom