Contacts Service

AI-generated Key Takeaways

This Contacts service is deprecated; use the People API advanced service instead.
The Contacts service previously allowed scripts to access and modify Google Contacts data, including individual contacts and groups.
The ContactsApp class was the primary interface for creating, removing, and updating contacts within Google Contacts.
Various classes like Contact, ContactGroup, and field-specific classes like AddressField, EmailField were used to represent and manipulate contact data.
Although deprecated, the documentation details the available classes and methods for interacting with Google Contacts through this older 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.

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.

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.

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

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

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.

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.

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.

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.