Class IMField

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

  • IMField represents an instant messaging field within a Contact.

  • Methods likegetAddress(),getLabel(), andisPrimary() allow retrieval of information about the IM field.

  • Methods likesetAddress(),setAsPrimary(), andsetLabel() allow modification of the IM field.

  • ThedeleteIMField() method is also deprecated and used to delete an instant messaging field.

IMField

Deprecated. Instead, use thePeople API advanced service

An instant messaging field in a Contact.

Methods

MethodReturn typeBrief description
getAddress()StringGet the address for this field.
getLabel()ObjectGets the label for this field.
isPrimary()BooleanGets whether this is the primary field value.
setAddress(address)IMFieldSets the address of this field.
setAsPrimary()IMFieldSets this field to primary.
setLabel(field)IMFieldSets the label of this field.
setLabel(label)IMFieldSets the label of this field.

Deprecated methods

MethodReturn typeBrief description
deleteIMField()voidDeletes this instant messaging field.

Detailed documentation

getAddress()

Get the address for this field.

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

Return

String — the address as a string

Authorization

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

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

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

setAddress(address)

Sets the address of this field.

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

Parameters

NameTypeDescription
addressStringthe new address

Return

IMField — 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

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

IMField — 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

IMField — 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

IMField — 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

deleteIMField()

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

Deletes this instant messaging field.

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

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.