Class PhoneField

  • PhoneField is deprecated and the People API advanced service should be used instead.

  • A PhoneField represents a phone number field within a Contact.

  • Methods like getLabel(), isPrimary(), setAsPrimary(), and setLabel() are available for managing PhoneField properties.

  • Deprecated methods such as deletePhoneField(), getPhoneNumber(), and setPhoneNumber() should not be used in new scripts.

  • All methods require authorization with thehttps://www.google.com/m8/feeds scope.

PhoneField

Deprecated. Instead, use thePeople API advanced service

A phone number field in a Contact.

Methods

MethodReturn typeBrief description
getLabel()ObjectGets the label for this field.
isPrimary()BooleanGets whether this is the primary field value.
setAsPrimary()PhoneFieldSets this field to primary.
setLabel(field)PhoneFieldSets the label of this field.
setLabel(label)PhoneFieldSets the label of this field.

Deprecated methods

MethodReturn typeBrief description
deletePhoneField()voidDeletes this phone number field.
getPhoneNumber()StringGet the phone number for this field.
setPhoneNumber(number)PhoneFieldSets the phone number for this field.

Detailed documentation

getLabel()

Gets the label for this field. This may be a Field, ExtendedField, or a 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.constcontacts=ContactsApp.getContactsByName('John Doe');constaddressFields=contacts[0].getAddresses();for(leti=0;i <addressFields.length;i++){Logger.log(addressFields[i].getLabel());}

Return

Object — the label for this field

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

isPrimary()

Gets whether this is the primary field value.

// 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.constcontacts=ContactsApp.getContactsByName('John Doe');constaddressFields=contacts[0].getAddresses();Logger.log(addressFields[0].isPrimary());

Return

Boolean — whether this is primary

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

setAsPrimary()

Sets this field to primary.

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

Return

PhoneField — this FieldValue for chaining

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

setLabel(field)

Sets the label of this 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.constcontacts=ContactsApp.getContactsByName('John Doe');constaddressFields=contacts[0].getAddresses();addressFields[0].setLabel(ContactsApp.Field.WORK_ADDRESS);

Parameters

NameTypeDescription
fieldFieldthe new standard label

Return

PhoneField — this FieldValue for chaining

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

setLabel(label)

Sets the label of this field.

// 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.constcontacts=ContactsApp.getContactsByName('John Doe');constaddressFields=contacts[0].getAddresses();addressFields[0].setLabel('Apartment');

Parameters

NameTypeDescription
labelStringthe new label for this field

Return

PhoneField — this field, useful for chaining

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Deprecated methods

deletePhoneField()

Deprecated. This function is deprecated and should not be used in new scripts.

Deletes this phone number field.

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

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

getPhoneNumber()

Deprecated. This function is deprecated and should not be used in new scripts.

Get the phone number for this field.

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

Return

String — the number as a string

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

setPhoneNumber(number)

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the phone number for this field.

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

Parameters

NameTypeDescription
numberStringthe new number

Return

PhoneField — this field, useful for chaining

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-12-11 UTC.