Contacts Service

Deprecated. Instead, use the People API advanced service

This service allows scripts to access and modify Google Contacts, both for individual contacts and for groups.

Classes

Name	Brief description
`AddressField`	Address field in a contact.
`CompanyField`	Company field in a Contact.
`Contact`	A Contact contains the name, address, and various contact details of a contact.
`ContactGroup`	A ContactGroup is is a group of contacts.
`ContactsApp`	This class allows users to access their own Google Contacts and create, remove, and update contacts listed therein.
`CustomField`	A custom field in a Contact.
`DateField`	A date field in a Contact.
`EmailField`	An email field in a Contact.
`ExtendedField`	An enum for extended contacts fields.
`Field`	An enum for contacts fields.
`Gender`	An enum for contact gender.
`IMField`	An instant messaging field in a Contact.
`PhoneField`	A phone number field in a Contact.
`Priority`	An enum for contact priority.
`Sensitivity`	An enum for contact sensitivity.
`UrlField`	A URL field in a Contact.

`AddressField`

Methods

Method	Return type	Brief description
`getAddress()`	`String`	Get the address for this field.
`getLabel()`	`Object`	Gets the label for this field.
`isPrimary()`	`Boolean`	Gets whether this is the primary field value.
`setAddress(address)`	`AddressField`	Sets the address of this field.
`setAsPrimary()`	`AddressField`	Sets this field to primary.
`setLabel(field)`	`AddressField`	Sets the label of this field.
`setLabel(label)`	`AddressField`	Sets the label of this field.

`CompanyField`

`Contact`

`ContactGroup`

`ContactsApp`

`CustomField`

Methods

Method	Return type	Brief description
`getLabel()`	`Object`	Gets the label for this field.
`setLabel(label)`	`CustomField`	Sets the label of this field.

`DateField`

Methods

Method	Return type	Brief description
`getLabel()`	`Object`	Gets the label for this field.
`setLabel(label)`	`DateField`	Sets the label of this field.

`EmailField`

Methods

Method	Return type	Brief description
`getAddress()`	`String`	Get the address for this field.
`getLabel()`	`Object`	Gets the label for this field.
`isPrimary()`	`Boolean`	Gets whether this is the primary field value.
`setAddress(address)`	`EmailField`	Sets the address of this field.
`setAsPrimary()`	`EmailField`	Sets this field to primary.
`setLabel(field)`	`EmailField`	Sets the label of this field.
`setLabel(label)`	`EmailField`	Sets the label of this field.

`ExtendedField`

`Field`

`Gender`

`IMField`

Methods

Method	Return type	Brief description
`getAddress()`	`String`	Get the address for this field.
`getLabel()`	`Object`	Gets the label for this field.
`isPrimary()`	`Boolean`	Gets whether this is the primary field value.
`setAddress(address)`	`IMField`	Sets the address of this field.
`setAsPrimary()`	`IMField`	Sets this field to primary.
`setLabel(field)`	`IMField`	Sets the label of this field.
`setLabel(label)`	`IMField`	Sets the label of this field.

`PhoneField`

Methods

Method	Return type	Brief description
`getLabel()`	`Object`	Gets the label for this field.
`isPrimary()`	`Boolean`	Gets whether this is the primary field value.
`setAsPrimary()`	`PhoneField`	Sets this field to primary.
`setLabel(field)`	`PhoneField`	Sets the label of this field.
`setLabel(label)`	`PhoneField`	Sets the label of this field.

`Priority`

`Sensitivity`

`UrlField`

Methods

Method	Return type	Brief description
`getAddress()`	`String`	Get the address for this field.
`getLabel()`	`Object`	Gets the label for this field.
`isPrimary()`	`Boolean`	Gets whether this is the primary field value.
`setAddress(address)`	`UrlField`	Sets the address of this field.
`setAsPrimary()`	`UrlField`	Sets this field to primary.
`setLabel(field)`	`UrlField`	Sets the label of this field.
`setLabel(label)`	`UrlField`	Sets the label of this field.

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 2024-10-31 UTC.

Blog
Read the Google Workspace Developers blog
Stack Overflow
Ask a question under the google-apps-script tag
Code Samples
Explore our code samples or copy them to build your own
Videos
Watch Apps Script tutorials