Class ContactGroup

ContactGroup

Deprecated. Instead, use the People API advanced service

A ContactGroup is is a group of contacts.

MethodReturn typeBrief description
addContact(contact)ContactGroupAdds the given contact to this group 
// 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()voidDeletes this contact group.
getContacts()Contact[]Gets all the contacts in this contact group.
getGroupName()StringReturns the name of this 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 
// 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)voidSets the name of this group.
setName(name)ContactGroupSets the name of this contact group.

Deprecated methods

Deprecated. This function is deprecated and should not be used in new scripts.

Adds the given contact to this group 

// 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);

Parameters

NameTypeDescription
contactContactthe contact to be added to the group

Return

ContactGroup — this contact group

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

See also

Deprecated. This function is deprecated and should not be used in new scripts.

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
const group = ContactsApp.getContactGroup('Work Friends');
group.deleteGroup();

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

See also

Deprecated. This function is deprecated and should not be used in new scripts.

Gets all the contacts in this contact group. 

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

Return

Contact[] — the contacts in this group

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

Deprecated. This function is deprecated and should not be used in new scripts.

Returns the name of this group.

Return

String — the name of this group

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

Deprecated. This function is deprecated and should not be used in new scripts.

Gets the id of this contact group. 

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

Return

String — the id of this group

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

Deprecated. This function is deprecated and should not be used in new scripts.

Gets the name of this contact group. 

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

Return

String — this name of this contact group

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

See also

Deprecated. This function is deprecated and should not be used in new scripts.

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.
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.

Return

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

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

Deprecated. This function is deprecated and should not be used in new scripts.

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
const contacts = ContactsApp.getContactsByName('John Doe');
const group = ContactsApp.getContactGroup('Work Friends');
for (const i in contacts) {
  group.removeContact(contacts[i]);
}

Parameters

NameTypeDescription
contactContactthe contact to be removed from the group

Return

ContactGroup — this contact group

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

See also

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the name of this group.

Parameters

NameTypeDescription
nameStringthe name to set for this group

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the name of this contact group. 

// 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');

Parameters

NameTypeDescription
nameStringthe new name for the contact group

Return

ContactGroup — this contact group

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

See also