Class PhoneField
Stay organized with collections
Save and categorize content based on your preferences.
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.
var contacts = ContactsApp.getContactsByName('John Doe');
var addressFields = contacts[0].getAddresses();
for (var i = 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 following
scopes
:
-
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.
var contacts = ContactsApp.getContactsByName('John Doe');
var addressFields = 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 following
scopes
:
-
https://www.google.com/m8/feeds
setAsPrimary()
Sets this field to primary.
// Sets the the first address field associated with contact 'John Doe'
// as primary. This method can be similarly called for any field.
var contacts = ContactsApp.getContactsByName('John Doe');
var addressFields = 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 following
scopes
:
-
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.
var contacts = ContactsApp.getContactsByName('John Doe');
var addressFields = contacts[0].getAddresses();
addressFields[0].setLabel(ContactsApp.Field.WORK_ADDRESS);
Parameters
Name
| Type
| Description
|
field
| Field
| the new standard label
|
Return
PhoneField
— this FieldValue for chaining
Authorization
Scripts that use this method require authorization with one or more of the following
scopes
:
-
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.
var contacts = ContactsApp.getContactsByName('John Doe');
var addressFields = contacts[0].getAddresses();
addressFields[0].setLabel('Apartment');
Parameters
Name
| Type
| Description
|
label
| String
| the 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 following
scopes
:
-
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'
var contacts = ContactsApp.getContactsByName('John Doe');
var phoneFields = contacts[0].getPhones(ContactsApp.Field.WORK_PHONE);
phoneFields[0].deletePhoneField();
Authorization
Scripts that use this method require authorization with one or more of the following
scopes
:
-
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'
var contacts = ContactsApp.getContactsByName('John Doe');
var phoneFields = 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 following
scopes
:
-
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'
var contacts = ContactsApp.getContactsByName('John Doe');
var phoneFields = contacts[0].getPhones(ContactsApp.Field.WORK_PHONE);
phoneFields[0].setPhoneNumber('212-555-1234');
Parameters
Name
| Type
| Description
|
number
| String
| the new number
|
Return
PhoneField
— this field, useful for chaining
Authorization
Scripts that use this method require authorization with one or more of the following
scopes
:
-
https://www.google.com/m8/feeds
Except as otherwise noted, the content of this page is licensed under the
Creative Commons Attribution 4.0 License
, and code samples are licensed under the
Apache 2.0 License
. For details, see the
Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2022-12-16 UTC.
[{
"type": "thumb-down",
"id": "missingTheInformationINeed",
"label":"Missing the information I need"
},{
"type": "thumb-down",
"id": "tooComplicatedTooManySteps",
"label":"Too complicated / too many steps"
},{
"type": "thumb-down",
"id": "outOfDate",
"label":"Out of date"
},{
"type": "thumb-down",
"id": "samplesCodeIssue",
"label":"Samples / code issue"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]