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	添加电子邮件地址并为其添加标准标签（“住址”“工作”等）或自定义标签 {@code // The code below retrieves a contact named "John Doe" and adds the email // address "[e-mail]" to the ContactsApp.Field.HOME_EMAIL label.
addIM(label, address)	IMField	为联系人添加即时通讯地址，并为其添加标准标签或自定义标签。
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[]	获取此联系人的所有即时通讯地址。
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 ContactsApp.Field.WORK_ADDRESS
// label.
const contacts = ContactsApp.getContactsByName('John Doe');
const 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".
const contacts = ContactsApp.getContactsByName('John Doe');
const 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'.
const 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".
const contacts = ContactsApp.getContactsByName('John Doe');
const 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.
const contacts = ContactsApp.getContactsByName('John Doe');
const 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)

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

为联系人添加即时通讯地址，并为其添加标准标签或自定义标签。

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

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

参数

名称	类型	说明
label	Object	新即时通讯地址的标签，可以是 ContactsApp.Field 或自定义字符串
address	String	新的即时通讯地址

返回

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 ContactsApp.Field.WORK_PHONE label.
const contacts = ContactsApp.getContactsByName('John Doe');
const 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"
let contact = ContactsApp.createContact('John', 'Doe', '[e-mail]');
const 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 ContactsApp.Field.WORK_WEBSITE label.
const contacts = ContactsApp.getContactsByName('John Doe');
const 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()

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

删除此联系人。

const contacts = ContactsApp.getContactsByName('John Doe');
for (const 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"
const contacts = ContactsApp.getContactsByName('John Doe');
for (const 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.
const contacts = ContactsApp.getContactsByName('John Doe');
const addresses = contacts[0].getAddresses(ContactsApp.Field.WORK_ADDRESS);
for (const 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"
const contacts = ContactsApp.getContactsByName('John Doe');
for (const i in contacts) {
  const companies = contacts[i].getCompanies();
  for (const 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
const contacts = ContactsApp.getContactsByName('John Doe');
const 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
const contacts = ContactsApp.getContactsByName('John Doe');
const fields = contacts[0].getCustomFields();
for (const 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.
const contacts = ContactsApp.getContactsByName('John Doe');
const hobbies = contacts[0].getCustomFields(ContactsApp.ExtendedField.HOBBY);
for (const 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
const contacts = ContactsApp.getContactsByName('John Doe');
const dates = contacts[0].getDates();
for (const 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.
const contacts = ContactsApp.getContactsByName('John Doe');
const birthdays = contacts[0].getDates(ContactsApp.Field.BIRTHDAY);
for (const 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
const contacts = ContactsApp.getContactsByName('John Doe');
const emails = contacts[0].getEmails();
for (const 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.
const contacts = ContactsApp.getContactsByName('John Doe');
const emails = contacts[0].getEmails(ContactsApp.Field.HOME_EMAIL);
for (const 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"
const contacts = ContactsApp.getContactsByName('John');
for (const 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"
const contacts = ContactsApp.getContactsByName('John');
for (const 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"
const contacts = ContactsApp.getContactsByName('Smith');
for (const 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()

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

获取此联系人的所有即时通讯地址。

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

返回

IMField[] - 即时通讯地址列表

授权

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

• 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.
const contacts = ContactsApp.getContactsByName('John Doe');
const imAddresses = contacts[0].getIMs(ContactsApp.Field.GOOGLE_TALK);
for (const i in imAddresses) {
  Logger.log(imAddresses[i].getAddress());
}

参数

名称	类型	说明
label	Object	要匹配的标签，可以是 ContactsApp.Field 中的标签，也可以是自定义字符串

返回

IMField[] - 即时通讯地址列表

授权

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

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

另请参阅

• addIM(label, address)

---

getId()

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

返回此联系人的唯一 ID。

const contact = ContactsApp.createContact(
    'John',
    'Doe',
    '[e-mail]',
);
const 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"
const contacts = ContactsApp.getContactsByName('John Doe');
for (const 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"
const contacts = ContactsApp.getContactsByName('John Doe');
for (const 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"
const contacts = ContactsApp.getContactsByName('Jane');
for (const 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"
const contacts = ContactsApp.getContactsByName('Smith');
for (const 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"
const contacts = ContactsApp.getContactsByName('John Doe');
for (const 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"
const contacts = ContactsApp.getContactsByName('John Doe');
for (const 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"
const contacts = ContactsApp.getContactsByName('John Doe');
for (const 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.
const contacts = ContactsApp.getContactsByName('John Doe');
const phones = contacts[0].getPhones(ContactsApp.Field.WORK_PHONE);
for (const 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"
const contacts = ContactsApp.getContactsByName('John Doe');
for (const 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"
const contacts = ContactsApp.getContactsByName('John Doe');
for (const 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"
const contacts = ContactsApp.getContactsByName('Johnathan');
for (const 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"
const contacts = ContactsApp.getContactsByName('John Doe');
for (const 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"
const contacts = ContactsApp.getContactsByName('John Doe');
for (const 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.
const contacts = ContactsApp.getContactsByName('John Doe');
const urls = contacts[0].getUrls(ContactsApp.Field.WORK_WEBSITE);
for (const 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
const contacts = ContactsApp.getContactsByName('John Doe');
const group = ContactsApp.getContactGroup('Work Friends');
for (const 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"
const contacts = ContactsApp.getContactsByName('John Doe');
for (const 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"
const contacts = ContactsApp.getContactsByName('John Doe');
for (const 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"
const contacts = ContactsApp.getContactsByName('John Doe');
for (const 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"
const contacts = ContactsApp.getContactsByName('Johnathan Doe');
for (const 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"
const contacts = ContactsApp.getContactsByName('Jane Doe');
for (const 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"
const contacts = ContactsApp.getContactsByName('John Doe');
for (const 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"
const contacts = ContactsApp.getContactsByName('John Doe');
for (const 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"
const contacts = ContactsApp.getContactsByName('John Doe');
for (const 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"
const contacts = ContactsApp.getContactsByName('Johnathan Doe');
for (const 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"
const contacts = ContactsApp.getContactsByName('Johnathan Doe');
for (const 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"
const contacts = ContactsApp.getContactsByName('Johnathan Doe');
for (const 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