Эта страница переведена с помощью Cloud Translation API.

Class ContactGroup

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

ContactGroup — это группа контактов.

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

Метод	Тип возврата	Краткое описание
`addContact(contact)`	`ContactGroup`	Добавляет данный контакт в эту группу
`deleteGroup()`	`void`	Удаляет эту группу контактов.
`getContacts()`	`Contact[]`	Получает все контакты в этой группе контактов.
`getGroupName()`	`String`	Возвращает имя этой группы.
`getId()`	`String`	Получает идентификатор этой группы контактов.
`getName()`	`String`	Получает имя этой группы контактов.
`isSystemGroup()`	`Boolean`	Получает логическое значение, определяющее, является ли эта группа контактов системной группой (неудаляемой) или нет.
`removeContact(contact)`	`ContactGroup`	Удаляет данный контакт из этой группы
`setGroupName(name)`	`void`	Устанавливает имя этой группы.
`setName(name)`	`ContactGroup`	Устанавливает имя этой группы контактов.

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

`addContact(contact)`

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

Добавляет данный контакт в эту группу

// The code below creates a new contact and adds it to the "Work Friends" contact group
var contact = ContactsApp.createContact('John', 'Doe', 'john.doe@example.com');
var group = ContactsApp.getContactGroup('Work Friends');
group.addContact(contact);

Параметры

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

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

ContactGroup — эта группа контактов

Авторизация

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

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

См. также

removeContact(contact)

`deleteGroup()`

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

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

Удаляет только несистемные группы; системные группы не могут быть удалены.

// The code below retrieves a contact group named "Work Friends" and deletes it
var group = ContactsApp.getContactGroup('Work Friends');
group.deleteGroup();

Авторизация

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

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

См. также

isSystemGroup()

`getContacts()`

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

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

// The code below retrieves all the contacts in the group named "Work Friends"
var group = ContactsApp.getContactGroup('Work Friends');
var contacts = group.getContacts();

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

Contact[] — контакты в этой группе

Авторизация

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

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

`getGroupName()`

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

Возвращает имя этой группы.

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

String — имя этой группы

Авторизация

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

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

`getId()`

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

Получает идентификатор этой группы контактов.

// The code below retrieves a contact group named "Work Friends" and gets its id
var group = ContactsApp.getContactGroup('Work Friends');
var id = group.getId();

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

String — идентификатор этой группы

Авторизация

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

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

`getName()`

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

Получает имя этой группы контактов.

// The code below creates a new contact group and then retrieves its name
var group = ContactsApp.createContactGroup('Work Friends');
var name = group.getName();

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

String — это имя данной контактной группы

Авторизация

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

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

См. также

setName(name)

`isSystemGroup()`

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

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

Системные группы — это набор групп, предопределенных в Google Контактах, например «Мои контакты», «Семья», «Коллеги» и т. д. Название системной группы обычно содержит слова «Системная группа».

// The code below retrieves two contact groups, then logs whether or not
// each is a system group.
var myGroup = ContactsApp.getContactGroup('Work Friends');
var systemGroup = ContactsApp.getContactGroup('System Group: Coworkers');
Logger.log(myGroup.isSystemGroup()); // Returns false, if the group exists.
Logger.log(systemGroup.isSystemGroup()); // Returns true.

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

Boolean — является ли эта группа контактов системной группой.

Авторизация

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

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

`removeContact(contact)`

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

Удаляет данный контакт из этой группы

// The code below retrieves all the contacts named "John Doe' and removes them from the
// "Work Friends" contact group
var contacts = ContactsApp.getContactsByName('John Doe');
var group = ContactsApp.getContactGroup('Work Friends');
for (var i in contacts) {
  group.removeContact(contacts[i]);
}

Параметры

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

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

ContactGroup — эта группа контактов

Авторизация

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

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

См. также

addContact(contact)

`setGroupName(name)`

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

Устанавливает имя этой группы.

Параметры

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

Авторизация

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

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

`setName(name)`

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

Устанавливает имя этой группы контактов.

// The code below retrieves the contact group named "Work Friends" and renames it to
// "Work Buddies"
var group = ContactsApp.getContactGroup('Work Friends');
group.setName('Work Buddies');

Параметры

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

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

ContactGroup — эта группа контактов

Авторизация

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

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

См. также

getName()