Class ContactGroup

ContactGroup

已弃用。请改用 People API 高级 服务

ContactGroup 是一个联系人组。

已弃用的方法

方法	返回类型	简介
addContact(contact)	ContactGroup	将指定联系人添加到此群组
deleteGroup()	void	删除此联系人群组。
getContacts()	Contact[]	获取此联系人群组中的所有联系人。
getGroupName()	String	返回此群组的名称。
getId()	String	获取此联系人群组的 ID。
getName()	String	获取此联系人群组的名称。
isSystemGroup()	Boolean	获取布尔值，以确定此联系人组是系统组（无法删除）还是 错误。
removeContact(contact)	ContactGroup	从此群组中删除给定联系人
setGroupName(name)	void	设置此群组的名称。
setName(name)	ContactGroup	设置此联系人群组的名称。

已弃用的方法

addContact(contact)

已弃用。此函数已弃用，不应在新脚本中使用。

将指定联系人添加到此群组

// The code below creates a new contact and adds it to the "Work Friends" contact group
var contact = ContactsApp.createContact('John', 'Doe', '[e-mail]');
var group = ContactsApp.getContactGroup('Work Friends');
group.addContact(contact);

参数

名称	类型	说明
contact	Contact	要添加到群组中的联系人

返回

ContactGroup - 此联系人群组

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

另请参阅

• removeContact(contact)

---

deleteGroup()

已弃用。此函数已弃用，不应在新脚本中使用。

删除此联系人群组。

仅删除非系统群组；无法删除系统群组。

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

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

另请参阅

• isSystemGroup()

---

getContacts()

已弃用。此函数已弃用，不应在新脚本中使用。

获取此联系人群组中的所有联系人。

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

返回

Contact[] - 此群组中的联系人

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

---

getGroupName()

已弃用。此函数已弃用，不应在新脚本中使用。

返回此群组的名称。

返回

String - 此群组的名称

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

---

getId()

已弃用。此函数已弃用，不应在新脚本中使用。

获取此联系人群组的 ID。

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

返回

String - 此群组的 ID

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

---

getName()

已弃用。此函数已弃用，不应在新脚本中使用。

获取此联系人群组的名称。

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

返回

String - 此联系人群组的名称

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

另请参阅

• setName(name)

---

isSystemGroup()

已弃用。此函数已弃用，不应在新脚本中使用。

获取布尔值，以确定此联系人组是系统组（无法删除）还是 错误。

系统群组是指 Google 通讯录中预定义的一组群组，例如“我的群组” “Contacts”（联系人）、“Family”（家人）、“Coworkers”（同事）等。系统群组的名称中通常包含 “系统组”。

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

返回

Boolean - 此联系人群组是否为系统群组

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

---

removeContact(contact)

已弃用。此函数已弃用，不应在新脚本中使用。

从此群组中删除给定联系人

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

参数

名称	类型	说明
contact	Contact	要从群组中删除的联系人

返回

ContactGroup - 此联系人群组

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

另请参阅

• addContact(contact)

---

setGroupName(name)

已弃用。此函数已弃用，不应在新脚本中使用。

设置此群组的名称。

参数

名称	类型	说明
name	String	要为此群组设置的名称

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

---

setName(name)

已弃用。此函数已弃用，不应在新脚本中使用。

设置此联系人群组的名称。

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

参数

名称	类型	说明
name	String	联系人群组的新名称

返回

ContactGroup - 此联系人群组

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

另请参阅

• getName()