Class IMField

IMField

已淘汰。請改用 People API 進階服務

聯絡人中的即時通訊欄位。

方法

方法	傳回類型	簡短說明
getAddress()	String	取得這個欄位的地址。
getLabel()	Object	取得這個欄位的標籤。
isPrimary()	Boolean	取得是否為主要欄位值。
setAddress(address)	IMField	設定這個欄位的地址。
setAsPrimary()	IMField	將這個欄位設為 primary。
setLabel(field)	IMField	設定這個欄位的標籤。
setLabel(label)	IMField	設定這個欄位的標籤。

已淘汰的方法

方法	傳回類型	簡短說明
deleteIMField()	void	刪除這個即時訊息欄位。

內容詳盡的說明文件

getAddress()

取得這個欄位的地址。

// Logs the address for the 'Home Address' field for contact 'John Doe'.
// Can be used similarly for other fields that contain addresses.
const contacts = ContactsApp.getContactsByName('John Doe');
const homeAddress = contacts[0].getAddresses(ContactsApp.Field.HOME_ADDRESS);
Logger.log(homeAddress[0].getAddress());

回攻員

String：以字串表示的地址

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

---

getLabel()

取得這個欄位的標籤。這可能是欄位、ExtendedField 或字串。

// Logs the label for all the address fields associated with contact
// 'John Doe'. This method can be similarly called for any field that has
// a label.
const contacts = ContactsApp.getContactsByName('John Doe');
const addressFields = contacts[0].getAddresses();
for (let i = 0; i < addressFields.length; i++) {
  Logger.log(addressFields[i].getLabel());
}

回攻員

Object：這個欄位的標籤

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

---

isPrimary()

取得是否為主要欄位值。

// Logs whether or not the first address field associated with contact
// 'John Doe' is labeled as primary. This method can be similarly called
// for any field.
const contacts = ContactsApp.getContactsByName('John Doe');
const addressFields = contacts[0].getAddresses();
Logger.log(addressFields[0].isPrimary());

回攻員

Boolean：是否為主要

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

---

setAddress(address)

設定這個欄位的地址。

// Sets the address for the 'Home Address' field for contact 'John Doe'.
// Can be used similarly for other fields that contain addresses.
const contacts = ContactsApp.getContactsByName('John Doe');
const homeAddress = contacts[0].getAddresses(ContactsApp.Field.HOME_ADDRESS);
homeAddress[0].setAddress('123 Main St, Raleigh, NC, 27601');

參數

名稱	類型	說明
address	String	新地址

回攻員

IMField：這個欄位可用於鏈結

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

---

setAsPrimary()

將這個欄位設為 primary。

// Sets the first address field associated with contact 'John Doe'
// as primary. This method can be similarly called for any field.
const contacts = ContactsApp.getContactsByName('John Doe');
const addressFields = contacts[0].getAddresses();
addressFields[0].setAsPrimary();

回攻員

IMField：用於鏈結的 FieldValue

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

---

setLabel(field)

設定這個欄位的標籤。

// Sets the label to 'Work' for the first address field associated
// with contact 'John Doe'. This method can be similarly called for any
// field that has a label.
const contacts = ContactsApp.getContactsByName('John Doe');
const addressFields = contacts[0].getAddresses();
addressFields[0].setLabel(ContactsApp.Field.WORK_ADDRESS);

參數

名稱	類型	說明
field	Field	新的標準標籤

回攻員

IMField：用於鏈結的 FieldValue

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

---

setLabel(label)

設定這個欄位的標籤。

// Sets the label to 'Apartment' for the first address field associated
// with contact 'John Doe'. This method can be similarly called for any
// field that has a label.
const contacts = ContactsApp.getContactsByName('John Doe');
const addressFields = contacts[0].getAddresses();
addressFields[0].setLabel('Apartment');

參數

名稱	類型	說明
label	String	這個欄位的新標籤

回攻員

IMField：這個欄位可用於鏈結

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

已淘汰的方法

deleteIMField()

已淘汰。這個函式已淘汰，不建議在新指令碼中使用。

刪除這個即時訊息欄位。

// Retrieves and deletes the AIM instant messaging field for contact 'John
// Doe'
const contacts = ContactsApp.getContactsByName('John Doe');
const imFields = contacts[0].getIMs(ContactsApp.Field.AIM);
imFields[0].deleteIMField();

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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