Class ContactsApp

“通讯录”应用

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

借助此类，用户可以访问自己的 Google 通讯录，并创建、移除和更新其中列出的联系人。

已弃用的媒体资源

属性	类型	说明
ExtendedField	ExtendedField
Field	Field
Gender	Gender
Month	Month
Priority	Priority
Sensitivity	Sensitivity

已弃用的方法

方法	返回类型	简介
createContact(givenName, familyName, email)	Contact	创建新联系人。
createContactGroup(name)	ContactGroup	创建具有给定名称的联系人群组 // The code below creates a new contact group named "Work Friends" const group = ContactsApp.createContactGroup('Work Friends');
deleteContact(contact)	void	删除联系人。
deleteContactGroup(group)	void	删除联系人群组 // The code below creates deletes the contact group named "Work Friends" const group = ContactsApp.getContactGroup('Work Friends'); ContactsApp.deleteContactGroup(group);
findByEmailAddress(email)	Contact	查找具有指定电子邮件地址的联系人。
findContactGroup(name)	ContactGroup	查找指定名称的联系人群组。
getAllContacts()	Contact[]	获取此用户的所有联系人。
getContact(emailAddress)	Contact	根据电子邮件地址获取联系人。
getContactById(id)	Contact	获取具有此 ID 的联系人。
getContactGroup(name)	ContactGroup	获取指定名称的联系人群组；如果未找到此类联系人群组，则返回 null。
getContactGroupById(id)	ContactGroup	获取具有给定 ID 的联系人群组，如果未找到此类联系人群组，则返回 null。
getContactGroups()	ContactGroup[]	获取用户联系人群组的完整列表。
getContacts()	Contact[]	获取用户的所有联系人。
getContactsByAddress(query)	Contact[]	获取与地址匹配的联系人。
getContactsByAddress(query, label)	Contact[]	获取与地址匹配的联系人，仅限于特定字段。
getContactsByAddress(query, label)	Contact[]	获取与地址匹配的联系人，仅限于指定的自定义地址标签。
getContactsByCompany(query)	Contact[]	获取与公司字段匹配的联系人。
getContactsByCustomField(query, label)	Contact[]	获取与自定义字段中的给定值匹配的联系人。
getContactsByDate(month, day, label)	Contact[]	获取与特定标准字段的给定月份和日期匹配的联系人。
getContactsByDate(month, day, year, label)	Contact[]	获取与特定标准字段的给定月份、日期和年份匹配的联系人。
getContactsByDate(month, day, year, label)	Contact[]	获取与特定自定义字段的指定月份、日期和年份匹配的联系人。
getContactsByDate(month, day, label)	Contact[]	获取与特定自定义字段的给定月份和日期匹配的联系人。
getContactsByEmailAddress(query)	Contact[]	获取与电子邮件地址匹配的联系人。
getContactsByEmailAddress(query, label)	Contact[]	获取与电子邮件地址匹配的联系人，仅限于特定字段。
getContactsByEmailAddress(query, label)	Contact[]	获取与电子邮件地址匹配的联系人，仅限于指定的自定义电子邮件地址标签。
getContactsByGroup(group)	Contact[]	获取指定 ContactGroup 中的联系人。
getContactsByIM(query)	Contact[]	获取与即时通讯地址匹配的联系人。
getContactsByIM(query, label)	Contact[]	获取与即时通讯地址匹配的联系人（仅限特定字段）。
getContactsByIM(query, label)	Contact[]	获取与即时通讯地址匹配的联系人，仅限于指定的自定义即时通讯标签。
getContactsByJobTitle(query)	Contact[]	获取与“职位”字段匹配的联系人。
getContactsByName(query)	Contact[]	获取与名称匹配的联系人。
getContactsByName(query, label)	Contact[]	获取与名称匹配的联系人，仅限于特定字段。
getContactsByNotes(query)	Contact[]	获取与“备注”字段匹配的联系人。
getContactsByPhone(query)	Contact[]	获取与电话号码匹配的联系人。
getContactsByPhone(query, label)	Contact[]	获取与电话号码匹配的联系人，仅限于特定字段。
getContactsByPhone(query, label)	Contact[]	获取与电话号码匹配的联系人，仅限于指定的自定义电话号码标签。
getContactsByUrl(query)	Contact[]	获取与网址匹配的联系人。
getContactsByUrl(query, label)	Contact[]	获取与网址匹配的联系人，仅限于特定字段。
getContactsByUrl(query, label)	Contact[]	获取与网址匹配的联系人，仅限于指定的自定义网址标签。

已弃用的方法

createContact(givenName, familyName, email)

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

创建新联系人。

// The code below creates a new contact with the name "John Doe" and the email
// address "[e-mail]".
const contact = ContactsApp.createContact(
    'John',
    'Doe',
    '[e-mail]',
);

参数

名称	类型	说明
givenName	String	联系人的名字
familyName	String	联系人的姓氏
email	String	联系人的电子邮件地址

返回

Contact - 新创建的 Contact 对象

授权

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

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

另请参阅

• deleteContact(contact)

---

createContactGroup(name)

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

创建具有给定名称的联系人群组

// The code below creates a new contact group named "Work Friends"
const group = ContactsApp.createContactGroup('Work Friends');

参数

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

返回

ContactGroup - 新创建的联系人群组

授权

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

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

另请参阅

• deleteContactGroup(group)

---

deleteContact(contact)

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

删除联系人。

// The code below retrieves a contact with the email address
// "[e-mail]" and then deletes that contact.
const contact = ContactsApp.getContact('[e-mail]');
ContactsApp.deleteContact(contact);

参数

名称	类型	说明
contact	Contact	要删除的联系人

授权

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

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

另请参阅

• createContact(givenName, familyName, email)

---

deleteContactGroup(group)

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

删除联系人群组

// The code below creates deletes the contact group named "Work Friends"
const group = ContactsApp.getContactGroup('Work Friends');
ContactsApp.deleteContactGroup(group);

参数

名称	类型	说明
group	ContactGroup	要删除的联系人群组

授权

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

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

另请参阅

• createContactGroup(name)

---

findByEmailAddress(email)

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

查找具有指定电子邮件地址的联系人。

参数

名称	类型	说明
email	String	要查找的联系人的电子邮件地址

返回

Contact - 包含该电子邮件地址的联系人

授权

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

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

---

findContactGroup(name)

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

查找指定名称的联系人群组。

参数

名称	类型	说明
name	String	要查找的联系群组的名称

返回

ContactGroup - 与给定名称匹配的联系人群组

授权

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

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

---

getAllContacts()

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

获取此用户的所有联系人。

返回

Contact[] - 此用户的所有联系人

授权

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

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

---

getContact(emailAddress)

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

根据电子邮件地址获取联系人。

如果多个联系人使用相同的电子邮件地址，该方法会优先返回将该电子邮件地址标记为主要电子邮件地址的联系人；如果没有联系人将该电子邮件地址标记为主要电子邮件地址，或者有多个联系人将该电子邮件地址标记为主要电子邮件地址，则会返回按联系人排序顺序的第一条结果。

// The code below retrieves a contact with the email address
// "[e-mail]".
const contact = ContactsApp.getContact('[e-mail]');

参数

名称	类型	说明
emailAddress	String	联系人的电子邮件地址

返回

Contact - 包含该电子邮件地址的联系人

授权

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

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

另请参阅

• getContacts()
• getContactById(id)

---

getContactById(id)

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

获取具有此 ID 的联系人。

// The code below retrieves the contact with the id
// "http://www.google.com/m8/feeds/contacts/john.doe%40example.com/base/7c86afde08d34ca5"
const id =
    'http://www.google.com/m8/feeds/contacts/john.doe%40example.com/base/7c86afde08d34c';
const contact = ContactsApp.getContactById(id);

参数

名称	类型	说明
id	String	要检索的联系人的 ID

返回

Contact - 匹配的联系人或 null

授权

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

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

另请参阅

• getContact(emailAddress)

---

getContactGroup(name)

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

获取具有给定名称的联系人群组；如果未找到此类联系人群组，则返回 null。

// The code below returns the contact group with the name "Work Friends"
const group = ContactsApp.getContactGroup('Work Friends');

参数

名称	类型	说明
name	String	要匹配的联系人群组的名称

返回

ContactGroup - 匹配的联系人群组，如果未找到匹配的联系人群组，则为 null

授权

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

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

另请参阅

• getContactGroups()

---

getContactGroupById(id)

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

获取具有给定 ID 的联系人群组；如果找不到此类联系人群组，则返回 null。

// The code below returns the contact group with the id
// "http://www.google.com/m8/feeds/groups/john.doe%40example.com/base/54eefbb093fdecb"
const id =
    'http://www.google.com/m8/feeds/groups/john.doe%40example.com/base/54eefbb093fdecb';
const group = ContactsApp.getContactGroupById(id);

参数

名称	类型	说明
id	String	要匹配的联系人群组的 ID

返回

ContactGroup - 匹配的联系人群组，如果未找到匹配的联系人群组，则为 null

另请参阅

• getContactGroups()

---

getContactGroups()

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

获取用户联系人群组的完整列表。

用户可以拥有联系人列表，也可能拥有联系人群组列表。每个联系人群组都可以包含联系人。此方法会返回所有联系人群组的列表。

// The retrieves all the contract groups for the user and then logs the group
// name of each contact group.
const groups = ContactsApp.getContactGroups();
for (let i = 0; i < groups.length; i++) {
  Logger.log(groups[i].getName());
}

返回

ContactGroup[] - 用户的联系人群组的数组

授权

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

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

另请参阅

• getContactGroup(name)

---

getContacts()

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

获取用户的所有联系人。

// The code below will retrieve all the user's contacts
const contacts = ContactsApp.getContacts();

返回

Contact[] - 用户的所有联系人的数组

授权

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

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

另请参阅

• getContact(emailAddress)

---

getContactsByAddress(query)

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

获取与地址匹配的联系人。

// The code below returns an array of contacts where the contact's address
// contains "San Francisco'.
const contacts = ContactsApp.getContactsByAddress('San Francisco');

参数

名称	类型	说明
query	String	要在联系人地址中搜索的字符串

返回

Contact[] - 匹配联系人的数组

授权

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

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

另请参阅

• getContact(emailAddress)

---

getContactsByAddress(query, label)

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

获取与地址匹配的联系人，仅限于特定字段。

// The code below returns an array of contacts where the contact's address
// contains "San Francisco" in the Home address field.
const contacts = ContactsApp.getContactsByAddress(
    'San Francisco',
    ContactsApp.Field.HOME_ADDRESS,
);

参数

名称	类型	说明
query	String	要在联系人地址中搜索的字符串
label	Field	要搜索的字段

返回

Contact[] - 匹配联系人的数组

授权

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

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

另请参阅

• getContact(emailAddress)

---

getContactsByAddress(query, label)

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

获取与地址匹配的联系人，仅限于指定的自定义地址标签。

// The code below returns an array of contacts where the contact's address
// contains "San Francisco" in a custom address label (created by the user)
// called "vacation".
const contacts = ContactsApp.getContactsByAddress('San Francisco', 'vacation');

参数

名称	类型	说明
query	String	要在包含指定自定义地址标签的联系人地址中搜索的字符串
label	String	要搜索的自定义地址标签

返回

Contact[] - 匹配联系人的数组

授权

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

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

另请参阅

• getContact(emailAddress)

---

getContactsByCompany(query)

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

获取与公司字段匹配的联系人。

// The code below returns an array of contacts where the contact's company field
// contains "Google".
const contacts = ContactsApp.getContactsByCompany('Google');

参数

名称	类型	说明
query	String	要在联系人的“公司”字段中搜索的字符串

返回

Contact[] - 匹配联系人的数组

授权

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

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

另请参阅

• getContact(emailAddress)

---

getContactsByCustomField(query, label)

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

获取与自定义字段中的给定值匹配的联系人。

自定义字段可以通过字符串指定，也可以指定为 ContactsApp.ExtendedField 值之一。

// The code below returns an array of contacts where the contact's custom field
// named "Favorite Sport" contains "tennis".
const contacts = ContactsApp.getContactsByCustomField(
    'tennis',
    'Favorite Sport',
);

参数

名称	类型	说明
query	Object	要在联系人自定义字段中搜索的字符串
label	ExtendedField	要搜索的自定义字段

返回

Contact[] - 匹配联系人的数组

授权

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

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

另请参阅

• getContact(emailAddress)

---

getContactsByDate(month, day, label)

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

获取与特定标准字段的给定月份和日期匹配的联系人。

// The code below returns an array of contacts where the contact's "Birthday"
// field contains April for the month and 19 for the day.
const contacts = ContactsApp.getContactsByDate(
    ContactsApp.Month.APRIL,
    19,
    ContactsApp.Field.BIRTHDAY,
);

参数

名称	类型	说明
month	Month	要匹配的月份，为 ContactsApp.Month 中的某个值
day	Integer	匹配的日期
label	Field	要搜索的字段，来自 ContactsApp.Field

返回

Contact[] - 匹配联系人的数组

授权

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

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

另请参阅

• getContact(emailAddress)

---

getContactsByDate(month, day, year, label)

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

获取与特定标准字段的给定月份、日期和年份匹配的联系人。

// The code below returns an array of contacts where the contact's "Birthday"
// field contains April for the month, 19 for the day, and 1950 for the year.
const contacts = ContactsApp.getContactsByDate(
    ContactsApp.Month.APRIL,
    19,
    1950,
    ContactsApp.Field.BIRTHDAY,
);

参数

名称	类型	说明
month	Month	要匹配的月份，为 ContactsApp.Month 中的某个值
day	Integer	匹配的日期
year	Integer	要匹配的年份，可以为 null
label	Field	要搜索的字段，来自 ContactsApp.Field

返回

Contact[] - 匹配联系人的数组

授权

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

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

另请参阅

• getContact(emailAddress)

---

getContactsByDate(month, day, year, label)

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

获取与特定自定义字段的给定月份、日期和年份匹配的联系人。

// The code below returns an array of contacts where the contact's custom "Start
// Date" field contains April for the month, 19 for the day, and 2011 for the
// year.
const contacts = ContactsApp.getContactsByDate(
    ContactsApp.Month.APRIL,
    19,
    2011,
    'Start Date',
);

参数

名称	类型	说明
month	Month	要匹配的月份，为 ContactsApp.Month 中的某个值
day	Integer	匹配的日期
year	Integer	要匹配的年份，可以为 null
label	String	要搜索的自定义字段

返回

Contact[] - 匹配联系人的数组

授权

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

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

另请参阅

• getContact(emailAddress)

---

getContactsByDate(month, day, label)

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

获取与特定自定义字段的给定月份和日期匹配的联系人。

// The code below returns an array of contacts where the contact's custom "Start
// Date" field contains April for the month and 19 for the day.
const contacts = ContactsApp.getContactsByDate(
    ContactsApp.Month.APRIL,
    19,
    'Start Date',
);

参数

名称	类型	说明
month	Month	要匹配的月份，为 ContactsApp.Month 中的某个值
day	Integer	匹配的日期
label	String	要搜索的自定义字段

返回

Contact[] - 匹配联系人的数组

授权

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

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

另请参阅

• getContact(emailAddress)

---

getContactsByEmailAddress(query)

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

获取与电子邮件地址匹配的联系人。

// The code below returns an array of contacts where the contact's email address
// contains "[e-mail]'.
const contacts = ContactsApp.getContactsByEmailAddress('[e-mail]');

参数

名称	类型	说明
query	String	要在联系人电子邮件地址中搜索的字符串

返回

Contact[] - 匹配联系人的数组

授权

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

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

另请参阅

• getContact(emailAddress)

---

getContactsByEmailAddress(query, label)

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

获取与电子邮件地址匹配的联系人，仅限于特定字段。

// The code below returns an array of contacts where the contact's email address
// contains "[e-mail]" in the Home email field.
const contacts = ContactsApp.getContactsByEmailAddress(
    '[e-mail]',
    ContactsApp.Field.HOME_EMAIL,
);

参数

名称	类型	说明
query	String	要在联系人电子邮件地址中搜索的字符串
label	Field	要搜索的字段

返回

Contact[] - 匹配联系人的数组

授权

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

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

另请参阅

• getContact(emailAddress)

---

getContactsByEmailAddress(query, label)

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

获取与电子邮件地址匹配的联系人，仅限于指定的自定义电子邮件地址标签。

// The code below returns an array of contacts where the contact's email address
// contains "[e-mail]" in a custom email address label (created by
// the user) called "alternate".
const contacts = ContactsApp.getContactsByEmailAddress(
    '[e-mail]',
    'alternate',
);

参数

名称	类型	说明
query	String	要在包含指定自定义电子邮件地址标签的联系人电子邮件地址中搜索的字符串
label	String	要搜索的自定义电子邮件地址标签

返回

Contact[] - 匹配联系人的数组

授权

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

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

另请参阅

• getContact(emailAddress)

---

getContactsByGroup(group)

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

获取指定 ContactGroup 中的联系人。

// The code below returns an array of contacts in the ContactGroup with the name
// "Work Friends".
const group = ContactsApp.getContactGroup('Work Friends');
const contacts = ContactsApp.getContactsByGroup(group);

参数

名称	类型	说明
group	ContactGroup	联系人群组

返回

Contact[] - 指定群组中的联系人数组

授权

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

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

另请参阅

• getContact(emailAddress)

---

getContactsByIM(query)

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

获取与即时通讯地址匹配的联系人。

// The code below returns an array of contacts where the contact's instant
// messaging address contains "ChatWithJohnDoe" in any instant messaging field.
const contacts = ContactsApp.getContactsByIM('ChatWithJohnDoe');

参数

名称	类型	说明
query	String	要在联系人的即时通讯地址中搜索的字符串

返回

Contact[] - 匹配联系人的数组

授权

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

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

另请参阅

• getContact(emailAddress)

---

getContactsByIM(query, label)

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

获取与即时通讯地址匹配的联系人，仅限于特定字段。

// The code below returns an array of contacts where the contact's instant
// messaging address contains "ChatWithJohnDoe" in the AIM instant messaging
// field.
const contacts = ContactsApp.getContactsByIM(
    'ChatWithJohnDoe',
    ContactsApp.Field.AIM,
);

参数

名称	类型	说明
query	String	要在联系人的即时通讯地址中搜索的字符串
label	Field	要搜索的字段

返回

Contact[] - 匹配联系人的数组

授权

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

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

另请参阅

• getContact(emailAddress)

---

getContactsByIM(query, label)

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

获取与即时通讯地址匹配的联系人，仅限于指定的自定义即时通讯标签。

// The code below returns an array of contacts where the contact's instant
// messaging address contains "ChatWithJohnDoe" in a custom instant messaging
// label (created by the user) called "eBuddy".
const contacts = ContactsApp.getContactsByIM('ChatWithJohnDoe', 'eBuddy');

参数

名称	类型	说明
query	String	要在联系人的即时通讯地址（带有指定自定义即时通讯标签）中搜索的字符串
label	String	要搜索的自定义即时通讯标签

返回

Contact[] - 匹配联系人的数组

授权

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

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

另请参阅

• getContact(emailAddress)

---

getContactsByJobTitle(query)

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

获取与“职位”字段匹配的联系人。

// The code below returns an array of contacts where the contact's job title
// field contains "Product Manager".
const contacts = ContactsApp.getContactsByJobTitle('Product Manager');

参数

名称	类型	说明
query	String	要在联系人的“职位”字段中搜索的字符串

返回

Contact[] - 匹配联系人的数组

授权

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

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

另请参阅

• getContact(emailAddress)

---

getContactsByName(query)

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

获取与名称匹配的联系人。

// The code below returns an array of contacts where the contact name contains
// "John"
const contacts = ContactsApp.getContactsByName('John');

参数

名称	类型	说明
query	String	要在联系人姓名中搜索的字符串

返回

Contact[] - 匹配联系人的数组

授权

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

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

另请参阅

• getContact(emailAddress)

---

getContactsByName(query, label)

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

获取与名称匹配的联系人，仅限于特定字段。

// The code below returns an array of contacts where the contact name contains
// "John" in the Given Name field.
const contacts = ContactsApp.getContactsByName(
    'John',
    ContactsApp.Field.GIVEN_NAME,
);

参数

名称	类型	说明
query	String	要在联系人姓名中搜索的字符串
label	Field	要搜索的字段

返回

Contact[] - 匹配联系人的数组

授权

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

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

另请参阅

• getContact(emailAddress)

---

getContactsByNotes(query)

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

获取与“备注”字段匹配的联系人。

// The code below returns an array of contacts where the contact's notes field
// contains "sent birthday card".
const contacts = ContactsApp.getContactsByNotes('sent birthday card');

参数

名称	类型	说明
query	String	要在联系人备注字段中搜索的字符串

返回

Contact[] - 匹配联系人的数组

授权

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

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

另请参阅

• getContact(emailAddress)

---

getContactsByPhone(query)

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

获取与电话号码匹配的联系人。

此方法会展开带字母的电话号码，因此，如果您搜索“212-555-CODE”，而您的联系人中包含“212-555-2633”，或者反之，此方法会找到相应的联系人。

// The code below returns an array of contacts where the contact's phone number
// contains "212-555-1234' in any phone number field.
const contacts = ContactsApp.getContactsByPhone('212-555-1234');

参数

名称	类型	说明
query	String	要在联系人的电话号码中搜索的字符串

返回

Contact[] - 匹配联系人的数组

授权

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

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

另请参阅

• getContact(emailAddress)

---

getContactsByPhone(query, label)

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

获取与电话号码匹配的联系人，仅限于特定字段。

此方法会展开带字母的电话号码，因此，如果您搜索“212-555-CODE”，而您的联系人中包含“212-555-2633”，或者反之，此方法会找到相应的联系人。

// The code below returns an array of contacts where the contact's phone number
// contains "212-555-1234" in the Home phone number field.
const contacts = ContactsApp.getContactsByPhone(
    '212-555-1234',
    ContactsApp.Field.HOME_PHONE,
);

参数

名称	类型	说明
query	String	要在联系人的电话号码中搜索的字符串
label	Field	要搜索的字段

返回

Contact[] - 匹配联系人的数组

授权

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

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

另请参阅

• getContact(emailAddress)

---

getContactsByPhone(query, label)

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

获取与电话号码匹配的联系人，仅限于指定的自定义电话号码标签。

此方法会展开带字母的电话号码，因此，如果您搜索“212-555-CODE”，而您的联系人中包含“212-555-2633”，或者反之，此方法会找到相应的联系人。

// The code below returns an array of contacts where the contact's phone number
// contains "212-555-1234" in a custom phone number label (created by the user)
// called "alternate".
const contacts = ContactsApp.getContactsByPhone('212-555-1234', 'alternate');

参数

名称	类型	说明
query	String	要在联系人的电话号码中搜索的字符串，其中包含指定的自定义电话号码标签
label	String	要搜索的自定义电话号码标签

返回

Contact[] - 匹配联系人的数组

授权

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

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

另请参阅

• getContact(emailAddress)

---

getContactsByUrl(query)

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

获取与网址匹配的联系人。

// The code below returns an array of contacts where the contact's URL contains
// "www.example.com' in any URL field.
const contacts = ContactsApp.getContactsByUrl('www.example.com');

参数

名称	类型	说明
query	String	要在联系人的网址中搜索的字符串

返回

Contact[] - 匹配联系人的数组

授权

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

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

另请参阅

• getContact(emailAddress)

---

getContactsByUrl(query, label)

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

获取与网址匹配的联系人，仅限于特定字段。

// The code below returns an array of contacts where the contact's URL contains
// "www.example.com" in the Work URL field.
const contacts = ContactsApp.getContactsByUrl(
    'www.example.com',
    ContactsApp.Field.WORK_WEBSITE,
);

参数

名称	类型	说明
query	String	要在联系人的网址中搜索的字符串
label	Field	要搜索的字段

返回

Contact[] - 匹配联系人的数组

授权

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

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

另请参阅

• getContact(emailAddress)

---

getContactsByUrl(query, label)

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

获取与网址匹配的联系人，仅限于指定的自定义网址标签。

// The code below returns an array of contacts where the contact's URL contains
// "www.example.com" in a custom URL label (created by the user) called
// "alternate work".
const contacts = ContactsApp.getContactsByUrl(
    'www.example.com',
    'alternate work',
);

参数

名称	类型	说明
query	String	要在包含指定自定义网址标签的联系人网址中搜索的字符串
label	String	要搜索的自定义网址标签

返回

Contact[] - 匹配联系人的数组

授权

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

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

另请参阅

• getContact(emailAddress)