Google Apps Script

Class ContactGroup

A ContactGroup is is a group of contacts.

Methods

MethodReturn typeBrief description
addContact(contact)ContactGroupAdds the given contact to this group
deleteGroup()voidDeletes this contact group.
getContacts()Contact[]Gets all the contacts in this contact group.
getId()StringGets the id of this contact group.
getName()StringGets the name of this contact group.
isSystemGroup()BooleanGets a boolean value to determine whether this contact group is a system group (undeletable) or not.
removeContact(contact)ContactGroupRemoves the given contact from this group
setName(name)ContactGroupSets the name of this contact group.

Detailed documentation

addContact(contact)

Adds the given contact to this group

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

Parameters

NameTypeDescription
contactContactthe contact to be added to the group

Return

ContactGroup — this contact group

See also


deleteGroup()

Deletes this contact group. Deletes non-system groups only; system groups cannot be deleted.

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

See also


getContacts()

Gets all the contacts in this contact group.

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

Return

Contact[] — the contacts in this group


getId()

Gets the id of this contact group.

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

Return

String — the id of this group


getName()

Gets the name of this contact group.

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

Return

String — this name of this contact group

See also


isSystemGroup()

Gets a boolean value to determine whether this contact group is a system group (undeletable) or not. Systems groups are a set of groups that are predefined in Google Contacts, such as "My Contacts", "Family", "Coworkers", etc. The name of a system group usually contains the words "System Group".

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

Return

Boolean — whether or not this contact group is a system group


removeContact(contact)

Removes the given contact from this group

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

Parameters

NameTypeDescription
contactContactthe contact to be removed from the group

Return

ContactGroup — this contact group

See also


setName(name)

Sets the name of this contact group.

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

Parameters

NameTypeDescription
nameStringthe new name for the contact group

Return

ContactGroup — this contact group

See also

Deprecated methods


Authentication required

You need to be signed in with Google+ to do that.

Signing you in...

Google Developers needs your permission to do that.