Class CustomField
Page Summary
The
CustomFieldclass is deprecated and users should use the People API advanced service instead.Custom fields represent a custom data entry for a contact.
While some methods like
getLabel()andsetLabel(label)are still available, many methods for managing custom fields are deprecated.Deprecated methods for
CustomFieldincludedeleteCustomField(),getValue(),setLabel(field), andsetValue(value).
Methods
| Method | Return type | Brief description |
|---|---|---|
get | Object | Gets the label for this field. |
set | | Sets the label of this field. |
Deprecated methods
| Method | Return type | Brief description |
|---|---|---|
| void | Deletes this field. |
| Object | Gets the value of the field. |
| | Sets the label of this field. |
| | Sets the value of 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
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
| Name | Type | Description |
|---|---|---|
label | String | the new label for this field |
Return
Custom
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.google.com/m8/feeds
Deprecated methods
deleteCustomField()
deleteCustomField() Deprecated. This function is deprecated and should not be used in new scripts.
Deletes this field.
constcontacts=ContactsApp.getContactsByName('John Doe');constfields=contacts[0].getCustomFields();for(leti=0;i <fields.length;i++){if(fields[i].getLabel()==='foo'){fields[i].deleteCustomField();}}
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.google.com/m8/feeds
getValue()
getValue() Deprecated. This function is deprecated and should not be used in new scripts.
Gets the value of the field.
// Logs the value of all the custom fields for contact 'John Doe'constcontacts=ContactsApp.getContactsByName('John Doe');constfields=contacts[0].getCustomFields();for(constiinfields){Logger.log(fields[i].getValue());}
Return
Object — the value stored in the field
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.google.com/m8/feeds
setLabel(field)
setLabel(field) Deprecated. This function is deprecated and should not be used in new scripts.
Sets the label of this field.
// Sets the first custom field associated with contact 'John Doe' to use 'Mail// application' as a label, with 'Gmail' as the value.constcontacts=ContactsApp.getContactsByName('John Doe');constfield=contacts[0].getCustomFields()[0];field.setLabel('Mail application');field.setValue('Gmail');
Parameters
| Name | Type | Description |
|---|---|---|
field | | the new standard label |
Return
Custom
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.google.com/m8/feeds
setValue(value)
setValue(value) Deprecated. This function is deprecated and should not be used in new scripts.
Sets the value of this field.
// Sets the first custom field associated with contact 'John Doe' to use 'Mail// application' as a label, with 'Gmail' as the value.constcontacts=ContactsApp.getContactsByName('John Doe');constfield=contacts[0].getCustomFields()[0];field.setLabel('Mail application');field.setValue('Gmail');
Parameters
| Name | Type | Description |
|---|---|---|
value | Object | the new value |
Return
Custom
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.