Deprecated. Instead, use the People API advanced service
A Contact contains the name, address, and various contact details of a contact.
Deprecated methods
Method | Return type | Brief description |
---|---|---|
|
| Adds an address to the contact with either a standard or custom label. |
|
| Adds a company to the contact. |
|
| Adds a custom field to the contact with either an extended or custom label. |
|
| Adds a date to the contact with either an standard or custom label. |
|
| Add an email address with a standard label (home, work, etc.) or a custom label |
|
| Adds an IM address to the contact with either a standard or custom label. |
|
| Adds a phone number to the contact with either a standard or custom label. |
|
| Adds this contact to the given contact group. |
|
| Adds a URL to the contact with either a standard or custom label. |
| void | Deletes this contact. |
|
| Gets all the addresses for this contact. |
|
| Gets all the addresses for this contact matching a particular field. |
|
| Gets all the companies for this contact. |
|
| Gets all the contact groups that contain this contact. |
|
| Gets all the custom fields for this contact. |
|
| Gets all the custom fields for this contact matching a particular field. |
|
| Gets all the dates for this contact. |
|
| Gets all the dates for this contact matching a particular field. |
| String[] | Gets a list of the email addresses available for this Contact. |
|
| Gets the email addresses of this contact. |
|
| Gets the email addresses for this contact matching a particular field. |
| String | Gets the family name (last name) of the contact as a string. |
| String | Gets the full name (given name and last name) of the contact as a string. |
| String | Gets the given name (first name) of the contact as a string. |
| String | Gets the home address of this Contact, or empty string if none exists. |
| String | Gets the home fax number of this Contact or empty string if none exists. |
| String | Gets the home phone number of this Contact or empty string if none exists. |
|
| Gets all the IM addresses for this contact. |
|
| Gets all the IM addresses for this contact matching a particular field. |
| String | Returns the unique id of this contact. |
| String | Gets the contact's initials. |
| Date | Gets the date this contact was last updated. |
| String | Gets the maiden name of the contact as a string. |
| String | Gets the middle name of the contact as a string. |
| String | Gets the mobile phone number of this Contact or empty string if none exists. |
| String | Gets the nickname of the contact as a string. |
| String | Gets the notes associated with this contact, or an empty string if there are no notes. |
| String | Gets the pager phone number of this Contact or empty string if none exists. |
|
| Gets all the phone numbers for this contact. |
|
| Gets all the phone numbers for this contact matching a particular field. |
| String | Gets the prefix to the contact's name. |
| String | Gets the primary email address of the contact as a string. |
| String | Gets the short name of the contact as a string. |
| String | Gets the suffix to the contact's name. |
|
| Gets all the URLs for this contact. |
|
| Gets all the URLs for this contact matching a particular field. |
| String | Gets the user defined value associated with the given key. |
| Object | Gets all the user defined fields for this Contact and returns them as the properties of a JavaScript Object. |
| String | Gets the work address of this Contact, or empty string if none exists. |
| String | Gets the work fax number of this Contact or empty string if none exists. |
| String | Gets the work phone number of this Contact or empty string if none exists. |
|
| Removes this contact from the given contact group. |
|
| Sets the family name (last name) of the contact. |
|
| Sets the full name (given name and last name) of the contact. |
|
| Sets the given name (first name) of the contact. |
| void | Sets the home address of this Contact. |
| void | Sets the home fax number of this Contact. |
| void | Sets the home phone number of this Contact. |
|
| Sets the contact's initials. |
|
| Sets the maiden name of the contact. |
|
| Sets the middle name of the contact. |
| void | Sets the mobile phone number of this Contact. |
|
| Sets the nickname of the contact. |
|
| Sets the notes associated with this contact. |
| void | Sets the pager number of this Contact. |
|
| Sets the prefix to the contact's name. |
| void | Sets the primary email address of this Contact. |
|
| Sets the short name of the contact. |
|
| Sets the suffix to the contact's name. |
| void | Sets a single user defined field for this Contact, to be stored with a given key. |
| void | Sets the user defined fields for this Contact with the properties of the given Object. |
| void | Sets the work address of this Contact. |
| void | Sets the work fax number of this Contact. |
| void | Sets the work phone number of this Contact. |
Deprecated methods
addAddress(label, address)
addAddress(label, address)
Deprecated. This function is deprecated and should not be used in new scripts.
Adds an address to the contact with either a standard or custom label.
The label can be either from ContactsApp.Field or a custom label string.
// The code below retrieves a contact named "John Doe" and adds the address // "123 Main St, Some City, NY 10011" with the the ContactsApp.Field.WORK_ADDRESS label. var contacts = ContactsApp.getContactsByName('John Doe'); var address = contacts[0].addAddress(ContactsApp.Field.WORK_ADDRESS, '123 Main St, Some City, NY 10011');
Parameters
Name | Type | Description |
---|---|---|
label | Object | the label of the new address, either from ContactsApp.Field or a custom string |
address | String | the new address |
Return
— the newly created fieldAddressField
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
See also
addCompany(company, title)
addCompany(company, title)
Deprecated. This function is deprecated and should not be used in new scripts.
Adds a company to the contact.
// The code below retrieves a contact named "John Doe" and adds the company "Google" and the // job title "Product Manager". var contacts = ContactsApp.getContactsByName('John Doe'); var url = contacts[0].addCompany('Google', 'Product Manager');
Parameters
Name | Type | Description |
---|---|---|
company | String | the name of the company to add to this contact |
title | String | the job title associated with this contact for this company |
Return
— the newly created fieldCompanyField
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
See also
addCustomField(label, content)
addCustomField(label, content)
Deprecated. This function is deprecated and should not be used in new scripts.
Adds a custom field to the contact with either an extended or custom label.
The label can be either from ContactsApp.ExtendedField or a custom label string.
// The code below retrieves a contact named "John Doe" and adds the custom field // ContactsApp.ExtendedField.HOBBY with the value "hiking". // Note that ContactsApp.ExtendedField.HOBBY is not the same as a custom field named 'HOBBY'. var contacts = ContactsApp.getContactsByName('John Doe'); contacts[0].addCustomField(ContactsApp.ExtendedField.HOBBY, 'hiking');
Parameters
Name | Type | Description |
---|---|---|
label | Object | the label of the new address, either from ContactsApp.ExtendedField or a custom string |
content | Object | the value to store in the custom field |
Return
— the newly created fieldCustomField
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
See also
addDate(label, month, day, year)
addDate(label, month, day, year)
Deprecated. This function is deprecated and should not be used in new scripts.
Adds a date to the contact with either an standard or custom label.
The label can be either from ContactsApp.Field or a custom label string.
// The code below retrieves a contact named "John Doe" and adds a // ContactsApp.ExtendedField.BIRTHDAY with the value "April 19, 1950". var contacts = ContactsApp.getContactsByName('John Doe'); var birthday = contacts[0].addDate(ContactsApp.Field.BIRTHDAY, ContactsApp.Month.APRIL, 19, 1950);
Parameters
Name | Type | Description |
---|---|---|
label | Object | the label of the new date, either from ContactsApp.Field or a custom string |
month | Month | the month, from ContactApps.Month |
day | Integer | the day |
year | Integer | the year |
Return
— the newly created dateDateField
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
See also
addEmail(label, address)
addEmail(label, address)
Deprecated. This function is deprecated and should not be used in new scripts.
Add an email address with a standard label (home, work, etc.) or a custom label
// The code below retrieves a contact named "John Doe" and adds the email address // "[email protected]" to the ContactsApp.Field.HOME_EMAIL label. var contacts = ContactsApp.getContactsByName('John Doe'); var emailField = contacts[0].addEmail(ContactsApp.Field.HOME_EMAIL, '[email protected]');
Parameters
Name | Type | Description |
---|---|---|
label | Object | the label of the new email, either from ContactsApp.Field or a custom string |
address | String | the new email address |
Return
— the newly added fieldEmailField
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
addIM(label, address)
addIM(label, address)
Deprecated. This function is deprecated and should not be used in new scripts.
Adds an IM address to the contact with either a standard or custom label.
The label can be either from ContactsApp.Field or a custom label string.
// The code below retrieves a contact named "John Doe" and adds the IM address "ChatWithJohn" // with the the ContactsApp.Field.AIM label. var contacts = ContactsApp.getContactsByName('John Doe'); var email = contacts[0].addIM(ContactsApp.Field.AIM, 'ChatWithJohn');
Parameters
Name | Type | Description |
---|---|---|
label | Object | the label of the new IM address, either from ContactsApp.Field or a custom string |
address | String | the new IM address |
Return
— the newly created fieldIMField
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
See also
addPhone(label, number)
addPhone(label, number)
Deprecated. This function is deprecated and should not be used in new scripts.
Adds a phone number to the contact with either a standard or custom label.
The label can be either from ContactsApp.Field or a custom label string.
// The code below retrieves a contact named "John Doe" and adds the phone number // "212-555-1234" with the the ContactsApp.Field.WORK_PHONE label. var contacts = ContactsApp.getContactsByName('John Doe'); var phone = contacts[0].addPhone(ContactsApp.Field.WORK_PHONE, '212-555-1234');
Parameters
Name | Type | Description |
---|---|---|
label | Object | the label of the new phone number, either from ContactsApp.Field or a custom string |
number | String | the new phone number |
Return
— the newly created fieldPhoneField
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
See also
addToGroup(group)
addToGroup(group)
Deprecated. This function is deprecated and should not be used in new scripts.
Adds this contact to the given contact group.
// The code below creates a new contact and then adds it to the contact group named // "Work Friends" var contact = ContactsApp.createContact('John', 'Doe', '[email protected]'); var group = ContactsApp.getContactGroup('Work Friends'); contact = contact.addToGroup(group);
Parameters
Name | Type | Description |
---|---|---|
group |
| the contact group to add this contact to |
Return
— this contactContact
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
See also
addUrl(label, url)
addUrl(label, url)
Deprecated. This function is deprecated and should not be used in new scripts.
Adds a URL to the contact with either a standard or custom label.
The label can be either from ContactsApp.Field or a custom label string.
// The code below retrieves a contact named "John Doe" and adds the URL // "http://www.example.com" with the the ContactsApp.Field.WORK_WEBSITE label. var contacts = ContactsApp.getContactsByName('John Doe'); var url = contacts[0].addUrl(ContactsApp.Field.WORK_WEBSITE, 'http://www.example.com');
Parameters
Name | Type | Description |
---|---|---|
label | Object | the label of the new address, either from ContactsApp.Field or a custom string |
url | String | the new URL |
Return
— the newly created fieldUrlField
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
See also
deleteContact()
deleteContact()
Deprecated. This function is deprecated and should not be used in new scripts.
Deletes this contact.
var contacts = ContactsApp.getContactsByName('John Doe'); for (var i in contacts) { contacts[i].deleteContact(); }
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
getAddresses()
getAddresses()
Deprecated. This function is deprecated and should not be used in new scripts.
Gets all the addresses for this contact.
// The code below logs the addresses of all the contacts whose names contain "John Doe" var contacts = ContactsApp.getContactsByName('John Doe'); for (var i in contacts) { Logger.log(contacts[i].getAddresses()); }
Return
— a list of addressesAddressField[]
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
See also
getAddresses(label)
getAddresses(label)
Deprecated. This function is deprecated and should not be used in new scripts.
Gets all the addresses for this contact matching a particular field.
The label can be either from ContactsApp.Field or a custom label string.
// The code below retrieves a contact named "John Doe" and logs the addresses // associated with that contact that are in the ContactsApp.Field.WORK_ADDRESS label. var contacts = ContactsApp.getContactsByName('John Doe'); var addresses = contacts[0].getAddresses(ContactsApp.Field.WORK_ADDRESS); for (var i in addresses) { Logger.log(addresses[i].getAddress()); }
Parameters
Name | Type | Description |
---|---|---|
label | Object | the label to match, either from ContactsApp.Field or a custom string |
Return
— a list of addressesAddressField[]
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
See also
getCompanies()
getCompanies()
Deprecated. This function is deprecated and should not be used in new scripts.
Gets all the companies for this contact.
// The code below logs the company names of all the contacts whose names contain "John Doe" var contacts = ContactsApp.getContactsByName('John Doe'); for (var i in contacts) { var companies = contacts[i].getCompanies(); for (var j in companies) { Logger.log(companies[j].getCompanyName()); } }
Return
— a list of companiesCompanyField[]
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
See also
getContactGroups()
getContactGroups()
Deprecated. This function is deprecated and should not be used in new scripts.
Gets all the contact groups that contain this contact.
// The code below gets a contact named "John Doe" and retrieves all the contact groups that // the contact belongs to var contacts = ContactsApp.getContactsByName('John Doe'); var groups = contacts[0].getContactGroups();
Return
— the groups containing this contactContactGroup[]
See also
getCustomFields()
getCustomFields()
Deprecated. This function is deprecated and should not be used in new scripts.
Gets all the custom fields for this contact.
// The code below retrieves a contact named "John Doe" and logs the custom fields // associated with that contact var contacts = ContactsApp.getContactsByName('John Doe'); var fields = contacts[0].getCustomFields(); for (var i in fields) { Logger.log(fields[i].getValue()); }
Return
— a list of custom fieldsCustomField[]
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
See also
getCustomFields(label)
getCustomFields(label)
Deprecated. This function is deprecated and should not be used in new scripts.
Gets all the custom fields for this contact matching a particular field.
The label can be either a standard label from ContactsApp.ExtendedField or a custom label string.
// The code below retrieves a contact named "John Doe" and logs the custom fields // associated with that contact that are in the ContactsApp.ExtendedField.HOBBY label. var contacts = ContactsApp.getContactsByName('John Doe'); var hobbies = contacts[0].getCustomFields(ContactsApp.ExtendedField.HOBBY); for (var i in hobbies) { Logger.log(hobbies[i].getValue()); }
Parameters
Name | Type | Description |
---|---|---|
label | Object | the label to match, either from ContactsApp.ExtendedField or a custom string |
Return
— a list of custom fieldsCustomField[]
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
See also
getDates()
getDates()
Deprecated. This function is deprecated and should not be used in new scripts.
Gets all the dates for this contact.
// The code below retrieves a contact named "John Doe" and logs the label of the date // associated with that contact var contacts = ContactsApp.getContactsByName('John Doe'); var dates = contacts[0].getDates(); for (var i in dates) { Logger.log(dates[i].getLabel()); }
Return
— a list of datesDateField[]
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
See also
getDates(label)
getDates(label)
Deprecated. This function is deprecated and should not be used in new scripts.
Gets all the dates for this contact matching a particular field.
The label can be either a standard label from ContactsApp.Field or a custom label string.
// The code below retrieves a contact named "John Doe" and logs the day of the month // associated with that contact that are in the ContactsApp.Field.BIRTHDAY label. var contacts = ContactsApp.getContactsByName('John Doe'); var birthdays = contacts[0].getDates(ContactsApp.Field.BIRTHDAY); for (var i in birthdays) { Logger.log(birthdays[i].getDay()); }
Parameters
Name | Type | Description |
---|---|---|
label | Object | the label to match, either from ContactsApp.Field or a custom string |
Return
— a list of datesDateField[]
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
See also
getEmailAddresses()
getEmailAddresses()
Deprecated. This function is deprecated and should not be used in new scripts.
Gets a list of the email addresses available for this Contact.
Return
String[]
— a list of email addresses available for this Contact
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
getEmails()
getEmails()
Deprecated. This function is deprecated and should not be used in new scripts.
Gets the email addresses of this contact.
// The code below retrieves a contact named "John Doe" and logs the email addresses // associated with that contact var contacts = ContactsApp.getContactsByName('John Doe'); var emails = contacts[0].getEmails(); for (var i in emails) { Logger.log(emails[i].getAddress()); }
Return
— the list of email addresses for the the contactEmailField[]
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
See also
getEmails(label)
getEmails(label)
Deprecated. This function is deprecated and should not be used in new scripts.
Gets the email addresses for this contact matching a particular field.
The label can be either a standard label from ContactsApp.Field or a custom label string.
// The code below retrieves a contact named "John Doe" and logs the email addresses // associated with that contact that are in the ContactsApp.Field.HOME_EMAIL label. var contacts = ContactsApp.getContactsByName('John Doe'); var emails = contacts[0].getEmails(ContactsApp.Field.HOME_EMAIL); for (var i in emails) { Logger.log(emails[i].getAddress()); }
Parameters
Name | Type | Description |
---|---|---|
label | Object | the label to match, either from ContactsApp.Field or a custom string |
Return
— the list of email addresses for the the contactEmailField[]
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
See also
getFamilyName()
getFamilyName()
Deprecated. This function is deprecated and should not be used in new scripts.
Gets the family name (last name) of the contact as a string.
// The code below logs the family name of all the contacts whose names contain "John" var contacts = ContactsApp.getContactsByName('John'); for (var i in contacts) { Logger.log(contacts[i].getFamilyName()); }
Return
String
— the family name of the contact
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
See also
getFullName()
getFullName()
Deprecated. This function is deprecated and should not be used in new scripts.
Gets the full name (given name and last name) of the contact as a string.
// The code below logs the full name of all the contacts whose names contain "John" var contacts = ContactsApp.getContactsByName('John'); for (var i in contacts) { Logger.log(contacts[i].getFullName()); }
Return
String
— the full name of the contact
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
See also
getGivenName()
getGivenName()
Deprecated. This function is deprecated and should not be used in new scripts.
Gets the given name (first name) of the contact as a string.
// The code below logs the given name of all the contacts whose names contain "Smith" var contacts = ContactsApp.getContactsByName('Smith'); for (var i in contacts) { Logger.log(contacts[i].getGivenName()); }
Return
String
— the given name of the contact
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
See also
getHomeAddress()
getHomeAddress()
Deprecated. This function is deprecated and should not be used in new scripts.
Gets the home address of this Contact, or empty string if none exists.
Return
String
— the home address of this Contact, or empty string if none exists
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
getHomeFax()
getHomeFax()
Deprecated. This function is deprecated and should not be used in new scripts.
Gets the home fax number of this Contact or empty string if none exists.
Return
String
— the home fax number of this Contact or empty string if none exists
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
getHomePhone()
getHomePhone()
Deprecated. This function is deprecated and should not be used in new scripts.
Gets the home phone number of this Contact or empty string if none exists.
Return
String
— the home phone number of this Contact or empty string if none exists
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
getIMs()
getIMs()
Deprecated. This function is deprecated and should not be used in new scripts.
Gets all the IM addresses for this contact.
// The code below logs the IM addresses of all the contacts whose names contain "John Doe" var contacts = ContactsApp.getContactsByName('John Doe'); for (var i in contacts) { Logger.log(contacts[i].getIMs()); }
Return
— a list of IM addressesIMField[]
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
See also
getIMs(label)
getIMs(label)
Deprecated. This function is deprecated and should not be used in new scripts.
Gets all the IM addresses for this contact matching a particular field.
The label can be either from ContactsApp.Field or a custom label string.
// The code below retrieves a contact named "John Doe" and logs the IM addresses // associated with that contact that are in the ContactsApp.Field.GOOGLE_TALK label. var contacts = ContactsApp.getContactsByName('John Doe'); var imAddresses = contacts[0].getIMs(ContactsApp.Field.GOOGLE_TALK); for (var i in imAddresses) { Logger.log(imAddresses[i].getAddress()); }
Parameters
Name | Type | Description |
---|---|---|
label | Object | the label to match, either from ContactsApp.Field or a custom string |
Return
— a list of IM addressesIMField[]
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
See also
getId()
getId()
Deprecated. This function is deprecated and should not be used in new scripts.
Returns the unique id of this contact.
var contact = ContactsApp.createContact('John', 'Doe', '[email protected]'); var id = contact.getId();
Return
String
— the id of this contact
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
getInitials()
getInitials()
Deprecated. This function is deprecated and should not be used in new scripts.
Gets the contact's initials.
// The code below logs the initials of all the contacts whose names contain "John Doe" var contacts = ContactsApp.getContactsByName('John Doe'); for (var i in contacts) { Logger.log(contacts[i].getInitials()); }
Return
String
— the initials of the contact
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
See also
getLastUpdated()
getLastUpdated()
Deprecated. This function is deprecated and should not be used in new scripts.
Gets the date this contact was last updated.
// The code below logs the last updated date of all the contacts whose names contain // "John Doe" var contacts = ContactsApp.getContactsByName('John Doe'); for (var i in contacts) { Logger.log(contacts[i].getLastUpdated()); }
Return
Date
— the date this contact was last updated
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
getMaidenName()
getMaidenName()
Deprecated. This function is deprecated and should not be used in new scripts.
Gets the maiden name of the contact as a string.
// The code below logs the maiden name of all the contacts whose names contain "Jane" var contacts = ContactsApp.getContactsByName('Jane'); for (var i in contacts) { Logger.log(contacts[i].getMaidenName()); }
Return
String
— the maiden name of the contact
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
See also
getMiddleName()
getMiddleName()
Deprecated. This function is deprecated and should not be used in new scripts.
Gets the middle name of the contact as a string.
// The code below logs the middle name of all the contacts whose names contain "Smith" var contacts = ContactsApp.getContactsByName('Smith'); for (var i in contacts) { Logger.log(contacts[i].getMiddleName()); }
Return
String
— the middle name of the contact
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
See also
getMobilePhone()
getMobilePhone()
Deprecated. This function is deprecated and should not be used in new scripts.
Gets the mobile phone number of this Contact or empty string if none exists.
Return
String
— the mobile phone number of this Contact or empty string if none exists
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
getNickname()
getNickname()
Deprecated. This function is deprecated and should not be used in new scripts.
Gets the nickname of the contact as a string.
// The code below logs the nickname of all the contacts whose names contain "John Doe" var contacts = ContactsApp.getContactsByName('John Doe'); for (var i in contacts) { Logger.log(contacts[i].getNickname()); }
Return
String
— the nickname of the contact
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
See also
getNotes()
getNotes()
Deprecated. This function is deprecated and should not be used in new scripts.
Gets the notes associated with this contact, or an empty string if there are no notes.
// The code below logs the notes of all the contacts whose names contain "John Doe" var contacts = ContactsApp.getContactsByName('John Doe'); for (var i in contacts) { Logger.log(contacts[i].getNotes()); }
Return
String
— the notes associated with this contact
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
See also
getPager()
getPager()
Deprecated. This function is deprecated and should not be used in new scripts.
Gets the pager phone number of this Contact or empty string if none exists.
Return
String
— the pager phone number of this Contact or empty string if none exists
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
getPhones()
getPhones()
Deprecated. This function is deprecated and should not be used in new scripts.
Gets all the phone numbers for this contact.
// The code below logs the phone numbers of all the contacts whose names contain "John Doe" var contacts = ContactsApp.getContactsByName('John Doe'); for (var i in contacts) { Logger.log(contacts[i].getPhones()); }
Return
— a list of phone numbersPhoneField[]
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
See also
getPhones(label)
getPhones(label)
Deprecated. This function is deprecated and should not be used in new scripts.
Gets all the phone numbers for this contact matching a particular field.
The label can be either from ContactsApp.Field or a custom label string.
// The code below retrieves a contact named "John Doe" and logs the phone numbers // associated with that contact that are in the ContactsApp.Field.WORK_PHONE label. var contacts = ContactsApp.getContactsByName('John Doe'); var phones = contacts[0].getPhones(ContactsApp.Field.WORK_PHONE); for (var i in phones) { Logger.log(phones[i].getPhoneNumber()); }
Parameters
Name | Type | Description |
---|---|---|
label | Object | the label to match, either from ContactsApp.Field or a custom string |
Return
— a list of phone numbersPhoneField[]
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
See also
getPrefix()
getPrefix()
Deprecated. This function is deprecated and should not be used in new scripts.
Gets the prefix to the contact's name.
// The code below logs the prefix of all the contacts whose names contain "John Doe" var contacts = ContactsApp.getContactsByName('John Doe'); for (var i in contacts) { Logger.log(contacts[i].getPrefix()); }
Return
String
— the prefix of the contact's name
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
See also
getPrimaryEmail()
getPrimaryEmail()
Deprecated. This function is deprecated and should not be used in new scripts.
Gets the primary email address of the contact as a string.
// The code below logs the primary email address of all the contacts whose names contain // "John Doe" var contacts = ContactsApp.getContactsByName('John Doe'); for (var i in contacts) { Logger.log(contacts[i].getPrimaryEmail()); }
Return
String
— the primary email address of the contact
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
getShortName()
getShortName()
Deprecated. This function is deprecated and should not be used in new scripts.
Gets the short name of the contact as a string.
// The code below logs the short name of all the contacts whose names contain "Johnathan" var contacts = ContactsApp.getContactsByName('Johnathan'); for (var i in contacts) { Logger.log(contacts[i].getShortName()); }
Return
String
— the short name of the contact
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
See also
getSuffix()
getSuffix()
Deprecated. This function is deprecated and should not be used in new scripts.
Gets the suffix to the contact's name.
// The code below logs the suffix of all the contacts whose names contain "John Doe" var contacts = ContactsApp.getContactsByName('John Doe'); for (var i in contacts) { Logger.log(contacts[i].getSuffix()); }
Return
String
— the suffix of the contact's name
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
See also
getUrls()
getUrls()
Deprecated. This function is deprecated and should not be used in new scripts.
Gets all the URLs for this contact.
// The code below logs the URLs of all the contacts whose names contain "John Doe" var contacts = ContactsApp.getContactsByName('John Doe'); for (var i in contacts) { Logger.log(contacts[i].getUrls()); }
Return
— a list of URLsUrlField[]
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
See also
getUrls(label)
getUrls(label)
Deprecated. This function is deprecated and should not be used in new scripts.
Gets all the URLs for this contact matching a particular field.
The label can be either from ContactsApp.Field or a custom label string.
// The code below retrieves a contact named "John Doe" and logs the URLs // associated with that contact that are in the ContactsApp.Field.WORK_WEBSITE label. var contacts = ContactsApp.getContactsByName('John Doe'); var urls = contacts[0].getUrls(ContactsApp.Field.WORK_WEBSITE); for (var i in urls) { Logger.log(urls[i].getAddress()); }
Parameters
Name | Type | Description |
---|---|---|
label | Object | the label to match, either from ContactsApp.Field or a custom string |
Return
— a list of URLsUrlField[]
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
See also
getUserDefinedField(key)
getUserDefinedField(key)
Deprecated. This function is deprecated and should not be used in new scripts.
Gets the user defined value associated with the given key.
Parameters
Name | Type | Description |
---|---|---|
key | String | the key can be any basic type (String, int, etc.) |
Return
String
— the user defined content that has been stored with this key
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
getUserDefinedFields()
getUserDefinedFields()
Deprecated. This function is deprecated and should not be used in new scripts.
Gets all the user defined fields for this Contact and returns them as the properties of a JavaScript Object.
Return
Object
— the user defined fields for this Contact, as properties of a JavaScript Object
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
getWorkAddress()
getWorkAddress()
Deprecated. This function is deprecated and should not be used in new scripts.
Gets the work address of this Contact, or empty string if none exists.
Return
String
— the work address of this Contact, or empty string if none exists
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
getWorkFax()
getWorkFax()
Deprecated. This function is deprecated and should not be used in new scripts.
Gets the work fax number of this Contact or empty string if none exists.
Return
String
— the work fax number of this Contact or empty string if none exists
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
getWorkPhone()
getWorkPhone()
Deprecated. This function is deprecated and should not be used in new scripts.
Gets the work phone number of this Contact or empty string if none exists.
Return
String
— the work phone number of this Contact or empty string if none exists
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
removeFromGroup(group)
removeFromGroup(group)
Deprecated. This function is deprecated and should not be used in new scripts.
Removes this contact from the given contact group.
// The code below gets all the contacts named "John Doe" and then removes each of them from // the "Work Friends" contact group var contacts = ContactsApp.getContactsByName('John Doe'); var group = ContactsApp.getContactGroup('Work Friends'); for (var i in contacts) { contacts[i] = contacts[i].removeFromGroup(group); }
Parameters
Name | Type | Description |
---|---|---|
group |
| the contact group to remove this contact from |
Return
— this contactContact
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
See also
setFamilyName(familyName)
setFamilyName(familyName)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the family name (last name) of the contact.
// The code below changes the family name of all the contacts whose names are "John Doe" // to "Doe-Smith" var contacts = ContactsApp.getContactsByName('John Doe'); for (var i in contacts) { contacts[i].setFamilyName('Doe-Smith'); }
Parameters
Name | Type | Description |
---|---|---|
familyName | String | the new family name of the contact |
Return
— this contactContact
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
See also
setFullName(fullName)
setFullName(fullName)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the full name (given name and last name) of the contact.
// The code below changes the full name of all the contacts whose names are "John Doe" // to "Johnny Doe" var contacts = ContactsApp.getContactsByName('John Doe'); for (var i in contacts) { contacts[i].setFullName('Johnny Doe'); }
Parameters
Name | Type | Description |
---|---|---|
fullName | String | the new full name of the contact |
Return
— this contactContact
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
See also
setGivenName(givenName)
setGivenName(givenName)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the given name (first name) of the contact.
// The code below changes the given name of all the contacts whose names are "John Doe" // to "Johnny" var contacts = ContactsApp.getContactsByName('John Doe'); for (var i in contacts) { contacts[i].setGivenName('Johnny'); }
Parameters
Name | Type | Description |
---|---|---|
givenName | String | the new given name of the contact |
Return
— this contactContact
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
See also
setHomeAddress(addr)
setHomeAddress(addr)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the home address of this Contact.
Parameters
Name | Type | Description |
---|---|---|
addr | String | the home address to set |
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
setHomeFax(phone)
setHomeFax(phone)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the home fax number of this Contact.
Parameters
Name | Type | Description |
---|---|---|
phone | String | the home fax number to set |
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
setHomePhone(phone)
setHomePhone(phone)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the home phone number of this Contact.
Parameters
Name | Type | Description |
---|---|---|
phone | String | the home phone number to set |
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
setInitials(initials)
setInitials(initials)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the contact's initials.
// The code below sets the initials of all the contacts whose names are "Johnathan Doe" // to "JD" var contacts = ContactsApp.getContactsByName('Johnathan Doe'); for (var i in contacts) { contacts[i].setInitials('JD'); }
Parameters
Name | Type | Description |
---|---|---|
initials | String | the new initials of the contact |
Return
— this contactContact
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
See also
setMaidenName(maidenName)
setMaidenName(maidenName)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the maiden name of the contact.
// The code below changes the maiden name of all the contacts whose names are "Jane Doe" // to "Smith" var contacts = ContactsApp.getContactsByName('Jane Doe'); for (var i in contacts) { contacts[i].setMaidenName('Smith'); }
Parameters
Name | Type | Description |
---|---|---|
maidenName | String | the new maiden name of the contact |
Return
— this contactContact
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
See also
setMiddleName(middleName)
setMiddleName(middleName)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the middle name of the contact.
// The code below changes the middle name of all the contacts whose names are "John Doe" // to "Danger" var contacts = ContactsApp.getContactsByName('John Doe'); for (var i in contacts) { contacts[i].setMiddleName('Danger'); }
Parameters
Name | Type | Description |
---|---|---|
middleName | String | the new middle name of the contact |
Return
— this contactContact
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
See also
setMobilePhone(phone)
setMobilePhone(phone)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the mobile phone number of this Contact.
Parameters
Name | Type | Description |
---|---|---|
phone | String | the mobile phone number to set |
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
setNickname(nickname)
setNickname(nickname)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the nickname of the contact.
// The code below changes the nickname of all the contacts whose names are "John Doe" // to "JohnnyD" var contacts = ContactsApp.getContactsByName('John Doe'); for (var i in contacts) { contacts[i].setNickname('JohnnyD'); }
Parameters
Name | Type | Description |
---|---|---|
nickname | String | the new nickname of the contact |
Return
— this contactContact
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
See also
setNotes(notes)
setNotes(notes)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the notes associated with this contact.
// The code below sets the notes of all the contacts whose names are "John Doe" // to "Met him at the hackathon" var contacts = ContactsApp.getContactsByName('John Doe'); for (var i in contacts) { contacts[i].setNotes('Met him at the hackathon'); }
Parameters
Name | Type | Description |
---|---|---|
notes | String | the notes to be stored for this contact |
Return
— this contactContact
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
See also
setPager(phone)
setPager(phone)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the pager number of this Contact.
Parameters
Name | Type | Description |
---|---|---|
phone | String | the pager number to set |
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
setPrefix(prefix)
setPrefix(prefix)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the prefix to the contact's name.
// The code below sets the prefix of all the contacts whose names are "Johnathan Doe" // to "Mr" var contacts = ContactsApp.getContactsByName('Johnathan Doe'); for (var i in contacts) { contacts[i].setPrefix('Mr'); }
Parameters
Name | Type | Description |
---|---|---|
prefix | String | the new prefix of the contact's name |
Return
— this contactContact
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
See also
setPrimaryEmail(primaryEmail)
setPrimaryEmail(primaryEmail)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the primary email address of this Contact.
Parameters
Name | Type | Description |
---|---|---|
primaryEmail | String | the primary email address to set |
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
setShortName(shortName)
setShortName(shortName)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the short name of the contact.
// The code below changes the short name of all the contacts whose names are "Johnathan Doe" // to "John" var contacts = ContactsApp.getContactsByName('Johnathan Doe'); for (var i in contacts) { contacts[i].setShortName('John'); }
Parameters
Name | Type | Description |
---|---|---|
shortName | String | the new short name of the contact |
Return
— this contactContact
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
See also
setSuffix(suffix)
setSuffix(suffix)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the suffix to the contact's name.
// The code below sets the suffix of all the contacts whose names are "Johnathan Doe" // to "Jr" var contacts = ContactsApp.getContactsByName('Johnathan Doe'); for (var i in contacts) { contacts[i].setSuffix('Jr'); }
Parameters
Name | Type | Description |
---|---|---|
suffix | String | the new suffix of the contact's name |
Return
— this contactContact
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
See also
setUserDefinedField(key, value)
setUserDefinedField(key, value)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets a single user defined field for this Contact, to be stored with a given key.
Parameters
Name | Type | Description |
---|---|---|
key | String | the key can be any basic type (String, int, etc.) |
value | String | the value can be any basic type (String, int, etc.) |
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
setUserDefinedFields(o)
setUserDefinedFields(o)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the user defined fields for this Contact with the properties of the given Object.
Parameters
Name | Type | Description |
---|---|---|
o | Object | an Object with one or more properties in the form {key: value} |
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
setWorkAddress(addr)
setWorkAddress(addr)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the work address of this Contact.
Parameters
Name | Type | Description |
---|---|---|
addr | String | the work address to set |
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
setWorkFax(phone)
setWorkFax(phone)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the work fax number of this Contact.
Parameters
Name | Type | Description |
---|---|---|
phone | String | the work fax number to set |
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds
setWorkPhone(phone)
setWorkPhone(phone)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the work phone number of this Contact.
Parameters
Name | Type | Description |
---|---|---|
phone | String | the work phone number to set |
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.google.com/m8/feeds