Class ContactGroup

Контактная группа

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

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

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

Метод	Тип возврата	Краткое описание
add Contact(contact)	Contact Group	Добавляет данный контакт в эту группу // The code below creates a new contact and adds it to the "Work Friends" // contact group const contact = ContactsApp.createContact( 'John', 'Doe', '[e-mail]', ); const group = ContactsApp.getContactGroup('Work Friends'); group.addContact(contact);
delete Group()	void	Удаляет эту группу контактов.
get Contacts()	Contact[]	Получает все контакты в этой группе контактов.
get Group Name()	String	Возвращает имя этой группы.
get Id()	String	Получает идентификатор этой группы контактов.
get Name()	String	Получает имя этой группы контактов.
is System Group()	Boolean	Получает логическое значение, определяющее, является ли эта группа контактов системной группой (неудаляемой) или нет.
remove Contact(contact)	Contact Group	Удаляет данный контакт из этой группы // The code below retrieves all the contacts named "John Doe' and removes them // from the "Work Friends" contact group const contacts = ContactsApp.getContactsByName('John Doe'); const group = ContactsApp.getContactGroup('Work Friends'); for (const i in contacts) { group.removeContact(contacts[i]); }
set Group Name(name)	void	Устанавливает имя этой группы.
set Name(name)	Contact Group	Устанавливает имя этой группы контактов.

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

add Contact(contact)

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

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

// The code below creates a new contact and adds it to the "Work Friends"
// contact group
const contact = ContactsApp.createContact(
    'John',
    'Doe',
    '[e-mail]',
);
const group = ContactsApp.getContactGroup('Work Friends');
group.addContact(contact);

Параметры

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

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

Contact Group — эта контактная группа

Авторизация

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

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

См. также

• remove Contact(contact)

---

delete Group()

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

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

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

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

Авторизация

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

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

См. также

• is System Group()

---

get Contacts()

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

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

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

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

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

Авторизация

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

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

---

get Group Name()

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

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

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

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

Авторизация

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

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

---

get Id()

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

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

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

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

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

Авторизация

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

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

---

get Name()

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

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

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

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

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

Авторизация

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

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

См. также

• set Name(name)

---

is System Group()

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

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

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

// The code below retrieves two contact groups, then logs whether or not
// each is a system group.
const myGroup = ContactsApp.getContactGroup('Work Friends');
const 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

---

remove Contact(contact)

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

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

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

Параметры

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

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

Contact Group — эта контактная группа

Авторизация

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

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

См. также

• add Contact(contact)

---

set Group Name(name)

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

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

Параметры

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

Авторизация

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

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

---

set Name(name)

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

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

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

Параметры

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

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

Contact Group — эта контактная группа

Авторизация

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

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

См. также

• get Name()