Class ContactGroup

ContacterGroup

Obsolète. Utilisez plutôt le service avancé de l'API People.

Un ContactGroup est un groupe de contacts.

MéthodeType renvoyéBrève description
addContact(contact)ContactGroupAjoute le contact donné à ce groupe 
// The code below creates a new contact and adds it to the "Work Friends"
// contact group
const contact = ContactsApp.createContact(
    'John',
    'Doe',
    'john.doe@example.com',
);
const group = ContactsApp.getContactGroup('Work Friends');
group.addContact(contact);
deleteGroup()voidSupprime ce groupe de contacts.
getContacts()Contact[]Récupère tous les contacts de ce groupe de contacts.
getGroupName()StringRenvoie le nom de ce groupe.
getId()StringRécupère l'ID de ce groupe de contacts.
getName()StringRécupère le nom de ce groupe de contacts.
isSystemGroup()BooleanRécupère une valeur booléenne pour déterminer si ce groupe de contacts est un groupe système (non effaçable) ou non.
removeContact(contact)ContactGroupSupprime le contact donné de ce groupe 
// The code below retrieves all the contacts named "John Doe' and removes them
// from the "Work Friends" contact group
const contacts = ContactsApp.getContactsByName('John Doe');
const group = ContactsApp.getContactGroup('Work Friends');
for (const i in contacts) {
  group.removeContact(contacts[i]);
}
setGroupName(name)voidDéfinit le nom de ce groupe.
setName(name)ContactGroupDéfinit le nom de ce groupe de contacts.

Méthodes obsolètes

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans les nouveaux scripts.

Ajoute le contact donné à ce groupe 

// The code below creates a new contact and adds it to the "Work Friends"
// contact group
const contact = ContactsApp.createContact(
    'John',
    'Doe',
    'john.doe@example.com',
);
const group = ContactsApp.getContactGroup('Work Friends');
group.addContact(contact);

Paramètres

NomTypeDescription
contactContactle contact à ajouter au groupe ;

Renvois

ContactGroup : ce groupe de contacts

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:

  • https://www.google.com/m8/feeds

Voir aussi

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans les nouveaux scripts.

Supprime ce groupe de contacts.

Elle ne supprime que les groupes non système. Les groupes système ne peuvent pas être supprimés. 

// The code below retrieves a contact group named "Work Friends" and deletes it
const group = ContactsApp.getContactGroup('Work Friends');
group.deleteGroup();

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:

  • https://www.google.com/m8/feeds

Voir aussi

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans les nouveaux scripts.

Récupère tous les contacts de ce groupe de contacts. 

// The code below retrieves all the contacts in the group named "Work Friends"
const group = ContactsApp.getContactGroup('Work Friends');
const contacts = group.getContacts();

Renvois

Contact[] : contacts de ce groupe

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:

  • https://www.google.com/m8/feeds

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans les nouveaux scripts.

Renvoie le nom de ce groupe.

Renvois

String : nom de ce groupe

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:

  • https://www.google.com/m8/feeds

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans les nouveaux scripts.

Récupère l'ID de ce groupe de contacts. 

// The code below retrieves a contact group named "Work Friends" and gets its id
const group = ContactsApp.getContactGroup('Work Friends');
const id = group.getId();

Renvois

String : ID de ce groupe

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:

  • https://www.google.com/m8/feeds

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans les nouveaux scripts.

Récupère le nom de ce groupe de contacts. 

// The code below creates a new contact group and then retrieves its name
const group = ContactsApp.createContactGroup('Work Friends');
const name = group.getName();

Renvois

String : nom de ce groupe de contacts

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:

  • https://www.google.com/m8/feeds

Voir aussi

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans les nouveaux scripts.

Récupère une valeur booléenne pour déterminer si ce groupe de contacts est un groupe système (non effaçable) ou non.

Les groupes système sont un ensemble de groupes prédéfinis dans Google Contacts, tels que "Mes contacts", "Famille", "Collègues", etc. Le nom d'un groupe système contient généralement les mots "Groupe système". 

// The code below retrieves two contact groups, then logs whether or not
// each is a system group.
const myGroup = ContactsApp.getContactGroup('Work Friends');
const systemGroup = ContactsApp.getContactGroup('System Group: Coworkers');
Logger.log(myGroup.isSystemGroup());      // Returns false, if the group exists.
Logger.log(systemGroup.isSystemGroup());  // Returns true.

Renvois

Boolean : indique si ce groupe de contacts est un groupe système ou non

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:

  • https://www.google.com/m8/feeds

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans les nouveaux scripts.

Supprime le contact donné de ce groupe 

// The code below retrieves all the contacts named "John Doe' and removes them
// from the "Work Friends" contact group
const contacts = ContactsApp.getContactsByName('John Doe');
const group = ContactsApp.getContactGroup('Work Friends');
for (const i in contacts) {
  group.removeContact(contacts[i]);
}

Paramètres

NomTypeDescription
contactContactle contact à supprimer du groupe

Renvois

ContactGroup : ce groupe de contacts

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:

  • https://www.google.com/m8/feeds

Voir aussi

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans les nouveaux scripts.

Définit le nom de ce groupe.

Paramètres

NomTypeDescription
nameStringle nom à définir pour ce groupe

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:

  • https://www.google.com/m8/feeds

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans les nouveaux scripts.

Définit le nom de ce groupe de contacts. 

// The code below retrieves the contact group named "Work Friends" and renames
// it to "Work Buddies"
const group = ContactsApp.getContactGroup('Work Friends');
group.setName('Work Buddies');

Paramètres

NomTypeDescription
nameStringnouveau nom du groupe de contacts

Renvois

ContactGroup : ce groupe de contacts

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:

  • https://www.google.com/m8/feeds

Voir aussi