Class ContactsApp

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

Creates a new contact.

// The code below creates a new contact with the name "John Doe" and the email
// address "john.doe@example.com".
constcontact=ContactsApp.createContact(
'John',
'Doe',
'john.doe@example.com',
);

Parameters

Return

(削除) Contact (削除ここまで) — the newly created Contact object

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(contact) (削除ここまで)

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

Creates a contact group with the given name

// The code below creates a new contact group named "Work Friends"
constgroup=ContactsApp.createContactGroup('Work Friends');

Parameters

Return

(削除) ContactGroup (削除ここまで) — the newly created contact group

Authorization

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

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

See also

• (削除) deleteContactGroup(group) (削除ここまで)

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

Deletes the contact.

// The code below retrieves a contact with the email address
// "john.doe@example.com" and then deletes that contact.
constcontact=ContactsApp.getContact('john.doe@example.com');
ContactsApp.deleteContact(contact);

Parameters

Authorization

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

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

See also

• (削除) createContact(givenName, familyName, email) (削除ここまで)

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

Deletes the contact group

// The code below creates deletes the contact group named "Work Friends"
constgroup=ContactsApp.getContactGroup('Work Friends');
ContactsApp.deleteContactGroup(group);

Parameters

Authorization

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

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

See also

• (削除) createContactGroup(name) (削除ここまで)

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

Finds a Contact with the given email address.

Parameters

Return

(削除) Contact (削除ここまで) — the Contact containing that email address

Authorization

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

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

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

Finds a contact group of the given name.

Parameters

Return

(削除) ContactGroup (削除ここまで) — the contact group matching the given name

Authorization

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

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

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

Get all the contacts belonging to this user.

Return

(削除) Contact[] (削除ここまで) — all the contacts for this user

Authorization

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

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

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

Gets a contact by the email address.

If multiple contacts share the same email address, the method favors those contacts who have marked the email address as primary; if none of the contacts had the email address marked as primary or multiple contacts had the email address marked as primary, then it returns the first result in the sorted contacts order.

// The code below retrieves a contact with the email address
// "john.doe@example.com".
constcontact=ContactsApp.getContact('john.doe@example.com');

Parameters

Return

(削除) Contact (削除ここまで) — the contact containing that email address

Authorization

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

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

See also

• (削除) getContacts() (削除ここまで)
• (削除) getContactById(id) (削除ここまで)

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

Gets the contact with this id.

// The code below retrieves the contact with the id
// "http://www.google.com/m8/feeds/contacts/john.doe%40example.com/base/7c86afde08d34ca5"
constid=
'http://www.google.com/m8/feeds/contacts/john.doe%40example.com/base/7c86afde08d34c';
constcontact=ContactsApp.getContactById(id);

Parameters

Return

(削除) Contact (削除ここまで) — the matching contact or null

Authorization

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

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

See also

• (削除) getContact(emailAddress) (削除ここまで)

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

Gets a contact group with the given name, or returns null if no such contact group is found.

// The code below returns the contact group with the name "Work Friends"
constgroup=ContactsApp.getContactGroup('Work Friends');

Parameters

Return

(削除) ContactGroup (削除ここまで) — the matching contact group or null if no matching contact group is found

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() (削除ここまで)

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

Gets a contact group with the given id, or returns null if no such contact group is found.

// The code below returns the contact group with the id
// "http://www.google.com/m8/feeds/groups/john.doe%40example.com/base/54eefbb093fdecb"
constid=
'http://www.google.com/m8/feeds/groups/john.doe%40example.com/base/54eefbb093fdecb';
constgroup=ContactsApp.getContactGroupById(id);

Parameters

Return

(削除) ContactGroup (削除ここまで) — the matching contact group or null if no matching contact group is found

See also

• (削除) getContactGroups() (削除ここまで)

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

Gets the complete list of the user's contact groups.

A user can have a list of Contacts, and potentially a list of Contact Groups also. Each Contact Group can contain Contacts. This method returns a list of all the Contact Groups.

// The retrieves all the contract groups for the user and then logs the group
// name of each contact group.
constgroups=ContactsApp.getContactGroups();
for(leti=0;i < groups.length;i++){
Logger.log(groups[i].getName());
}

Return

(削除) ContactGroup[] (削除ここまで) — an array of the user's contact groups

Authorization

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

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

See also

• (削除) getContactGroup(name) (削除ここまで)

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

Gets all of the user's contacts.

// The code below will retrieve all the user's contacts
constcontacts=ContactsApp.getContacts();

Return

(削除) Contact[] (削除ここまで) — an array of all the user's contacts

Authorization

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

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

See also

• (削除) getContact(emailAddress) (削除ここまで)

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

Get contacts matching an address.

// The code below returns an array of contacts where the contact's address
// contains "San Francisco'.
constcontacts=ContactsApp.getContactsByAddress('San Francisco');

Parameters

Return

(削除) Contact[] (削除ここまで) — an array of matching contacts

Authorization

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

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

See also

• (削除) getContact(emailAddress) (削除ここまで)

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

Get contacts matching an address, limited to a specific field.

// The code below returns an array of contacts where the contact's address
// contains "San Francisco" in the Home address field.
constcontacts=ContactsApp.getContactsByAddress(
'San Francisco',
ContactsApp.Field.HOME_ADDRESS,
);

Parameters

Return

(削除) Contact[] (削除ここまで) — an array of matching contacts

Authorization

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

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

See also

• (削除) getContact(emailAddress) (削除ここまで)

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

Get contacts matching an address, limited to the specified custom address label.

// The code below returns an array of contacts where the contact's address
// contains "San Francisco" in a custom address label (created by the user)
// called "vacation".
constcontacts=ContactsApp.getContactsByAddress('San Francisco','vacation');

Parameters

Return

(削除) Contact[] (削除ここまで) — an array of matching contacts

Authorization

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

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

See also

• (削除) getContact(emailAddress) (削除ここまで)

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

Get contacts matching the company field.

// The code below returns an array of contacts where the contact's company field
// contains "Google".
constcontacts=ContactsApp.getContactsByCompany('Google');

Parameters

Return

(削除) Contact[] (削除ここまで) — an array of matching contacts

Authorization

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

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

See also

• (削除) getContact(emailAddress) (削除ここまで)

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

Get contacts matching a given value in a custom field.

The custom field can be specified by a String or as one of the ContactsApp.ExtendedField values.

// The code below returns an array of contacts where the contact's custom field
// named "Favorite Sport" contains "tennis".
constcontacts=ContactsApp.getContactsByCustomField(
'tennis',
'Favorite Sport',
);

Parameters

Return

(削除) Contact[] (削除ここまで) — an array of matching contacts

Authorization

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

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

See also

• (削除) getContact(emailAddress) (削除ここまで)

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

Get contacts matching a given month and day for a particular standard field.

// The code below returns an array of contacts where the contact's "Birthday"
// field contains April for the month and 19 for the day.
constcontacts=ContactsApp.getContactsByDate(
ContactsApp.Month.APRIL,
19,
ContactsApp.Field.BIRTHDAY,
);

Parameters

Return

(削除) Contact[] (削除ここまで) — an array of matching contacts

Authorization

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

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

See also

• (削除) getContact(emailAddress) (削除ここまで)

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

Get contacts matching a given month, day, and year for a particular standard field.

// The code below returns an array of contacts where the contact's "Birthday"
// field contains April for the month, 19 for the day, and 1950 for the year.
constcontacts=ContactsApp.getContactsByDate(
ContactsApp.Month.APRIL,
19,
1950,
ContactsApp.Field.BIRTHDAY,
);

Parameters

Return

(削除) Contact[] (削除ここまで) — an array of matching contacts

Authorization

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

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

See also

• (削除) getContact(emailAddress) (削除ここまで)

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

Get contacts matching a given month, day, and year for a particular custom field.

// The code below returns an array of contacts where the contact's custom "Start
// Date" field contains April for the month, 19 for the day, and 2011 for the
// year.
constcontacts=ContactsApp.getContactsByDate(
ContactsApp.Month.APRIL,
19,
2011,
'Start Date',
);

Parameters

Return

(削除) Contact[] (削除ここまで) — an array of matching contacts

Authorization

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

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

See also

• (削除) getContact(emailAddress) (削除ここまで)

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

Get contacts matching a given month and day for a particular custom field.

// The code below returns an array of contacts where the contact's custom "Start
// Date" field contains April for the month and 19 for the day.
constcontacts=ContactsApp.getContactsByDate(
ContactsApp.Month.APRIL,
19,
'Start Date',
);

Parameters

Return

(削除) Contact[] (削除ここまで) — an array of matching contacts

Authorization

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

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

See also

• (削除) getContact(emailAddress) (削除ここまで)

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

Get contacts matching an email address.

// The code below returns an array of contacts where the contact's email address
// contains "john.doe@example.com'.
constcontacts=ContactsApp.getContactsByEmailAddress('john.doe@example.com');

Parameters

Return

(削除) Contact[] (削除ここまで) — an array of matching contacts

Authorization

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

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

See also

• (削除) getContact(emailAddress) (削除ここまで)

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

Get contacts matching an email address, limited to a specific field.

// The code below returns an array of contacts where the contact's email address
// contains "john.doe@example.com" in the Home email field.
constcontacts=ContactsApp.getContactsByEmailAddress(
'john.doe@example.com',
ContactsApp.Field.HOME_EMAIL,
);

Parameters

Return

(削除) Contact[] (削除ここまで) — an array of matching contacts

Authorization

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

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

See also

• (削除) getContact(emailAddress) (削除ここまで)

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

Get contacts matching an email address, limited to the specified custom email address label.

// The code below returns an array of contacts where the contact's email address
// contains "john.doe@example.com" in a custom email address label (created by
// the user) called "alternate".
constcontacts=ContactsApp.getContactsByEmailAddress(
'john.doe@example.com',
'alternate',
);

Parameters

Return

(削除) Contact[] (削除ここまで) — an array of matching contacts

Authorization

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

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

See also

• (削除) getContact(emailAddress) (削除ここまで)

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

Get the contacts in a given ContactGroup.

// The code below returns an array of contacts in the ContactGroup with the name
// "Work Friends".
constgroup=ContactsApp.getContactGroup('Work Friends');
constcontacts=ContactsApp.getContactsByGroup(group);

Parameters

Return

(削除) Contact[] (削除ここまで) — an array of contacts in the given group

Authorization

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

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

See also

• (削除) getContact(emailAddress) (削除ここまで)

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

Get contacts matching an instant messaging address.

// The code below returns an array of contacts where the contact's instant
// messaging address contains "ChatWithJohnDoe" in any instant messaging field.
constcontacts=ContactsApp.getContactsByIM('ChatWithJohnDoe');

Parameters

Return

(削除) Contact[] (削除ここまで) — an array of matching contacts

Authorization

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

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

See also

• (削除) getContact(emailAddress) (削除ここまで)

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

Get contacts matching an instant messaging address, limited to a specific field.

// The code below returns an array of contacts where the contact's instant
// messaging address contains "ChatWithJohnDoe" in the AIM instant messaging
// field.
constcontacts=ContactsApp.getContactsByIM(
'ChatWithJohnDoe',
ContactsApp.Field.AIM,
);

Parameters

Return

(削除) Contact[] (削除ここまで) — an array of matching contacts

Authorization

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

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

See also

• (削除) getContact(emailAddress) (削除ここまで)

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

Get contacts matching an instant messaging address, limited to the specified custom instant messaging label.

// The code below returns an array of contacts where the contact's instant
// messaging address contains "ChatWithJohnDoe" in a custom instant messaging
// label (created by the user) called "eBuddy".
constcontacts=ContactsApp.getContactsByIM('ChatWithJohnDoe','eBuddy');

Parameters

Return

(削除) Contact[] (削除ここまで) — an array of matching contacts

Authorization

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

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

See also

• (削除) getContact(emailAddress) (削除ここまで)

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

Get contacts matching the job title field.

// The code below returns an array of contacts where the contact's job title
// field contains "Product Manager".
constcontacts=ContactsApp.getContactsByJobTitle('Product Manager');

Parameters

Return

(削除) Contact[] (削除ここまで) — an array of matching contacts

Authorization

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

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

See also

• (削除) getContact(emailAddress) (削除ここまで)

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

Get contacts matching a name.

// The code below returns an array of contacts where the contact name contains
// "John"
constcontacts=ContactsApp.getContactsByName('John');

Parameters

Return

(削除) Contact[] (削除ここまで) — an array of matching contacts

Authorization

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

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

See also

• (削除) getContact(emailAddress) (削除ここまで)

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

Get contacts matching a name, limited to a specific field.

// The code below returns an array of contacts where the contact name contains
// "John" in the Given Name field.
constcontacts=ContactsApp.getContactsByName(
'John',
ContactsApp.Field.GIVEN_NAME,
);

Parameters

Return

(削除) Contact[] (削除ここまで) — an array of matching contacts

Authorization

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

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

See also

• (削除) getContact(emailAddress) (削除ここまで)

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

Get contacts matching the notes field.

// The code below returns an array of contacts where the contact's notes field
// contains "sent birthday card".
constcontacts=ContactsApp.getContactsByNotes('sent birthday card');

Parameters

Return

(削除) Contact[] (削除ここまで) — an array of matching contacts

Authorization

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

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

See also

• (削除) getContact(emailAddress) (削除ここまで)

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

Get contacts matching a phone number.

This method will expand out lettered phone numbers, so if you search for '212-555-CODE' and you have '212-555-2633' in your contacts or vice versa, the method will find the appropriate contact.

// The code below returns an array of contacts where the contact's phone number
// contains "212-555-1234' in any phone number field.
constcontacts=ContactsApp.getContactsByPhone('212-555-1234');

Parameters

Return

(削除) Contact[] (削除ここまで) — an array of matching contacts

Authorization

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

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

See also

• (削除) getContact(emailAddress) (削除ここまで)

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

Get contacts matching a phone number, limited to a specific field.

This method will expand out lettered phone numbers, so if you search for '212-555-CODE' and you have '212-555-2633' in your contacts or vice versa, the method will find the appropriate contact.

// The code below returns an array of contacts where the contact's phone number
// contains "212-555-1234" in the Home phone number field.
constcontacts=ContactsApp.getContactsByPhone(
'212-555-1234',
ContactsApp.Field.HOME_PHONE,
);

Parameters

Return

(削除) Contact[] (削除ここまで) — an array of matching contacts

Authorization

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

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

See also

• (削除) getContact(emailAddress) (削除ここまで)

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

Get contacts matching a phone number, limited to the specified custom phone number label.

This method will expand out lettered phone numbers, so if you search for '212-555-CODE' and you have '212-555-2633' in your contacts or vice versa, the method will find the appropriate contact.

// The code below returns an array of contacts where the contact's phone number
// contains "212-555-1234" in a custom phone number label (created by the user)
// called "alternate".
constcontacts=ContactsApp.getContactsByPhone('212-555-1234','alternate');

Parameters

Return

(削除) Contact[] (削除ここまで) — an array of matching contacts

Authorization

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

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

See also

• (削除) getContact(emailAddress) (削除ここまで)

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

Get contacts matching a URL.

// The code below returns an array of contacts where the contact's URL contains
// "www.example.com' in any URL field.
constcontacts=ContactsApp.getContactsByUrl('www.example.com');

Parameters

Return

(削除) Contact[] (削除ここまで) — an array of matching contacts

Authorization

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

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

See also

• (削除) getContact(emailAddress) (削除ここまで)

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

Get contacts matching a URL, limited to a specific field.

// The code below returns an array of contacts where the contact's URL contains
// "www.example.com" in the Work URL field.
constcontacts=ContactsApp.getContactsByUrl(
'www.example.com',
ContactsApp.Field.WORK_WEBSITE,
);

Parameters

Return

(削除) Contact[] (削除ここまで) — an array of matching contacts

Authorization

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

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

See also

• (削除) getContact(emailAddress) (削除ここまで)

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

Get contacts matching a URL, limited to the specified custom URL label.

// The code below returns an array of contacts where the contact's URL contains
// "www.example.com" in a custom URL label (created by the user) called
// "alternate work".
constcontacts=ContactsApp.getContactsByUrl(
'www.example.com',
'alternate work',
);

Parameters

Return

(削除) Contact[] (削除ここまで) — an array of matching contacts

Authorization

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

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

See also

• (削除) getContact(emailAddress) (削除ここまで)