Présentation de l'API Groups Settings

L'API Groups Settings met à jour et récupère les paramètres d'un groupe Google existant. Grâce à l'API, vous pouvez effectuer les opérations suivantes:

  • modifier les paramètres d'accès d'un groupe interne et externe ;
  • Modifiez 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 Groupes 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 manière dont les utilisateurs d'un compte communiquent et collaborent avec des groupes d'autres personnes. Chaque groupe est identifié par l'adresse e-mail du groupe.

Le modèle de données de l'API est basé sur la collection Groups des groupes du compte. Chaque groupe possède 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 get 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 compatibles avec toutes les fonctionnalités de lecture/écriture.

JSON est un format Internet courant qui permet de représenter des structures de données arbitraires. Selon json.org, JSON est un format de texte qui est complètement indépendant du langage, mais qui utilise des conventions connues des programmeurs de la famille C, comme 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