Class Contact

联系

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

联系人包含联系人的姓名、地址和各种联系人详细信息。

已弃用的方法

方法	返回类型	简介
addAddress(label, address)	AddressField	使用标准或自定义标签为联系人添加地址。
addCompany(company, title)	CompanyField	向联系人添加公司。
addCustomField(label, content)	CustomField	向联系人添加带有扩展标签或自定义标签的自定义字段。
addDate(label, month, day, year)	DateField	为联系人添加带有标准标签或自定义标签的日期。
addEmail(label, address)	EmailField	添加带有标准标签（住址、工作地址等）或自定义标签的电子邮件地址
addIM(label, address)	IMField	使用标准或自定义标签向联系人添加 IM 地址。
addPhone(label, number)	PhoneField	为联系人添加带标准标签或自定义标签的电话号码。
addToGroup(group)	Contact	将此联系人添加到指定的联系人群组。
addUrl(label, url)	UrlField	为联系人添加带有标准或自定义标签的网址。
deleteContact()	void	删除此联系人。
getAddresses()	AddressField[]	获取此联系人的所有地址。
getAddresses(label)	AddressField[]	获取此联系人中与特定字段相匹配的所有地址。
getCompanies()	CompanyField[]	获取此联系人的所有公司。
getContactGroups()	ContactGroup[]	获取包含此联系人的所有联系人群组。
getCustomFields()	CustomField[]	获取此联系人的所有自定义字段。
getCustomFields(label)	CustomField[]	获取此联系人与特定字段匹配的所有自定义字段。
getDates()	DateField[]	获取此联系人的所有日期。
getDates(label)	DateField[]	获取此联系人与特定字段匹配的所有日期。
getEmailAddresses()	String[]	获取可用于此联系人的电子邮件地址列表。
getEmails()	EmailField[]	获取此联系人的电子邮件地址。
getEmails(label)	EmailField[]	获取与特定字段相匹配的此联系人的电子邮件地址。
getFamilyName()	String	获取字符串形式的联系人姓氏（姓氏）。
getFullName()	String	以字符串形式获取联系人的全名（指定姓名和姓氏）。
getGivenName()	String	以字符串形式获取联系人的指定姓名（名字）。
getHomeAddress()	String	获取此联系人的住址或空字符串（如果不存在）。
getHomeFax()	String	获取此联系人的家庭传真号码，如果不存在，则获取空字符串。
getHomePhone()	String	获取此联系人的家庭电话号码；如果不存在，则获取空字符串。
getIMs()	IMField[]	获取此联系人的所有 IM 地址。
getIMs(label)	IMField[]	获取此联系人中与特定字段匹配的所有即时通讯地址。
getId()	String	返回此联系人的唯一 ID。
getInitials()	String	获取联系人的首字母。
getLastUpdated()	Date	获取此联系人的上次更新时间。
getMaidenName()	String	获取字符串形式的联系人的婚前姓氏。
getMiddleName()	String	获取字符串形式的联系人中间名。
getMobilePhone()	String	获取此联系人的手机号码，如果不存在，则获取空字符串。
getNickname()	String	获取字符串形式的联系人昵称。
getNotes()	String	获取与此联系人关联的备注，如果没有备注，则获取空字符串。
getPager()	String	获取此联系人的寻呼机电话号码，如果不存在，则获取空字符串。
getPhones()	PhoneField[]	获取此联系人的所有电话号码。
getPhones(label)	PhoneField[]	获取此联系人中与某个特定字段匹配的所有电话号码。
getPrefix()	String	获取联系人姓名的前缀。
getPrimaryEmail()	String	获取字符串形式的联系人主电子邮件地址。
getShortName()	String	获取字符串形式的联系人简称。
getSuffix()	String	获取联系人姓名的后缀。
getUrls()	UrlField[]	获取此联系人的所有网址。
getUrls(label)	UrlField[]	获取此联系人中与特定字段相匹配的所有网址。
getUserDefinedField(key)	String	获取与指定键相关联的用户定义的值。
getUserDefinedFields()	Object	获取该联系人的所有用户定义字段，并将它们作为 JavaScript 对象。
getWorkAddress()	String	获取此联系人的工作地址；如果不存在，则获取空字符串。
getWorkFax()	String	获取此联系人的工作传真号码，如果不存在，则获取空字符串。
getWorkPhone()	String	获取此联系人的工作电话号码，如果不存在，则获取空字符串。
removeFromGroup(group)	Contact	从指定的联系人群组中删除该联系人。
setFamilyName(familyName)	Contact	设置联系人的姓氏（姓氏）。
setFullName(fullName)	Contact	设置联系人的全名（指定姓名和姓氏）。
setGivenName(givenName)	Contact	设置联系人的指定姓名。
setHomeAddress(addr)	void	设置此联系人的住址。
setHomeFax(phone)	void	设置此联系人的家庭传真号码。
setHomePhone(phone)	void	设置此联系人的家庭电话号码。
setInitials(initials)	Contact	设置联系人的首字母缩写。
setMaidenName(maidenName)	Contact	设置联系人的婚前姓。
setMiddleName(middleName)	Contact	设置联系人的中间名。
setMobilePhone(phone)	void	设置此联系人的手机号码。
setNickname(nickname)	Contact	设置联系人的昵称。
setNotes(notes)	Contact	设置与此联系人关联的备注。
setPager(phone)	void	设置此联系人的寻呼机号码。
setPrefix(prefix)	Contact	将前缀设置为联系人姓名。
setPrimaryEmail(primaryEmail)	void	设置此联系人的主电子邮件地址。
setShortName(shortName)	Contact	设置联系人的简称。
setSuffix(suffix)	Contact	为联系人的姓名设置后缀。
setUserDefinedField(key, value)	void	为此联系人设置单个用户定义的字段，以使用指定键进行存储。
setUserDefinedFields(o)	void	使用给定对象的属性设置该联系人的用户定义字段。
setWorkAddress(addr)	void	设置此联系人的工作地址。
setWorkFax(phone)	void	设置此联系人的工作传真号码。
setWorkPhone(phone)	void	设置此联系人的工作电话号码。

已弃用的方法

addAddress(label, address)

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

使用标准或自定义标签为联系人添加地址。

标签可以来自 ContactsApp.Field 或自定义标签字符串。

// The code below retrieves a contact named "John Doe" and adds the address
// "123 Main St, Some City, NY 10011" with the the ContactsApp.Field.WORK_ADDRESS label.
var contacts = ContactsApp.getContactsByName('John Doe');
var address = contacts[0].addAddress(ContactsApp.Field.WORK_ADDRESS,
                                    '123 Main St, Some City, NY 10011');

参数

名称	类型	说明
label	Object	新地址的标签，来自 ContactsApp.Field 或自定义字符串
address	String	新地址

返回

AddressField - 新创建的字段

授权

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

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

另请参阅

• getAddresses()

---

addCompany(company, title)

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

向联系人添加公司。

// The code below retrieves a contact named "John Doe" and adds the company "Google" and the
// job title "Product Manager".
var contacts = ContactsApp.getContactsByName('John Doe');
var url = contacts[0].addCompany('Google', 'Product Manager');

参数

名称	类型	说明
company	String	要添加到此联系人的公司的名称
title	String	与此公司的联系人关联的职位

返回

CompanyField - 新创建的字段

授权

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

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

另请参阅

• getCompanies()

---

addCustomField(label, content)

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

向联系人添加带有扩展标签或自定义标签的自定义字段。

标签可以来自 ContactsApp.ExtendedField 或自定义标签字符串。

// The code below retrieves a contact named "John Doe" and adds the custom field
// ContactsApp.ExtendedField.HOBBY with the value "hiking".
// Note that ContactsApp.ExtendedField.HOBBY is not the same as a custom field named 'HOBBY'.
var contacts = ContactsApp.getContactsByName('John Doe');
contacts[0].addCustomField(ContactsApp.ExtendedField.HOBBY, 'hiking');

参数

名称	类型	说明
label	Object	新地址的标签（来自 ContactsApp.ExtendedField 或自定义地址） 字符串
content	Object	要存储在自定义字段中的值

返回

CustomField - 新创建的字段

授权

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

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

另请参阅

• getCustomFields()

---

addDate(label, month, day, year)

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

为联系人添加带有标准标签或自定义标签的日期。

标签可以来自 ContactsApp.Field 或自定义标签字符串。

// The code below retrieves a contact named "John Doe" and adds a
// ContactsApp.ExtendedField.BIRTHDAY with the value "April 19, 1950".
var contacts = ContactsApp.getContactsByName('John Doe');
var birthday = contacts[0].addDate(ContactsApp.Field.BIRTHDAY,
                                   ContactsApp.Month.APRIL, 19, 1950);

参数

名称	类型	说明
label	Object	新日期的标签，来自 ContactsApp.Field 或自定义字符串
month	Month	（来自 ContactApps.Month）
day	Integer	这一天
year	Integer	年

返回

DateField - 新创建的日期

授权

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

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

另请参阅

• getDates()

---

addEmail(label, address)

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

添加带有标准标签（住址、工作地址等）或自定义标签的电子邮件地址

// The code below retrieves a contact named "John Doe" and adds the email address
// "[e-mail]" to the ContactsApp.Field.HOME_EMAIL label.
var contacts = ContactsApp.getContactsByName('John Doe');
var emailField = contacts[0].addEmail(ContactsApp.Field.HOME_EMAIL, '[e-mail]');

参数

名称	类型	说明
label	Object	新电子邮件的标签（来自 ContactsApp.Field 或自定义字符串）
address	String	新电子邮件地址

返回

EmailField - 新添加的字段

授权

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

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

---

addIM(label, address)

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

使用标准或自定义标签向联系人添加 IM 地址。

标签可以来自 ContactsApp.Field 或自定义标签字符串。

// The code below retrieves a contact named "John Doe" and adds the IM address "ChatWithJohn"
// with the the ContactsApp.Field.AIM label.
var contacts = ContactsApp.getContactsByName('John Doe');
var email = contacts[0].addIM(ContactsApp.Field.AIM, 'ChatWithJohn');

参数

名称	类型	说明
label	Object	新 IM 地址的标签（来自 ContactsApp.Field 或自定义字符串）
address	String	新 IM 地址

返回

IMField - 新创建的字段

授权

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

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

另请参阅

• getIMs()

---

addPhone(label, number)

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

为联系人添加带标准标签或自定义标签的电话号码。

标签可以来自 ContactsApp.Field 或自定义标签字符串。

// The code below retrieves a contact named "John Doe" and adds the phone number
// "212-555-1234" with the the ContactsApp.Field.WORK_PHONE label.
var contacts = ContactsApp.getContactsByName('John Doe');
var phone = contacts[0].addPhone(ContactsApp.Field.WORK_PHONE, '212-555-1234');

参数

名称	类型	说明
label	Object	新电话号码的标签（来自 ContactsApp.Field 或自定义 字符串
number	String	新电话号码

返回

PhoneField - 新创建的字段

授权

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

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

另请参阅

• getPhones()

---

addToGroup(group)

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

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

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

参数

名称	类型	说明
group	ContactGroup	要将此联系人添加到的联系人群组

返回

Contact - 此联系人

授权

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

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

另请参阅

• removeFromGroup(group)

---

addUrl(label, url)

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

为联系人添加带有标准或自定义标签的网址。

标签可以来自 ContactsApp.Field 或自定义标签字符串。

// The code below retrieves a contact named "John Doe" and adds the URL
// "http://www.example.com" with the the ContactsApp.Field.WORK_WEBSITE label.
var contacts = ContactsApp.getContactsByName('John Doe');
var url = contacts[0].addUrl(ContactsApp.Field.WORK_WEBSITE, 'http://www.example.com');

参数

名称	类型	说明
label	Object	新地址的标签，来自 ContactsApp.Field 或自定义字符串
url	String	新网址

返回

UrlField - 新创建的字段

授权

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

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

另请参阅

• getUrls()

---

deleteContact()

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

删除此联系人。

var contacts = ContactsApp.getContactsByName('John Doe');
for (var i in contacts) {
  contacts[i].deleteContact();
}

授权

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

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

---

getAddresses()

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

获取此联系人的所有地址。

// The code below logs the addresses of all the contacts whose names contain "John Doe"
var contacts = ContactsApp.getContactsByName('John Doe');
for (var i in contacts) {
  Logger.log(contacts[i].getAddresses());
}

返回

AddressField[] - 地址列表

授权

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

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

另请参阅

• addAddress(label, address)

---

getAddresses(label)

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

获取此联系人中与特定字段相匹配的所有地址。

标签可以来自 ContactsApp.Field 或自定义标签字符串。

// The code below retrieves a contact named "John Doe" and logs the addresses
// associated with that contact that are in the ContactsApp.Field.WORK_ADDRESS label.
var contacts = ContactsApp.getContactsByName('John Doe');
var addresses = contacts[0].getAddresses(ContactsApp.Field.WORK_ADDRESS);
for (var i in addresses) {
  Logger.log(addresses[i].getAddress());
}

参数

名称	类型	说明
label	Object	要匹配的标签（来自 ContactsApp.Field 或自定义字符串）

返回

AddressField[] - 地址列表

授权

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

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

另请参阅

• addAddress(label, address)

---

getCompanies()

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

获取此联系人的所有公司。

// The code below logs the company names of all the contacts whose names contain "John Doe"
var contacts = ContactsApp.getContactsByName('John Doe');
for (var i in contacts) {
  var companies = contacts[i].getCompanies();
  for (var j in companies) {
    Logger.log(companies[j].getCompanyName());
  }
}

返回

CompanyField[] - 公司列表

授权

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

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

另请参阅

• addCompany(company, title)

---

getContactGroups()

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

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

// The code below gets a contact named "John Doe" and retrieves all the contact groups that
// the contact belongs to
var contacts = ContactsApp.getContactsByName('John Doe');
var groups = contacts[0].getContactGroups();

返回

ContactGroup[] - 包含此联系人的群组

另请参阅

• addToGroup(group)

---

getCustomFields()

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

获取此联系人的所有自定义字段。

// The code below retrieves a contact named "John Doe" and logs the custom fields
// associated with that contact
var contacts = ContactsApp.getContactsByName('John Doe');
var fields = contacts[0].getCustomFields();
for (var i in fields) {
  Logger.log(fields[i].getValue());
}

返回

CustomField[] - 自定义字段列表

授权

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

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

另请参阅

• addCustomField(label, content)

---

getCustomFields(label)

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

获取此联系人与特定字段匹配的所有自定义字段。

标签可以是 ContactsApp.ExtendedField 中的标准标签，也可以是自定义标签 字符串。

// The code below retrieves a contact named "John Doe" and logs the custom fields
// associated with that contact that are in the ContactsApp.ExtendedField.HOBBY label.
var contacts = ContactsApp.getContactsByName('John Doe');
var hobbies = contacts[0].getCustomFields(ContactsApp.ExtendedField.HOBBY);
for (var i in hobbies) {
  Logger.log(hobbies[i].getValue());
}

参数

名称	类型	说明
label	Object	要匹配的标签（来自 ContactsApp.ExtendedField 或自定义字符串）

返回

CustomField[] - 自定义字段列表

授权

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

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

另请参阅

• addCustomField(label, content)

---

getDates()

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

获取此联系人的所有日期。

// The code below retrieves a contact named "John Doe" and logs the label of the date
// associated with that contact
var contacts = ContactsApp.getContactsByName('John Doe');
var dates = contacts[0].getDates();
for (var i in dates) {
  Logger.log(dates[i].getLabel());
}

返回

DateField[] - 日期列表

授权

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

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

另请参阅

• addDate(label, month, day, year)

---

getDates(label)

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

获取此联系人与特定字段匹配的所有日期。

标签可以是 ContactsApp.Field 中的标准标签，也可以是自定义标签字符串。

// The code below retrieves a contact named "John Doe" and logs the day of the month
// associated with that contact that are in the ContactsApp.Field.BIRTHDAY label.
var contacts = ContactsApp.getContactsByName('John Doe');
var birthdays = contacts[0].getDates(ContactsApp.Field.BIRTHDAY);
for (var i in birthdays) {
  Logger.log(birthdays[i].getDay());
}

参数

名称	类型	说明
label	Object	要匹配的标签（来自 ContactsApp.Field 或自定义字符串）

返回

DateField[] - 日期列表

授权

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

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

另请参阅

• addDate(label, month, day, year)

---

getEmailAddresses()

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

获取可用于此联系人的电子邮件地址列表。

返回

String[] - 此联系人可用的电子邮件地址列表

授权

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

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

---

getEmails()

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

获取此联系人的电子邮件地址。

// The code below retrieves a contact named "John Doe" and logs the email addresses
// associated with that contact
var contacts = ContactsApp.getContactsByName('John Doe');
var emails = contacts[0].getEmails();
for (var i in emails) {
  Logger.log(emails[i].getAddress());
}

返回

EmailField[] - 联系人的电子邮件地址列表

授权

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

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

另请参阅

• addEmail(label, address)

---

getEmails(label)

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

获取与特定字段相匹配的此联系人的电子邮件地址。

标签可以是 ContactsApp.Field 中的标准标签，也可以是自定义标签字符串。

// The code below retrieves a contact named "John Doe" and logs the email addresses
// associated with that contact that are in the ContactsApp.Field.HOME_EMAIL label.
var contacts = ContactsApp.getContactsByName('John Doe');
var emails = contacts[0].getEmails(ContactsApp.Field.HOME_EMAIL);
for (var i in emails) {
  Logger.log(emails[i].getAddress());
}

参数

名称	类型	说明
label	Object	要匹配的标签（来自 ContactsApp.Field 或自定义字符串）

返回

EmailField[] - 联系人的电子邮件地址列表

授权

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

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

另请参阅

• addEmail(label, address)

---

getFamilyName()

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

获取字符串形式的联系人姓氏（姓氏）。

// The code below logs the family name of all the contacts whose names contain "John"
var contacts = ContactsApp.getContactsByName('John');
for (var i in contacts) {
  Logger.log(contacts[i].getFamilyName());
}

返回

String - 联系人的姓氏

授权

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

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

另请参阅

• setFamilyName(familyName)

---

getFullName()

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

以字符串形式获取联系人的全名（指定姓名和姓氏）。

// The code below logs the full name of all the contacts whose names contain "John"
var contacts = ContactsApp.getContactsByName('John');
for (var i in contacts) {
  Logger.log(contacts[i].getFullName());
}

返回

String - 联系人的全名

授权

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

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

另请参阅

• setFullName(fullName)

---

getGivenName()

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

以字符串形式获取联系人的指定姓名（名字）。

// The code below logs the given name of all the contacts whose names contain "Smith"
var contacts = ContactsApp.getContactsByName('Smith');
for (var i in contacts) {
  Logger.log(contacts[i].getGivenName());
}

返回

String - 联系人的名字

授权

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

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

另请参阅

• setGivenName(givenName)

---

getHomeAddress()

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

获取此联系人的住址或空字符串（如果不存在）。

返回

String - 此联系人的家庭住址；如果不存在，则为空字符串

授权

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

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

---

getHomeFax()

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

获取此联系人的家庭传真号码，如果不存在，则获取空字符串。

返回

String - 此联系人的家庭传真号码；如果不存在，则为空字符串

授权

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

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

---

getHomePhone()

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

获取此联系人的家庭电话号码；如果不存在，则获取空字符串。

返回

String - 此联系人的家庭电话号码；如果不存在，则为空字符串

授权

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

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

---

getIMs()

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

获取此联系人的所有 IM 地址。

// The code below logs the IM addresses of all the contacts whose names contain "John Doe"
var contacts = ContactsApp.getContactsByName('John Doe');
for (var i in contacts) {
  Logger.log(contacts[i].getIMs());
}

返回

IMField[] - IM 地址列表

授权

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

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

另请参阅

• addIM(label, address)

---

getIMs(label)

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

获取此联系人中与特定字段匹配的所有即时通讯地址。

标签可以来自 ContactsApp.Field 或自定义标签字符串。

// The code below retrieves a contact named "John Doe" and logs the IM addresses
// associated with that contact that are in the ContactsApp.Field.GOOGLE_TALK label.
var contacts = ContactsApp.getContactsByName('John Doe');
var imAddresses = contacts[0].getIMs(ContactsApp.Field.GOOGLE_TALK);
for (var i in imAddresses) {
  Logger.log(imAddresses[i].getAddress());
}

参数

名称	类型	说明
label	Object	要匹配的标签（来自 ContactsApp.Field 或自定义字符串）

返回

IMField[] - IM 地址列表

授权

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

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

另请参阅

• addIM(label, address)

---

getId()

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

返回此联系人的唯一 ID。

var contact = ContactsApp.createContact('John', 'Doe', '[e-mail]');
var id = contact.getId();

返回

String - 此联系人的 ID

授权

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

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

---

getInitials()

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

获取联系人的首字母。

// The code below logs the initials of all the contacts whose names contain "John Doe"
var contacts = ContactsApp.getContactsByName('John Doe');
for (var i in contacts) {
  Logger.log(contacts[i].getInitials());
}

返回

String - 联系人的首字母缩写

授权

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

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

另请参阅

• setInitials(initials)

---

getLastUpdated()

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

获取此联系人的上次更新时间。

// The code below logs the last updated date of all the contacts whose names contain
// "John Doe"
var contacts = ContactsApp.getContactsByName('John Doe');
for (var i in contacts) {
  Logger.log(contacts[i].getLastUpdated());
}

返回

Date - 上次更新此联系人的日期

授权

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

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

---

getMaidenName()

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

获取字符串形式的联系人的婚前姓氏。

// The code below logs the maiden name of all the contacts whose names contain "Jane"
var contacts = ContactsApp.getContactsByName('Jane');
for (var i in contacts) {
  Logger.log(contacts[i].getMaidenName());
}

返回

String - 联系人的婚前姓氏

授权

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

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

另请参阅

• setMaidenName(maidenName)

---

getMiddleName()

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

获取字符串形式的联系人中间名。

// The code below logs the middle name of all the contacts whose names contain "Smith"
var contacts = ContactsApp.getContactsByName('Smith');
for (var i in contacts) {
  Logger.log(contacts[i].getMiddleName());
}

返回

String - 联系人的中间名

授权

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

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

另请参阅

• setMiddleName(middleName)

---

getMobilePhone()

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

获取此联系人的手机号码，如果不存在，则获取空字符串。

返回

String - 此联系人的手机号码；如果不存在，则为空字符串

授权

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

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

---

getNickname()

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

获取字符串形式的联系人昵称。

// The code below logs the nickname of all the contacts whose names contain "John Doe"
var contacts = ContactsApp.getContactsByName('John Doe');
for (var i in contacts) {
  Logger.log(contacts[i].getNickname());
}

返回

String - 联系人的昵称

授权

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

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

另请参阅

• setNickname(nickname)

---

getNotes()

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

获取与此联系人关联的备注，如果没有备注，则获取空字符串。

// The code below logs the notes of all the contacts whose names contain "John Doe"
var contacts = ContactsApp.getContactsByName('John Doe');
for (var i in contacts) {
  Logger.log(contacts[i].getNotes());
}

返回

String - 与此联系人关联的备注

授权

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

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

另请参阅

• setNotes(notes)

---

getPager()

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

获取此联系人的寻呼机电话号码，如果不存在，则获取空字符串。

返回

String - 此联系人的寻呼机电话号码；如果不存在，则为空字符串

授权

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

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

---

getPhones()

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

获取此联系人的所有电话号码。

// The code below logs the phone numbers of all the contacts whose names contain "John Doe"
var contacts = ContactsApp.getContactsByName('John Doe');
for (var i in contacts) {
  Logger.log(contacts[i].getPhones());
}

返回

PhoneField[] - 电话号码列表

授权

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

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

另请参阅

• addPhone(label, number)

---

getPhones(label)

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

获取此联系人中与某个特定字段匹配的所有电话号码。

标签可以来自 ContactsApp.Field 或自定义标签字符串。

// The code below retrieves a contact named "John Doe" and logs the phone numbers
// associated with that contact that are in the ContactsApp.Field.WORK_PHONE label.
var contacts = ContactsApp.getContactsByName('John Doe');
var phones = contacts[0].getPhones(ContactsApp.Field.WORK_PHONE);
for (var i in phones) {
  Logger.log(phones[i].getPhoneNumber());
}

参数

名称	类型	说明
label	Object	要匹配的标签（来自 ContactsApp.Field 或自定义字符串）

返回

PhoneField[] - 电话号码列表

授权

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

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

另请参阅

• addPhone(label, number)

---

getPrefix()

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

获取联系人姓名的前缀。

// The code below logs the prefix of all the contacts whose names contain "John Doe"
var contacts = ContactsApp.getContactsByName('John Doe');
for (var i in contacts) {
  Logger.log(contacts[i].getPrefix());
}

返回

String - 联系人姓名的前缀

授权

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

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

另请参阅

• setPrefix(prefix)

---

getPrimaryEmail()

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

获取字符串形式的联系人主电子邮件地址。

// The code below logs the primary email address of all the contacts whose names contain
// "John Doe"
var contacts = ContactsApp.getContactsByName('John Doe');
for (var i in contacts) {
  Logger.log(contacts[i].getPrimaryEmail());
}

返回

String - 联系人的主电子邮件地址

授权

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

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

---

getShortName()

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

获取字符串形式的联系人简称。

// The code below logs the short name of all the contacts whose names contain "Johnathan"
var contacts = ContactsApp.getContactsByName('Johnathan');
for (var i in contacts) {
  Logger.log(contacts[i].getShortName());
}

返回

String - 联系人的简称

授权

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

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

另请参阅

• setShortName(shortName)

---

getSuffix()

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

获取联系人姓名的后缀。

// The code below logs the suffix of all the contacts whose names contain "John Doe"
var contacts = ContactsApp.getContactsByName('John Doe');
for (var i in contacts) {
  Logger.log(contacts[i].getSuffix());
}

返回

String - 联系人姓名的后缀

授权

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

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

另请参阅

• setSuffix(suffix)

---

getUrls()

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

获取此联系人的所有网址。

// The code below logs the URLs of all the contacts whose names contain "John Doe"
var contacts = ContactsApp.getContactsByName('John Doe');
for (var i in contacts) {
  Logger.log(contacts[i].getUrls());
}

返回

UrlField[] - 网址列表

授权

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

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

另请参阅

• addUrl(label, url)

---

getUrls(label)

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

获取此联系人中与特定字段相匹配的所有网址。

标签可以来自 ContactsApp.Field 或自定义标签字符串。

// The code below retrieves a contact named "John Doe" and logs the URLs
// associated with that contact that are in the ContactsApp.Field.WORK_WEBSITE label.
var contacts = ContactsApp.getContactsByName('John Doe');
var urls = contacts[0].getUrls(ContactsApp.Field.WORK_WEBSITE);
for (var i in urls) {
  Logger.log(urls[i].getAddress());
}

参数

名称	类型	说明
label	Object	要匹配的标签（来自 ContactsApp.Field 或自定义字符串）

返回

UrlField[] - 网址列表

授权

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

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

另请参阅

• addUrl(label, url)

---

getUserDefinedField(key)

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

获取与指定键相关联的用户定义的值。

参数

名称	类型	说明
key	String	键可以是任何基本类型（String、int 等）

返回

String - 通过此键存储的用户指定内容

授权

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

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

---

getUserDefinedFields()

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

获取该联系人的所有用户定义字段，并将它们作为 JavaScript 对象。

返回

Object - 用户为此联系人定义的字段，作为 JavaScript 对象的属性

授权

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

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

---

getWorkAddress()

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

获取此联系人的工作地址；如果不存在，则获取空字符串。

返回

String - 此联系人的工作地址；如果不存在，则为空字符串

授权

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

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

---

getWorkFax()

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

获取此联系人的工作传真号码，如果不存在，则获取空字符串。

返回

String - 此联系人的工作传真号码；如果不存在，则为空字符串

授权

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

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

---

getWorkPhone()

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

获取此联系人的工作电话号码，如果不存在，则获取空字符串。

返回

String - 此联系人的工作电话号码；如果不存在，则为空字符串

授权

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

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

---

removeFromGroup(group)

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

从指定的联系人群组中删除该联系人。

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

参数

名称	类型	说明
group	ContactGroup	要从中移除此联系人的联系人群组

返回

Contact - 此联系人

授权

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

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

另请参阅

• addToGroup(group)

---

setFamilyName(familyName)

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

设置联系人的姓氏（姓氏）。

// The code below changes the family name of all the contacts whose names are "John Doe"
// to "Doe-Smith"
var contacts = ContactsApp.getContactsByName('John Doe');
for (var i in contacts) {
  contacts[i].setFamilyName('Doe-Smith');
}

参数

名称	类型	说明
familyName	String	联系人的新姓氏

返回

Contact - 此联系人

授权

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

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

另请参阅

• getFamilyName()

---

setFullName(fullName)

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

设置联系人的全名（指定姓名和姓氏）。

// The code below changes the full name of all the contacts whose names are "John Doe"
// to "Johnny Doe"
var contacts = ContactsApp.getContactsByName('John Doe');
for (var i in contacts) {
  contacts[i].setFullName('Johnny Doe');
}

参数

名称	类型	说明
fullName	String	联系人的新全名

返回

Contact - 此联系人

授权

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

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

另请参阅

• getFullName()

---

setGivenName(givenName)

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

设置联系人的指定姓名。

// The code below changes the given name of all the contacts whose names are "John Doe"
// to "Johnny"
var contacts = ContactsApp.getContactsByName('John Doe');
for (var i in contacts) {
  contacts[i].setGivenName('Johnny');
}

参数

名称	类型	说明
givenName	String	联系人的新名字

返回

Contact - 此联系人

授权

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

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

另请参阅

• getGivenName()

---

setHomeAddress(addr)

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

设置此联系人的住址。

参数

名称	类型	说明
addr	String	要设置的家庭住址

授权

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

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

---

setHomeFax(phone)

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

设置此联系人的家庭传真号码。

参数

名称	类型	说明
phone	String	要设置的家庭传真号码

授权

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

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

---

setHomePhone(phone)

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

设置此联系人的家庭电话号码。

参数

名称	类型	说明
phone	String	要设置的住宅电话号码

授权

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

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

---

setInitials(initials)

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

设置联系人的首字母缩写。

// The code below sets the initials of all the contacts whose names are "Johnathan Doe"
// to "JD"
var contacts = ContactsApp.getContactsByName('Johnathan Doe');
for (var i in contacts) {
  contacts[i].setInitials('JD');
}

参数

名称	类型	说明
initials	String	联系人的新首字母缩写

返回

Contact - 此联系人

授权

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

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

另请参阅

• getInitials()

---

setMaidenName(maidenName)

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

设置联系人的婚前姓。

// The code below changes the maiden name of all the contacts whose names are "Jane Doe"
// to "Smith"
var contacts = ContactsApp.getContactsByName('Jane Doe');
for (var i in contacts) {
  contacts[i].setMaidenName('Smith');
}

参数

名称	类型	说明
maidenName	String	联系人的新婚前姓

返回

Contact - 此联系人

授权

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

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

另请参阅

• getMaidenName()

---

setMiddleName(middleName)

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

设置联系人的中间名。

// The code below changes the middle name of all the contacts whose names are "John Doe"
// to "Danger"
var contacts = ContactsApp.getContactsByName('John Doe');
for (var i in contacts) {
  contacts[i].setMiddleName('Danger');
}

参数

名称	类型	说明
middleName	String	联系人的新中间名

返回

Contact - 此联系人

授权

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

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

另请参阅

• getMiddleName()

---

setMobilePhone(phone)

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

设置此联系人的手机号码。

参数

名称	类型	说明
phone	String	要设置的手机号码

授权

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

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

---

setNickname(nickname)

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

设置联系人的昵称。

// The code below changes the nickname of all the contacts whose names are "John Doe"
// to "JohnnyD"
var contacts = ContactsApp.getContactsByName('John Doe');
for (var i in contacts) {
  contacts[i].setNickname('JohnnyD');
}

参数

名称	类型	说明
nickname	String	联系人的新昵称

返回

Contact - 此联系人

授权

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

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

另请参阅

• getNickname()

---

setNotes(notes)

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

设置与此联系人关联的备注。

// The code below sets the notes of all the contacts whose names are "John Doe"
// to "Met him at the hackathon"
var contacts = ContactsApp.getContactsByName('John Doe');
for (var i in contacts) {
  contacts[i].setNotes('Met him at the hackathon');
}

参数

名称	类型	说明
notes	String	要为该联系人存储的备注

返回

Contact - 此联系人

授权

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

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

另请参阅

• getNotes()

---

setPager(phone)

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

设置此联系人的寻呼机号码。

参数

名称	类型	说明
phone	String	要设置的寻呼机号码

授权

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

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

---

setPrefix(prefix)

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

将前缀设置为联系人姓名。

// The code below sets the prefix of all the contacts whose names are "Johnathan Doe"
// to "Mr"
var contacts = ContactsApp.getContactsByName('Johnathan Doe');
for (var i in contacts) {
  contacts[i].setPrefix('Mr');
}

参数

名称	类型	说明
prefix	String	联系人姓名的新前缀

返回

Contact - 此联系人

授权

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

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

另请参阅

• getPrefix()

---

setPrimaryEmail(primaryEmail)

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

设置此联系人的主电子邮件地址。

参数

名称	类型	说明
primaryEmail	String	要设置的主电子邮件地址

授权

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

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

---

setShortName(shortName)

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

设置联系人的简称。

// The code below changes the short name of all the contacts whose names are "Johnathan Doe"
// to "John"
var contacts = ContactsApp.getContactsByName('Johnathan Doe');
for (var i in contacts) {
  contacts[i].setShortName('John');
}

参数

名称	类型	说明
shortName	String	联系人的新简称

返回

Contact - 此联系人

授权

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

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

另请参阅

• getShortName()

---

setSuffix(suffix)

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

为联系人的姓名设置后缀。

// The code below sets the suffix of all the contacts whose names are "Johnathan Doe"
// to "Jr"
var contacts = ContactsApp.getContactsByName('Johnathan Doe');
for (var i in contacts) {
  contacts[i].setSuffix('Jr');
}

参数

名称	类型	说明
suffix	String	联系人姓名的新后缀

返回

Contact - 此联系人

授权

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

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

另请参阅

• getSuffix()

---

setUserDefinedField(key, value)

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

为此联系人设置单个用户定义的字段，以使用指定键进行存储。

参数

名称	类型	说明
key	String	键可以是任何基本类型（String、int 等）
value	String	该值可以是任何基本类型（String、int 等）

授权

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

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

---

setUserDefinedFields(o)

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

使用给定对象的属性设置该联系人的用户定义字段。

参数

名称	类型	说明
o	Object	具有一个或多个属性的对象，形式为 {key: value}

授权

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

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

---

setWorkAddress(addr)

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

设置此联系人的工作地址。

参数

名称	类型	说明
addr	String	要设置的工作地址

授权

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

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

---

setWorkFax(phone)

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

设置此联系人的工作传真号码。

参数

名称	类型	说明
phone	String	要设置的工作传真号码

授权

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

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

---

setWorkPhone(phone)

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

设置此联系人的工作电话号码。

参数

名称	类型	说明
phone	String	要设置的工作电话号码

授权

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

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