Class ContactGroup

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', '[e-mail]', ); 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	ตั้งชื่อกลุ่มรายชื่อติดต่อนี้

วิธีการที่เลิกใช้งาน

addContact(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	รายชื่อติดต่อที่จะเพิ่มลงในกลุ่ม

รีเทิร์น

ContactGroup — กลุ่มรายชื่อติดต่อนี้

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับอนุญาตด้วยขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

ดูเพิ่มเติม

• removeContact(contact)

---

deleteGroup()

เลิกใช้งานแล้ว ฟังก์ชันนี้เลิกใช้งานแล้วและไม่ควรนำมาใช้ในสคริปต์ใหม่

ลบกลุ่มรายชื่อติดต่อนี้

ลบกลุ่มที่ไม่ใช่ระบบเท่านั้น ไม่สามารถลบกลุ่มของระบบได้

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

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับอนุญาตด้วยขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

ดูเพิ่มเติม

• isSystemGroup()

---

getContacts()

เลิกใช้งานแล้ว ฟังก์ชันนี้เลิกใช้งานแล้วและไม่ควรนำมาใช้ในสคริปต์ใหม่

รับรายชื่อติดต่อทั้งหมดในกลุ่มรายชื่อติดต่อนี้

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

รีเทิร์น

Contact[] — รายชื่อติดต่อในกลุ่มนี้

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับอนุญาตด้วยขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

---

getGroupName()

เลิกใช้งานแล้ว ฟังก์ชันนี้เลิกใช้งานแล้วและไม่ควรนำมาใช้ในสคริปต์ใหม่

แสดงผลชื่อของกลุ่มนี้

รีเทิร์น

String — ชื่อของกลุ่มนี้

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับอนุญาตด้วยขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

---

getId()

เลิกใช้งานแล้ว ฟังก์ชันนี้เลิกใช้งานแล้วและไม่ควรนำมาใช้ในสคริปต์ใหม่

รับรหัสของกลุ่มรายชื่อติดต่อนี้

// 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 — รหัสของกลุ่มนี้

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับอนุญาตด้วยขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

---

getName()

เลิกใช้งานแล้ว ฟังก์ชันนี้เลิกใช้งานแล้วและไม่ควรนำมาใช้ในสคริปต์ใหม่

รับชื่อของกลุ่มรายชื่อติดต่อนี้

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

รีเทิร์น

String — ชื่อกลุ่มรายชื่อติดต่อนี้

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับอนุญาตด้วยขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

ดูเพิ่มเติม

• setName(name)

---

isSystemGroup()

เลิกใช้งานแล้ว ฟังก์ชันนี้เลิกใช้งานแล้วและไม่ควรนำมาใช้ในสคริปต์ใหม่

รับค่าบูลีนเพื่อระบุว่ากลุ่มรายชื่อติดต่อนี้เป็นกลุ่มของระบบ (ลบไม่ได้) หรือไม่

กลุ่มระบบคือชุดกลุ่มที่กำหนดไว้ล่วงหน้าใน Google Contacts เช่น "รายชื่อติดต่อของฉัน" "ครอบครัว" "เพื่อนร่วมงาน" เป็นต้น ชื่อของกลุ่มระบบมักจะมีคำว่า "กลุ่มระบบ"

// 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 — ระบุว่ากลุ่มรายชื่อติดต่อนี้เป็นกลุ่มของระบบหรือไม่

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับอนุญาตด้วยขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

• 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
const contacts = ContactsApp.getContactsByName('John Doe');
const group = ContactsApp.getContactGroup('Work Friends');
for (const i in contacts) {
  group.removeContact(contacts[i]);
}

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
contact	Contact	รายชื่อติดต่อที่จะนำออกจากกลุ่ม

รีเทิร์น

ContactGroup — กลุ่มรายชื่อติดต่อนี้

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับอนุญาตด้วยขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

ดูเพิ่มเติม

• addContact(contact)

---

setGroupName(name)

เลิกใช้งานแล้ว ฟังก์ชันนี้เลิกใช้งานแล้วและไม่ควรนำมาใช้ในสคริปต์ใหม่

ตั้งชื่อกลุ่มนี้

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
name	String	ชื่อที่จะตั้งให้กับกลุ่มนี้

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับอนุญาตด้วยขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

---

setName(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	ชื่อใหม่ของกลุ่มรายชื่อติดต่อ

รีเทิร์น

ContactGroup — กลุ่มรายชื่อติดต่อนี้

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับอนุญาตด้วยขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

ดูเพิ่มเติม

• getName()