Class ContactGroup

יצירת קשר עם קבוצה

הוצא משימוש. במקום זאת, כדאי להשתמש בשירות המתקדם של People API

ContactGroup היא קבוצה של אנשי קשר.

שיטהסוג הערך המוחזרתיאור קצר
addContact(contact)ContactGroupהוספת איש הקשר הנתון לקבוצה הזו
// 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()voidהמחיקה של קבוצת אנשי הקשר הזו.
getContacts()Contact[]הפונקציה מקבלת את כל אנשי הקשר בקבוצת אנשי הקשר הזו.
getGroupName()Stringהפונקציה מחזירה את השם של הקבוצה הזו.
getId()Stringהפונקציה מקבלת את המזהה של קבוצת אנשי הקשר הזו.
getName()Stringהפונקציה מקבלת את השם של קבוצת אנשי הקשר הזו.
isSystemGroup()Booleanהפונקציה מקבלת ערך בוליאני כדי לקבוע אם קבוצת אנשי הקשר הזו היא קבוצת מערכת (לא ניתן למחוק אותה) או לא.
removeContact(contact)ContactGroupהסרת איש הקשר מהקבוצה הזו
// 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)voidהגדרת השם של הקבוצה.
setName(name)ContactGroupהגדרת השם של קבוצת אנשי הקשר הזו.

שיטות שהוצאו משימוש

הוצא משימוש. הפונקציה הזו הוצאה משימוש ואין להשתמש בה בסקריפטים חדשים.

הוספת איש הקשר הנתון לקבוצה הזו

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

פרמטרים

שםסוגתיאור
contactContactאיש הקשר שרוצים להוסיף לקבוצה

חזרה

ContactGroup – קבוצת אנשי הקשר הזו

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

ראה גם


הוצא משימוש. הפונקציה הזו הוצאה משימוש ואין להשתמש בה בסקריפטים חדשים.

מחיקה של קבוצת אנשי הקשר הזו.

המחיקה מתבצעת רק לגבי קבוצות שאינן קבוצות מערכת. אי אפשר למחוק קבוצות מערכת.

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

ראה גם


הוצא משימוש. הפונקציה הזו הוצאה משימוש ואין להשתמש בה בסקריפטים חדשים.

הפונקציה מקבלת את כל אנשי הקשר בקבוצת אנשי הקשר הזו.

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

הוצא משימוש. הפונקציה הזו הוצאה משימוש ואין להשתמש בה בסקריפטים חדשים.

הפונקציה מחזירה את השם של הקבוצה הזו.

חזרה

String – השם של הקבוצה הזו

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

הוצא משימוש. הפונקציה הזו הוצאה משימוש ואין להשתמש בה בסקריפטים חדשים.

הפונקציה מקבלת את המזהה של קבוצת אנשי הקשר הזו.

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

הוצא משימוש. הפונקציה הזו הוצאה משימוש ואין להשתמש בה בסקריפטים חדשים.

הפונקציה מקבלת את השם של קבוצת אנשי הקשר הזו.

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

ראה גם


הוצא משימוש. הפונקציה הזו הוצאה משימוש ואין להשתמש בה בסקריפטים חדשים.

הפונקציה מקבלת ערך בוליאני כדי לקבוע אם קבוצת אנשי הקשר הזו היא קבוצת מערכת (לא ניתן למחוק אותה) או לא.

קבוצות מערכת הן קבוצות שהוגדרו מראש באנשי הקשר ב-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

הוצא משימוש. הפונקציה הזו הוצאה משימוש ואין להשתמש בה בסקריפטים חדשים.

הסרת איש הקשר מהקבוצה הזו

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

פרמטרים

שםסוגתיאור
contactContactאיש הקשר שרוצים להסיר מהקבוצה

חזרה

ContactGroup – קבוצת אנשי הקשר הזו

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

ראה גם


הוצא משימוש. הפונקציה הזו הוצאה משימוש ואין להשתמש בה בסקריפטים חדשים.

הגדרת השם של הקבוצה.

פרמטרים

שםסוגתיאור
nameStringהשם שרוצים להגדיר לקבוצה

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

הוצא משימוש. הפונקציה הזו הוצאה משימוש ואין להשתמש בה בסקריפטים חדשים.

הגדרת השם של קבוצת אנשי הקשר הזו.

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

פרמטרים

שםסוגתיאור
nameStringהשם החדש של קבוצת אנשי הקשר

חזרה

ContactGroup – קבוצת אנשי הקשר הזו

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

ראה גם