Class ContactsApp

КонтактыПриложение

Устарело. Вместо этого используйте расширенный сервис People API.

Этот класс позволяет пользователям получать доступ к своим контактам Google, а также создавать, удалять и обновлять перечисленные в них контакты.

Устаревшие свойства

Свойство	Тип	Описание
ExtendedField	ExtendedField
Field	Field
Gender	Gender
Month	Month
Priority	Priority
Sensitivity	Sensitivity

Устаревшие методы

Метод	Тип возврата	Краткое описание
createContact(givenName, familyName, email)	Contact	Создает новый контакт.
createContactGroup(name)	ContactGroup	Создает группу контактов с заданным именем.
deleteContact(contact)	void	Удаляет контакт.
deleteContactGroup(group)	void	Удаляет группу контактов
findByEmailAddress(email)	Contact	Находит контакт с указанным адресом электронной почты.
findContactGroup(name)	ContactGroup	Находит группу контактов по заданному имени.
getAllContacts()	Contact[]	Получите все контакты, принадлежащие этому пользователю.
getContact(emailAddress)	Contact	Получает контакт по адресу электронной почты.
getContactById(id)	Contact	Получает контакт с этим идентификатором.
getContactGroup(name)	ContactGroup	Получает группу контактов с заданным именем или возвращает значение null, если такая группа контактов не найдена.
getContactGroupById(id)	ContactGroup	Получает группу контактов с заданным идентификатором или возвращает значение null, если такая группа контактов не найдена.
getContactGroups()	ContactGroup[]	Получает полный список групп контактов пользователя.
getContacts()	Contact[]	Получает все контакты пользователя.
getContactsByAddress(query)	Contact[]	Получите контакты, соответствующие адресу.
getContactsByAddress(query, label)	Contact[]	Получите контакты, соответствующие адресу, ограниченному определенным полем.
getContactsByAddress(query, label)	Contact[]	Получите контакты, соответствующие адресу, ограниченному указанной настраиваемой меткой адреса.
getContactsByCompany(query)	Contact[]	Получите контакты, соответствующие полю компании.
getContactsByCustomField(query, label)	Contact[]	Получите контакты, соответствующие заданному значению в настраиваемом поле.
getContactsByDate(month, day, label)	Contact[]	Получите контакты, соответствующие заданному месяцу и дню, для определенного стандартного поля.
getContactsByDate(month, day, year, label)	Contact[]	Получите контакты, соответствующие заданному месяцу, дню и году, для определенного стандартного поля.
getContactsByDate(month, day, year, label)	Contact[]	Получите контакты, соответствующие заданному месяцу, дню и году, для определенного настраиваемого поля.
getContactsByDate(month, day, label)	Contact[]	Получите контакты, соответствующие заданному месяцу и дню, для определенного настраиваемого поля.
getContactsByEmailAddress(query)	Contact[]	Получите контакты, соответствующие адресу электронной почты.
getContactsByEmailAddress(query, label)	Contact[]	Получите контакты, соответствующие адресу электронной почты, ограниченные определенным полем.
getContactsByEmailAddress(query, label)	Contact[]	Получайте контакты, соответствующие адресу электронной почты, ограниченные указанной настраиваемой меткой адреса электронной почты.
getContactsByGroup(group)	Contact[]	Получите контакты в данной ContactGroup.
getContactsByIM(query)	Contact[]	Получите контакты, соответствующие адресу обмена мгновенными сообщениями.
getContactsByIM(query, label)	Contact[]	Получите контакты, соответствующие адресу обмена мгновенными сообщениями, ограниченному определенным полем.
getContactsByIM(query, label)	Contact[]	Получайте контакты, соответствующие адресу обмена мгновенными сообщениями, ограниченному указанной настраиваемой меткой обмена мгновенными сообщениями.
getContactsByJobTitle(query)	Contact[]	Получите контакты, соответствующие полю должности.
getContactsByName(query)	Contact[]	Получите контакты, соответствующие имени.
getContactsByName(query, label)	Contact[]	Получите контакты, соответствующие имени, ограниченные определенным полем.
getContactsByNotes(query)	Contact[]	Получите контакты, соответствующие полю примечаний.
getContactsByPhone(query)	Contact[]	Получите контакты, соответствующие номеру телефона.
getContactsByPhone(query, label)	Contact[]	Получите контакты, соответствующие номеру телефона, ограниченному определенным полем.
getContactsByPhone(query, label)	Contact[]	Получайте контакты, соответствующие номеру телефона, ограниченные указанной настраиваемой меткой номера телефона.
getContactsByUrl(query)	Contact[]	Получите контакты, соответствующие URL-адресу.
getContactsByUrl(query, label)	Contact[]	Получите контакты, соответствующие URL-адресу, ограниченному определенным полем.
getContactsByUrl(query, label)	Contact[]	Получите контакты, соответствующие URL-адресу, ограниченному указанной настраиваемой меткой URL-адреса.

Устаревшие методы

createContact(givenName, familyName, email)

Устарело. Эта функция устарела и не должна использоваться в новых скриптах.

Создает новый контакт.

// The code below creates a new contact with the name "John Doe" and the email address
// "[e-mail]".
var contact = ContactsApp.createContact('John', 'Doe', '[e-mail]');

Параметры

Имя	Тип	Описание
givenName	String	имя контакта
familyName	String	фамилия контактного лица
email	String	адрес электронной почты контактного лица

Возвращаться

Contact — вновь созданный объект Контакта.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

См. также

• deleteContact(contact)

---

createContactGroup(name)

Устарело. Эта функция устарела и не должна использоваться в новых скриптах.

Создает группу контактов с заданным именем.

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

Параметры

Имя	Тип	Описание
name	String	имя новой контактной группы

Возвращаться

ContactGroup — вновь созданная группа контактов.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

См. также

• deleteContactGroup(group)

---

deleteContact(contact)

Устарело. Эта функция устарела и не должна использоваться в новых скриптах.

Удаляет контакт.

// The code below retrieves a contact with the email address "[e-mail]"
// and then deletes that contact.
var contact = ContactsApp.getContact('[e-mail]');
ContactsApp.deleteContact(contact);

Параметры

Имя	Тип	Описание
contact	Contact	контакт, который нужно удалить

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

См. также

• createContact(givenName, familyName, email)

---

deleteContactGroup(group)

Устарело. Эта функция устарела и не должна использоваться в новых скриптах.

Удаляет группу контактов

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

Параметры

Имя	Тип	Описание
group	ContactGroup	группа контактов, которую нужно удалить

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

См. также

• createContactGroup(name)

---

findByEmailAddress(email)

Устарело. Эта функция устарела и не должна использоваться в новых скриптах.

Находит контакт с указанным адресом электронной почты.

Параметры

Имя	Тип	Описание
email	String	адрес электронной почты контакта, которого необходимо найти

Возвращаться

Contact — Контакт, содержащий этот адрес электронной почты.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

---

findContactGroup(name)

Устарело. Эта функция устарела и не должна использоваться в новых скриптах.

Находит группу контактов по заданному имени.

Параметры

Имя	Тип	Описание
name	String	название контактной группы, которую нужно найти

Возвращаться

ContactGroup — группа контактов, соответствующая данному имени.

Авторизация

Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

---

getAllContacts()

Устарело. Эта функция устарела и не должна использоваться в новых скриптах.

Получите все контакты, принадлежащие этому пользователю.

Возвращаться

Contact[] — все контакты этого пользователя

Авторизация

Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

---

getContact(emailAddress)

Устарело. Эта функция устарела и не должна использоваться в новых скриптах.

Получает контакт по адресу электронной почты.

Если несколько контактов используют один и тот же адрес электронной почты, метод отдает предпочтение тем контактам, которые отметили адрес электронной почты как основной; если ни у одного из контактов адрес электронной почты не был помечен как основной или у нескольких контактов адрес электронной почты был помечен как основной, то возвращается первый результат в отсортированном порядке контактов.

// The code below retrieves a contact with the email address "[e-mail]".
var contact = ContactsApp.getContact('[e-mail]');

Параметры

Имя	Тип	Описание
emailAddress	String	адрес электронной почты контактного лица

Возвращаться

Contact — контакт, содержащий этот адрес электронной почты.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

См. также

• getContacts()
• getContactById(id)

---

getContactById(id)

Устарело. Эта функция устарела и не должна использоваться в новых скриптах.

Получает контакт с этим идентификатором.

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

Параметры

Имя	Тип	Описание
id	String	идентификатор контакта для получения

Возвращаться

Contact — соответствующий контакт или ноль

Авторизация

Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

См. также

• getContact(emailAddress)

---

getContactGroup(name)

Устарело. Эта функция устарела и не должна использоваться в новых скриптах.

Получает группу контактов с заданным именем или возвращает значение null, если такая группа контактов не найдена.

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

Параметры

Имя	Тип	Описание
name	String	имя контактной группы для сопоставления

Возвращаться

ContactGroup — соответствующая группа контактов или значение NULL, если соответствующая группа контактов не найдена.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

См. также

• getContactGroups()

---

getContactGroupById(id)

Устарело. Эта функция устарела и не должна использоваться в новых скриптах.

Получает группу контактов с заданным идентификатором или возвращает значение null, если такая группа контактов не найдена.

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

Параметры

Имя	Тип	Описание
id	String	идентификатор группы контактов для сопоставления

Возвращаться

ContactGroup — соответствующая группа контактов или значение NULL, если соответствующая группа контактов не найдена.

См. также

• getContactGroups()

---

getContactGroups()

Устарело. Эта функция устарела и не должна использоваться в новых скриптах.

Получает полный список групп контактов пользователя.

Пользователь может иметь список контактов, а также, возможно, список групп контактов. Каждая группа контактов может содержать контакты. Этот метод возвращает список всех групп контактов.

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

Возвращаться

ContactGroup[] — массив групп контактов пользователя.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

См. также

• getContactGroup(name)

---

getContacts()

Устарело. Эта функция устарела и не должна использоваться в новых скриптах.

Получает все контакты пользователя.

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

Возвращаться

Contact[] — массив всех контактов пользователя

Авторизация

Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

См. также

• getContact(emailAddress)

---

getContactsByAddress(query)

Устарело. Эта функция устарела и не должна использоваться в новых скриптах.

Получите контакты, соответствующие адресу.

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

Параметры

Имя	Тип	Описание
query	String	строка для поиска в адресах контактов

Возвращаться

Contact[] — массив совпадающих контактов

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

См. также

• getContact(emailAddress)

---

getContactsByAddress(query, label)

Устарело. Эта функция устарела и не должна использоваться в новых скриптах.

Получите контакты, соответствующие адресу, ограниченному определенным полем.

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

Параметры

Имя	Тип	Описание
query	String	строка для поиска в адресах контактов
label	Field	поле для поиска внутри

Возвращаться

Contact[] — массив совпадающих контактов

Авторизация

Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

См. также

• getContact(emailAddress)

---

getContactsByAddress(query, 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".
var contacts = ContactsApp.getContactsByAddress('San Francisco', 'vacation');

Параметры

Имя	Тип	Описание
query	String	строка для поиска в адресах контактов с указанной настраиваемой адресной меткой
label	String	настраиваемая адресная метка для поиска внутри

Возвращаться

Contact[] — массив совпадающих контактов

Авторизация

Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

См. также

• getContact(emailAddress)

---

getContactsByCompany(query)

Устарело. Эта функция устарела и не должна использоваться в новых скриптах.

Получите контакты, соответствующие полю компании.

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

Параметры

Имя	Тип	Описание
query	String	строка для поиска в поле компании контакта

Возвращаться

Contact[] — массив совпадающих контактов

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

См. также

• getContact(emailAddress)

---

getContactsByCustomField(query, label)

Устарело. Эта функция устарела и не должна использоваться в новых скриптах.

Получите контакты, соответствующие заданному значению в настраиваемом поле.

Настраиваемое поле можно указать в виде строки или одного из значений ContactsApp.ExtendedField.

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

Параметры

Имя	Тип	Описание
query	Object	строка для поиска в настраиваемом поле контакта
label	ExtendedField	настраиваемое поле для поиска

Возвращаться

Contact[] — массив совпадающих контактов

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

См. также

• getContact(emailAddress)

---

getContactsByDate(month, day, label)

Устарело. Эта функция устарела и не должна использоваться в новых скриптах.

Получите контакты, соответствующие заданному месяцу и дню, для определенного стандартного поля.

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

Параметры

Имя	Тип	Описание
month	Month	соответствующий месяц, как одно из значений ContactsApp.Month
day	Integer	день, чтобы соответствовать
label	Field	поле для поиска из ContactsApp.Field

Возвращаться

Contact[] — массив совпадающих контактов

Авторизация

Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

См. также

• getContact(emailAddress)

---

getContactsByDate(month, day, year, label)

Устарело. Эта функция устарела и не должна использоваться в новых скриптах.

Получите контакты, соответствующие заданному месяцу, дню и году, для определенного стандартного поля.

// 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.
var contacts = ContactsApp.getContactsByDate(ContactsApp.Month.APRIL, 19, 1950,
                                             ContactsApp.Field.BIRTHDAY);

Параметры

Имя	Тип	Описание
month	Month	соответствующий месяц, как одно из значений ContactsApp.Month
day	Integer	день, чтобы соответствовать
year	Integer	соответствующий год может быть нулевым
label	Field	поле для поиска из ContactsApp.Field

Возвращаться

Contact[] — массив совпадающих контактов

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

См. также

• getContact(emailAddress)

---

getContactsByDate(month, day, year, label)

Устарело. Эта функция устарела и не должна использоваться в новых скриптах.

Получите контакты, соответствующие заданному месяцу, дню и году, для определенного настраиваемого поля.

// 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.
var contacts = ContactsApp.getContactsByDate(ContactsApp.Month.APRIL, 19, 2011, 'Start Date');

Параметры

Имя	Тип	Описание
month	Month	соответствующий месяц, как одно из значений ContactsApp.Month
day	Integer	день, чтобы соответствовать
year	Integer	соответствующий год может быть нулевым
label	String	настраиваемое поле для поиска

Возвращаться

Contact[] — массив совпадающих контактов

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

См. также

• getContact(emailAddress)

---

getContactsByDate(month, day, label)

Устарело. Эта функция устарела и не должна использоваться в новых скриптах.

Получите контакты, соответствующие заданному месяцу и дню, для определенного настраиваемого поля.

// 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.
var contacts = ContactsApp.getContactsByDate(ContactsApp.Month.APRIL, 19, 'Start Date');

Параметры

Имя	Тип	Описание
month	Month	соответствующий месяц, как одно из значений ContactsApp.Month
day	Integer	день, чтобы соответствовать
label	String	настраиваемое поле для поиска

Возвращаться

Contact[] — массив совпадающих контактов

Авторизация

Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

См. также

• getContact(emailAddress)

---

getContactsByEmailAddress(query)

Устарело. Эта функция устарела и не должна использоваться в новых скриптах.

Получите контакты, соответствующие адресу электронной почты.

// The code below returns an array of contacts where the contact's email address contains
// "[e-mail]'.
var contacts = ContactsApp.getContactsByEmailAddress('[e-mail]');

Параметры

Имя	Тип	Описание
query	String	строка для поиска в контактных адресах электронной почты

Возвращаться

Contact[] — массив совпадающих контактов

Авторизация

Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

См. также

• getContact(emailAddress)

---

getContactsByEmailAddress(query, label)

Устарело. Эта функция устарела и не должна использоваться в новых скриптах.

Получите контакты, соответствующие адресу электронной почты, ограниченные определенным полем.

// The code below returns an array of contacts where the contact's email address contains
// "[e-mail]" in the Home email field.
var contacts = ContactsApp.getContactsByEmailAddress('[e-mail]',
                                                     ContactsApp.Field.HOME_EMAIL);

Параметры

Имя	Тип	Описание
query	String	строка для поиска в контактных адресах электронной почты
label	Field	поле для поиска внутри

Возвращаться

Contact[] — массив совпадающих контактов

Авторизация

Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

См. также

• getContact(emailAddress)

---

getContactsByEmailAddress(query, label)

Устарело. Эта функция устарела и не должна использоваться в новых скриптах.

Получайте контакты, соответствующие адресу электронной почты, ограниченные указанной настраиваемой меткой адреса электронной почты.

// The code below returns an array of contacts where the contact's email address contains
// "[e-mail]" in a custom email address label (created by the user) called
// "alternate".
var contacts = ContactsApp.getContactsByEmailAddress('[e-mail]', 'alternate');

Параметры

Имя	Тип	Описание
query	String	строка для поиска в контактных адресах электронной почты с указанной настраиваемой меткой адреса электронной почты
label	String	метка пользовательского адреса электронной почты для поиска

Возвращаться

Contact[] — массив совпадающих контактов

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

См. также

• getContact(emailAddress)

---

getContactsByGroup(group)

Устарело. Эта функция устарела и не должна использоваться в новых скриптах.

Получите контакты в данной ContactGroup.

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

Параметры

Имя	Тип	Описание
group	ContactGroup	группа контактов

Возвращаться

Contact[] — массив контактов в данной группе

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

См. также

• getContact(emailAddress)

---

getContactsByIM(query)

Устарело. Эта функция устарела и не должна использоваться в новых скриптах.

Получите контакты, соответствующие адресу обмена мгновенными сообщениями.

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

Параметры

Имя	Тип	Описание
query	String	строка для поиска в адресах обмена мгновенными сообщениями контакта

Возвращаться

Contact[] — массив совпадающих контактов

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

См. также

• getContact(emailAddress)

---

getContactsByIM(query, label)

Устарело. Эта функция устарела и не должна использоваться в новых скриптах.

Получите контакты, соответствующие адресу обмена мгновенными сообщениями, ограниченному определенным полем.

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

Параметры

Имя	Тип	Описание
query	String	строка для поиска в адресах обмена мгновенными сообщениями контакта
label	Field	поле для поиска внутри

Возвращаться

Contact[] — массив совпадающих контактов

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

См. также

• getContact(emailAddress)

---

getContactsByIM(query, 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".
var contacts = ContactsApp.getContactsByIM('ChatWithJohnDoe', 'eBuddy');

Параметры

Имя	Тип	Описание
query	String	строка для поиска в адресах обмена мгновенными сообщениями контакта с указанной пользовательской меткой обмена мгновенными сообщениями
label	String	персонализированная метка обмена мгновенными сообщениями для поиска

Возвращаться

Contact[] — массив совпадающих контактов

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

См. также

• getContact(emailAddress)

---

getContactsByJobTitle(query)

Устарело. Эта функция устарела и не должна использоваться в новых скриптах.

Получите контакты, соответствующие полю должности.

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

Параметры

Имя	Тип	Описание
query	String	строка для поиска в поле названия должности контакта

Возвращаться

Contact[] — массив совпадающих контактов

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

См. также

• getContact(emailAddress)

---

getContactsByName(query)

Устарело. Эта функция устарела и не должна использоваться в новых скриптах.

Получите контакты, соответствующие имени.

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

Параметры

Имя	Тип	Описание
query	String	строка для поиска в именах контактов

Возвращаться

Contact[] — массив совпадающих контактов

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

См. также

• getContact(emailAddress)

---

getContactsByName(query, label)

Устарело. Эта функция устарела и не должна использоваться в новых скриптах.

Получите контакты, соответствующие имени, ограниченные определенным полем.

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

Параметры

Имя	Тип	Описание
query	String	строка для поиска в именах контактов
label	Field	поле для поиска внутри

Возвращаться

Contact[] — массив совпадающих контактов

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

См. также

• getContact(emailAddress)

---

getContactsByNotes(query)

Устарело. Эта функция устарела и не должна использоваться в новых скриптах.

Получите контакты, соответствующие полю примечаний.

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

Параметры

Имя	Тип	Описание
query	String	строка для поиска в поле заметок контакта

Возвращаться

Contact[] — массив совпадающих контактов

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

См. также

• getContact(emailAddress)

---

getContactsByPhone(query)

Устарело. Эта функция устарела и не должна использоваться в новых скриптах.

Получите контакты, соответствующие номеру телефона.

Этот метод расширит буквенные телефонные номера, поэтому, если вы ищете «212-555-КОД», а в ваших контактах есть «212-555-2633» или наоборот, метод найдет соответствующий контакт.

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

Параметры

Имя	Тип	Описание
query	String	строка для поиска в телефонных номерах контакта

Возвращаться

Contact[] — массив совпадающих контактов

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

См. также

• getContact(emailAddress)

---

getContactsByPhone(query, label)

Устарело. Эта функция устарела и не должна использоваться в новых скриптах.

Получите контакты, соответствующие номеру телефона, ограниченному определенным полем.

Этот метод расширит буквенные телефонные номера, поэтому, если вы ищете «212-555-КОД», а в ваших контактах есть «212-555-2633» или наоборот, метод найдет соответствующий контакт.

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

Параметры

Имя	Тип	Описание
query	String	строка для поиска в телефонных номерах контакта
label	Field	поле для поиска внутри

Возвращаться

Contact[] — массив совпадающих контактов

Авторизация

Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

См. также

• getContact(emailAddress)

---

getContactsByPhone(query, label)

Устарело. Эта функция устарела и не должна использоваться в новых скриптах.

Получайте контакты, соответствующие номеру телефона, ограниченные указанной настраиваемой меткой номера телефона.

Этот метод расширит буквенные телефонные номера, поэтому, если вы ищете «212-555-КОД», а в ваших контактах есть «212-555-2633» или наоборот, метод найдет соответствующий контакт.

// 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".
var contacts = ContactsApp.getContactsByPhone('212-555-1234', 'alternate');

Параметры

Имя	Тип	Описание
query	String	строка для поиска в телефонных номерах контакта с указанной настраиваемой меткой номера телефона
label	String	метка пользовательского номера телефона для поиска

Возвращаться

Contact[] — массив совпадающих контактов

Авторизация

Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

См. также

• getContact(emailAddress)

---

getContactsByUrl(query)

Устарело. Эта функция устарела и не должна использоваться в новых скриптах.

Получите контакты, соответствующие URL-адресу.

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

Параметры

Имя	Тип	Описание
query	String	строка для поиска в URL-адресах контактов

Возвращаться

Contact[] — массив совпадающих контактов

Авторизация

Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

См. также

• getContact(emailAddress)

---

getContactsByUrl(query, label)

Устарело. Эта функция устарела и не должна использоваться в новых скриптах.

Получите контакты, соответствующие URL-адресу, ограниченному определенным полем.

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

Параметры

Имя	Тип	Описание
query	String	строка для поиска в URL-адресах контактов
label	Field	поле для поиска внутри

Возвращаться

Contact[] — массив совпадающих контактов

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

См. также

• getContact(emailAddress)

---

getContactsByUrl(query, label)

Устарело. Эта функция устарела и не должна использоваться в новых скриптах.

Получите контакты, соответствующие URL-адресу, ограниченному указанной настраиваемой меткой URL-адреса.

// 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".
var contacts = ContactsApp.getContactsByUrl('www.example.com', 'alternate work');

Параметры

Имя	Тип	Описание
query	String	строка для поиска в URL-адресах контактов с указанной настраиваемой меткой URL-адреса
label	String	пользовательская метка URL-адреса для поиска

Возвращаться

Contact[] — массив совпадающих контактов

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

См. также

• getContact(emailAddress)