Class ContactGroup

ContactGroup

Veraltet. Verwenden Sie stattdessen den erweiterten Dienst der People API.

Eine Kontaktgruppe besteht aus mehreren Kontakten.

MethodeRückgabetypKurzbeschreibung
addContact(contact)ContactGroupFügen Sie den angegebenen Kontakt dieser Gruppe hinzu. 
// The code below creates a new contact and adds it to the "Work Friends"
// contact group
const contact = ContactsApp.createContact(
    'John',
    'Doe',
    'john.doe@example.com',
);
const group = ContactsApp.getContactGroup('Work Friends');
group.addContact(contact);
deleteGroup()voidDiese Kontaktgruppe wird gelöscht.
getContacts()Contact[]Ruft alle Kontakte in dieser Kontaktgruppe ab.
getGroupName()StringGibt den Namen dieser Gruppe zurück.
getId()StringRuft die ID dieser Kontaktgruppe ab.
getName()StringDer Name dieser Kontaktgruppe.
isSystemGroup()BooleanBoolescher Wert, der angibt, ob es sich bei dieser Kontaktgruppe um eine Systemgruppe handelt, die nicht gelöscht werden kann.
removeContact(contact)ContactGroupEntfernt den angegebenen Kontakt aus dieser Gruppe. 
// 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]);
}
setGroupName(name)voidLegt den Namen dieser Gruppe fest.
setName(name)ContactGroupLegt den Namen dieser Kontaktgruppe fest.

Eingestellte Methoden

Veraltet. Diese Funktion wurde eingestellt und sollte in neuen Scripts nicht verwendet werden.

Fügen Sie den angegebenen Kontakt dieser Gruppe hinzu. 

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

Parameter

NameTypBeschreibung
contactContactden Kontakt, der der Gruppe hinzugefügt werden soll

Rückflug

ContactGroup – diese Kontaktgruppe

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

Weitere Informationen

Veraltet. Diese Funktion wurde eingestellt und sollte in neuen Scripts nicht verwendet werden.

Diese Kontaktgruppe wird gelöscht.

Es werden nur Gruppen gelöscht, die keine Systemgruppen sind. Systemgruppen können nicht gelöscht werden. 

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

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

Weitere Informationen

Veraltet. Diese Funktion wurde eingestellt und sollte in neuen Scripts nicht verwendet werden.

Ruft alle Kontakte in dieser Kontaktgruppe ab. 

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

Rückflug

Contact[] – die Kontakte in dieser Gruppe

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

Veraltet. Diese Funktion wurde eingestellt und sollte in neuen Scripts nicht verwendet werden.

Gibt den Namen dieser Gruppe zurück.

Rückflug

String: Name dieser Gruppe

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

Veraltet. Diese Funktion wurde eingestellt und sollte in neuen Scripts nicht verwendet werden.

Ruft die ID dieser Kontaktgruppe ab. 

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

Rückflug

String – die ID dieser Gruppe

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

Veraltet. Diese Funktion wurde eingestellt und sollte in neuen Scripts nicht verwendet werden.

Der Name dieser Kontaktgruppe. 

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

Rückflug

String – der Name dieser Kontaktgruppe

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

Weitere Informationen

Veraltet. Diese Funktion wurde eingestellt und sollte in neuen Scripts nicht verwendet werden.

Boolescher Wert, der angibt, ob es sich bei dieser Kontaktgruppe um eine Systemgruppe handelt, die nicht gelöscht werden kann.

Systemgruppen sind Gruppen, die in Google Kontakte vordefiniert sind, z. B. „Meine Kontakte“, „Familie“ oder „Arbeitskollegen“. Der Name einer Systemgruppe enthält in der Regel die Wörter „Systemgruppe“. 

// 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.

Rückflug

Boolean – ob es sich bei dieser Kontaktgruppe um eine Systemgruppe handelt

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

Veraltet. Diese Funktion wurde eingestellt und sollte in neuen Scripts nicht verwendet werden.

Entfernt den angegebenen Kontakt aus dieser Gruppe. 

// 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]);
}

Parameter

NameTypBeschreibung
contactContactden Kontakt, der aus der Gruppe entfernt werden soll

Rückflug

ContactGroup – diese Kontaktgruppe

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

Weitere Informationen

Veraltet. Diese Funktion wurde eingestellt und sollte in neuen Scripts nicht verwendet werden.

Legt den Namen dieser Gruppe fest.

Parameter

NameTypBeschreibung
nameStringDer Name, der für diese Gruppe festgelegt werden soll

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

Veraltet. Diese Funktion wurde eingestellt und sollte in neuen Scripts nicht verwendet werden.

Legt den Namen dieser Kontaktgruppe fest. 

// 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');

Parameter

NameTypBeschreibung
nameStringden neuen Namen für die Kontaktgruppe

Rückflug

ContactGroup – diese Kontaktgruppe

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

Weitere Informationen