Class PhoneField

电话字段

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

联系人中的电话号码字段。

方法

方法	返回类型	简介
getLabel()	Object	获取此字段的标签。
isPrimary()	Boolean	获取这是主字段值的确切信息。
setAsPrimary()	PhoneField	将此字段设置为主要字段。
setLabel(field)	PhoneField	设置此字段的标签。
setLabel(label)	PhoneField	设置此字段的标签。

已弃用的方法

方法	返回类型	简介
deletePhoneField()	void	删除此电话号码字段。
getPhoneNumber()	String	获取此字段的电话号码。
setPhoneNumber(number)	PhoneField	为此字段设置电话号码。

详细文档

getLabel()

获取此字段的标签。这可以是 Field、ExtendedField 或 String。

// 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

---

setAsPrimary()

将此字段设置为主要字段。

// 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();

返回

PhoneField - 用于链式调用的 this 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	新标准标签

返回

PhoneField - 用于链式调用的 this 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	此字段的新标签

返回

PhoneField - this 字段，适用于链式调用

授权

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

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

已弃用的方法

deletePhoneField()

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

删除此电话号码字段。

// Retrieves and deletes the work phone number field for contact 'John
// Doe'
const contacts = ContactsApp.getContactsByName('John Doe');
const phoneFields = contacts[0].getPhones(ContactsApp.Field.WORK_PHONE);
phoneFields[0].deletePhoneField();

授权

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

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

---

getPhoneNumber()

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

获取此字段的电话号码。

// Logs the work phone number for contact 'John Doe'
const contacts = ContactsApp.getContactsByName('John Doe');
const phoneFields = contacts[0].getPhones(ContactsApp.Field.WORK_PHONE);
Logger.log(phoneFields[0].getPhoneNumber());

返回

String - 数字（作为字符串）

授权

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

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

---

setPhoneNumber(number)

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

为此字段设置电话号码。

// Sets the work phone number for contact 'John Doe'
const contacts = ContactsApp.getContactsByName('John Doe');
const phoneFields = contacts[0].getPhones(ContactsApp.Field.WORK_PHONE);
phoneFields[0].setPhoneNumber('212-555-1234');

参数

名称	类型	说明
number	String	新号码

返回

PhoneField - this 字段，适用于链式调用

授权

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

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