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	使用標準或自訂標籤將即時通訊地址新增至聯絡人。
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 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)

已淘汰。這個函式已淘汰，不應用於新的指令碼。

使用標準或自訂標籤將即時通訊地址新增至聯絡人。

標籤可以來自 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	新即時訊息地址的標籤 (來自 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 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()

已淘汰。這個函式已淘汰，不應用於新的指令碼。

取得這位聯絡人的所有即時通訊地址。

// 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[]：即時訊息地址清單

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

• 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[]：即時訊息地址清單

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

• 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