REST Resource: members

Ressource: Membre

Un membre Google Groupes peut être un utilisateur ou un autre groupe. Ce membre peut se trouver à l'intérieur ou à l'extérieur des domaines de votre compte. Pour en savoir plus sur les tâches courantes des membres d'un groupe, consultez le guide du développeur.

Représentation JSON 
{
  "kind": string,
  "email": string,
  "role": string,
  "etag": string,
  "type": string,
  "status": string,
  "delivery_settings": string,
  "id": string
}
Champs
kind

string

Type de ressource d'API. Pour les ressources membres, la valeur est admin#directory#member.
email

string

Adresse e-mail du membre. Un membre peut être un utilisateur ou un autre groupe. Cette propriété est obligatoire lorsque vous ajoutez un membre à un groupe. Le email doit être unique et ne peut pas être un alias d'un autre groupe. Si l'adresse e-mail est modifiée, l'API reflète automatiquement les modifications apportées.
role

string

Rôle du membre dans un groupe. L'API renvoie une erreur pour les cycles d'appartenance à des groupes. Par exemple, si group1 est membre de group2, group2 ne peut pas être membre de group1. Pour en savoir plus sur le rôle des membres, consultez Attribuer des rôles aux membres d'un groupe.

Les valeurs acceptées sont les suivantes :

  • MANAGER: ce rôle n'est disponible que si Google Groups for Business est activé via la console d'administration. Consultez l'article Activer ou désactiver Groups for Business. Un rôle MANAGER permet d'effectuer toutes les opérations associées à un rôle OWNER, mais peut uniquement désigner un membre comme OWNER ou supprimer le groupe. Un groupe peut comporter plusieurs membres MANAGER.
  • MEMBER: ce rôle permet de s'abonner à un groupe, de consulter les archives de discussions et de consulter la liste des membres du groupe. Pour en savoir plus sur les rôles des membres, consultez Attribuer des rôles aux membres d'un groupe.
  • OWNER: ce rôle permet d'envoyer des messages au groupe, d'ajouter ou de supprimer des membres, de modifier les rôles des membres, de modifier les paramètres du groupe et de supprimer le groupe. Un membre OWNER doit être membre du groupe. Un groupe peut comporter plusieurs OWNER.
etag

string

ETag de la ressource.
type

string

Type de membre du groupe.

Les valeurs acceptées sont les suivantes :

  • CUSTOMER: le membre représente tous les utilisateurs d'un domaine. Aucune adresse e-mail n'est renvoyée et l'ID renvoyé est le numéro client.
  • EXTERNAL: le membre est un utilisateur ou un groupe extérieur au domaine. (Non utilisé actuellement)
  • GROUP: le membre est un autre groupe.
  • USER: le membre est un utilisateur.
status

string

Statut du membre (immuable)
delivery_settings

string

Définit les préférences de distribution des e-mails du membre. Ce champ n'est compatible qu'avec les méthodes insert, update et get.

Les valeurs acceptées sont les suivantes :

  • ALL_MAIL: tous les messages, distribués dès leur arrivée.
  • DAILY: un seul message par jour.
  • DIGEST: jusqu'à 25 messages regroupés dans un même message.
  • DISABLED: supprimer l'abonnement.
  • NONE: aucun message.
id

string

Identifiant unique du membre du groupe. Un id de membre peut être utilisé en tant qu'URI de demande de membre memberKey.

Méthodes

delete

 Supprime un membre d'un groupe.

get

 Récupère les propriétés d'un membre du groupe.

hasMember

 Vérifie si l'utilisateur donné est membre du groupe.

insert

 Ajoute un utilisateur au groupe spécifié.

list

 Récupère la liste paginée de tous les membres d'un groupe.

patch

 Met à jour les propriétés d'adhésion d'un utilisateur au groupe spécifié.

update

 Met à jour l'appartenance d'un utilisateur au groupe spécifié.