Class ContactsApp

แอปรายชื่อติดต่อ

เลิกใช้งานแล้ว แต่ให้ใช้บริการขั้นสูงของ People API แทน

คลาสนี้ช่วยให้ผู้ใช้เข้าถึง Google Contacts ของตนเอง รวมถึงสร้าง นําออก และอัปเดตรายชื่อติดต่อที่แสดงอยู่ในนั้น

พร็อพเพอร์ตี้ประเภทคำอธิบาย
ExtendedFieldExtendedField
FieldField
GenderGender
MonthMonth
PriorityPriority
SensitivitySensitivity
วิธีการประเภทการแสดงผลรายละเอียดแบบย่อ
createContact(givenName, familyName, email)Contactสร้างรายชื่อติดต่อใหม่
createContactGroup(name)ContactGroupสร้างกลุ่มรายชื่อติดต่อที่มีชื่อที่ระบุ
// The code below creates a new contact group named "Work Friends"
const group = ContactsApp.createContactGroup('Work Friends');
deleteContact(contact)voidลบรายชื่อติดต่อ
deleteContactGroup(group)voidลบกลุ่มรายชื่อติดต่อ
// The code below creates deletes the contact group named "Work Friends"
const group = ContactsApp.getContactGroup('Work Friends');
ContactsApp.deleteContactGroup(group);
findByEmailAddress(email)Contactค้นหารายชื่อติดต่อที่มีอีเมลที่ระบุ
findContactGroup(name)ContactGroupค้นหากลุ่มรายชื่อติดต่อที่มีชื่อที่ระบุ
getAllContacts()Contact[]รับรายชื่อติดต่อทั้งหมดของผู้ใช้รายนี้
getContact(emailAddress)Contactรับรายชื่อติดต่อตามอีเมล
getContactById(id)Contactรับรายชื่อติดต่อที่มีรหัสนี้
getContactGroup(name)ContactGroupรับกลุ่มรายชื่อติดต่อที่มีชื่อที่ระบุ หรือแสดงผล Null หากไม่พบกลุ่มรายชื่อติดต่อดังกล่าว
getContactGroupById(id)ContactGroupรับกลุ่มรายชื่อติดต่อที่มีรหัสที่ระบุ หรือแสดงผล Null หากไม่พบกลุ่มรายชื่อติดต่อดังกล่าว
getContactGroups()ContactGroup[]รับรายการกลุ่มรายชื่อติดต่อทั้งหมดของผู้ใช้
getContacts()Contact[]รับรายชื่อติดต่อทั้งหมดของผู้ใช้
getContactsByAddress(query)Contact[]ดูรายชื่อติดต่อที่ตรงกับที่อยู่
getContactsByAddress(query, label)Contact[]รับรายชื่อติดต่อที่ตรงกับที่อยู่ โดยจำกัดเฉพาะบางช่อง
getContactsByAddress(query, label)Contact[]รับรายชื่อติดต่อที่ตรงกับที่อยู่ โดยจำกัดไว้ที่ป้ายกำกับที่อยู่ที่กำหนดเองที่ระบุ
getContactsByCompany(query)Contact[]ดูรายชื่อติดต่อที่ตรงกับช่องบริษัท
getContactsByCustomField(query, label)Contact[]รับรายชื่อติดต่อที่ตรงกับค่าที่ระบุในช่องที่กำหนดเอง
getContactsByDate(month, day, label)Contact[]รับรายชื่อติดต่อที่ตรงกับเดือนและวันที่ที่ระบุสำหรับช่องมาตรฐานที่เฉพาะเจาะจง
getContactsByDate(month, day, year, label)Contact[]รับรายชื่อติดต่อที่ตรงกับเดือน วัน และปีที่กำหนดสำหรับช่องมาตรฐานหนึ่งๆ
getContactsByDate(month, day, year, label)Contact[]รับรายชื่อติดต่อที่ตรงกับเดือน วัน และปีที่กำหนดสำหรับช่องที่กำหนดเองรายการหนึ่งๆ
getContactsByDate(month, day, label)Contact[]รับรายชื่อติดต่อที่ตรงกับเดือนและวันที่ที่ระบุสำหรับช่องที่กำหนดเองรายการใดรายการหนึ่ง
getContactsByEmailAddress(query)Contact[]ดูรายชื่อติดต่อที่ตรงกับอีเมล
getContactsByEmailAddress(query, label)Contact[]รับรายชื่อติดต่อที่ตรงกับอีเมล โดยจำกัดเฉพาะบางช่อง
getContactsByEmailAddress(query, label)Contact[]ดูรายชื่อติดต่อที่ตรงกับอีเมล โดยจำกัดเฉพาะป้ายกำกับอีเมลที่กำหนดเองที่ระบุ
getContactsByGroup(group)Contact[]รับรายชื่อติดต่อในกลุ่ม ContactGroup ที่ระบุ
getContactsByIM(query)Contact[]ดูรายชื่อติดต่อที่ตรงกับอีเมลสำหรับรับส่งข้อความทันที
getContactsByIM(query, label)Contact[]รับรายชื่อติดต่อที่ตรงกับอีเมลการรับส่งข้อความทันที โดยจำกัดเฉพาะบางช่อง
getContactsByIM(query, label)Contact[]รับรายชื่อติดต่อที่ตรงกับที่อยู่การรับส่งข้อความทันที โดยจำกัดไว้ที่ป้ายกำกับการรับส่งข้อความทันทีที่กำหนดเอง
getContactsByJobTitle(query)Contact[]รับรายชื่อติดต่อที่ตรงกับช่องตำแหน่งงาน
getContactsByName(query)Contact[]ดูรายชื่อติดต่อที่ตรงกับชื่อ
getContactsByName(query, label)Contact[]รับรายชื่อติดต่อที่ตรงกับชื่อ โดยจำกัดเฉพาะบางช่อง
getContactsByNotes(query)Contact[]รับรายชื่อติดต่อที่ตรงกับช่องโน้ต
getContactsByPhone(query)Contact[]ดูรายชื่อติดต่อที่ตรงกับหมายเลขโทรศัพท์
getContactsByPhone(query, label)Contact[]รับรายชื่อติดต่อที่ตรงกับหมายเลขโทรศัพท์ โดยจำกัดเฉพาะบางช่อง
getContactsByPhone(query, label)Contact[]รับรายชื่อติดต่อที่ตรงกับหมายเลขโทรศัพท์ โดยจำกัดเฉพาะป้ายกำกับหมายเลขโทรศัพท์ที่กำหนดเอง
getContactsByUrl(query)Contact[]ดูรายชื่อติดต่อที่ตรงกับ URL
getContactsByUrl(query, label)Contact[]รับรายชื่อติดต่อที่ตรงกับ URL ซึ่งจํากัดเฉพาะบางช่อง
getContactsByUrl(query, label)Contact[]รับรายชื่อติดต่อที่ตรงกับ URL โดยจำกัดเฉพาะป้ายกำกับ URL ที่กำหนดเองที่ระบุ

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

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

สร้างรายชื่อติดต่อใหม่

// The code below creates a new contact with the name "John Doe" and the email
// address "john.doe@example.com".
const contact = ContactsApp.createContact(
    'John',
    'Doe',
    'john.doe@example.com',
);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
givenNameStringชื่อจริงของผู้ติดต่อ
familyNameStringนามสกุลของผู้ติดต่อ
emailStringอีเมลของผู้ติดต่อ

รีเทิร์น

Contact — ออบเจ็กต์รายชื่อติดต่อที่สร้างขึ้นใหม่

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

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

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

ดูเพิ่มเติม


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

สร้างกลุ่มรายชื่อติดต่อที่มีชื่อที่ระบุ

// The code below creates a new contact group named "Work Friends"
const group = ContactsApp.createContactGroup('Work Friends');

พารามิเตอร์

ชื่อประเภทคำอธิบาย
nameStringชื่อกลุ่มผู้ติดต่อใหม่

รีเทิร์น

ContactGroup — กลุ่มรายชื่อติดต่อที่สร้างขึ้นใหม่

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

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

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

ดูเพิ่มเติม


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

ลบรายชื่อติดต่อ

// The code below retrieves a contact with the email address
// "john.doe@example.com" and then deletes that contact.
const contact = ContactsApp.getContact('john.doe@example.com');
ContactsApp.deleteContact(contact);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
contactContactรายชื่อติดต่อที่จะลบ

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

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

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

ดูเพิ่มเติม


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

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

// The code below creates deletes the contact group named "Work Friends"
const group = ContactsApp.getContactGroup('Work Friends');
ContactsApp.deleteContactGroup(group);

พารามิเตอร์

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

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

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

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

ดูเพิ่มเติม


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

ค้นหารายชื่อติดต่อที่มีอีเมลที่ระบุ

พารามิเตอร์

ชื่อประเภทคำอธิบาย
emailStringอีเมลของรายชื่อติดต่อที่จะค้นหา

รีเทิร์น

Contact — รายชื่อติดต่อที่มีอีเมลนั้น

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

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

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

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

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

พารามิเตอร์

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

รีเทิร์น

ContactGroup — กลุ่มรายชื่อติดต่อที่ตรงกับชื่อที่ระบุ

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

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

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

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

รับรายชื่อติดต่อทั้งหมดของผู้ใช้รายนี้

รีเทิร์น

Contact[] — รายชื่อติดต่อทั้งหมดของผู้ใช้รายนี้

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

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

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

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

รับรายชื่อติดต่อตามอีเมล

หากรายชื่อติดต่อหลายรายใช้อีเมลเดียวกัน วิธีการนี้จะแสดงรายชื่อติดต่อที่ทําเครื่องหมายอีเมลเป็นอีเมลหลักไว้ หากไม่มีรายชื่อติดต่อใดทําเครื่องหมายอีเมลเป็นอีเมลหลักไว้ หรือมีรายชื่อติดต่อหลายรายทําเครื่องหมายอีเมลเป็นอีเมลหลักไว้ ระบบจะแสดงผลลัพธ์แรกตามลําดับรายชื่อติดต่อที่จัดเรียง

// The code below retrieves a contact with the email address
// "john.doe@example.com".
const contact = ContactsApp.getContact('john.doe@example.com');

พารามิเตอร์

ชื่อประเภทคำอธิบาย
emailAddressStringอีเมลของผู้ติดต่อ

รีเทิร์น

Contact — รายชื่อติดต่อที่มีอีเมลนั้น

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

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

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

ดูเพิ่มเติม


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

รับรายชื่อติดต่อที่มีรหัสนี้

// The code below retrieves the contact with the id
// "http://www.google.com/m8/feeds/contacts/john.doe%40example.com/base/7c86afde08d34ca5"
const id =
    'http://www.google.com/m8/feeds/contacts/john.doe%40example.com/base/7c86afde08d34c';
const contact = ContactsApp.getContactById(id);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
idStringรหัสของรายชื่อติดต่อที่จะดึงข้อมูล

รีเทิร์น

Contact — รายชื่อติดต่อที่ตรงกันหรือ Null

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

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

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

ดูเพิ่มเติม


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

รับกลุ่มรายชื่อติดต่อที่มีชื่อที่ระบุ หรือแสดงผล Null หากไม่พบกลุ่มรายชื่อติดต่อดังกล่าว

// The code below returns the contact group with the name "Work Friends"
const group = ContactsApp.getContactGroup('Work Friends');

พารามิเตอร์

ชื่อประเภทคำอธิบาย
nameStringชื่อของกลุ่มรายชื่อติดต่อที่จะจับคู่

รีเทิร์น

ContactGroup — กลุ่มรายชื่อติดต่อที่ตรงกัน หรือ Null หากไม่พบกลุ่มรายชื่อติดต่อที่ตรงกัน

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

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

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

ดูเพิ่มเติม


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

รับกลุ่มรายชื่อติดต่อที่มีรหัสที่ระบุ หรือแสดงผล Null หากไม่พบกลุ่มรายชื่อติดต่อดังกล่าว

// The code below returns the contact group with the id
// "http://www.google.com/m8/feeds/groups/john.doe%40example.com/base/54eefbb093fdecb"
const id =
    'http://www.google.com/m8/feeds/groups/john.doe%40example.com/base/54eefbb093fdecb';
const group = ContactsApp.getContactGroupById(id);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
idStringรหัสของกลุ่มรายชื่อติดต่อที่จะจับคู่

รีเทิร์น

ContactGroup — กลุ่มรายชื่อติดต่อที่ตรงกัน หรือ Null หากไม่พบกลุ่มรายชื่อติดต่อที่ตรงกัน

ดูเพิ่มเติม


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

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

ผู้ใช้อาจมีรายชื่อติดต่อและรายชื่อกลุ่มรายชื่อติดต่อด้วย กลุ่มรายชื่อติดต่อแต่ละกลุ่มจะมีรายชื่อติดต่อได้ เมธอดนี้จะแสดงรายการกลุ่มรายชื่อติดต่อทั้งหมด

// The retrieves all the contract groups for the user and then logs the group
// name of each contact group.
const groups = ContactsApp.getContactGroups();
for (let i = 0; i < groups.length; i++) {
  Logger.log(groups[i].getName());
}

รีเทิร์น

ContactGroup[] — อาร์เรย์ของกลุ่มรายชื่อติดต่อของผู้ใช้

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

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

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

ดูเพิ่มเติม


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

รับรายชื่อติดต่อทั้งหมดของผู้ใช้

// The code below will retrieve all the user's contacts
const contacts = ContactsApp.getContacts();

รีเทิร์น

Contact[] — อาร์เรย์ของรายชื่อติดต่อทั้งหมดของผู้ใช้

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

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

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

ดูเพิ่มเติม


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

ดูรายชื่อติดต่อที่ตรงกับที่อยู่

// The code below returns an array of contacts where the contact's address
// contains "San Francisco'.
const contacts = ContactsApp.getContactsByAddress('San Francisco');

พารามิเตอร์

ชื่อประเภทคำอธิบาย
queryStringสตริงที่จะค้นหาในที่อยู่ของรายชื่อติดต่อ

รีเทิร์น

Contact[] — อาร์เรย์ของรายชื่อติดต่อที่ตรงกัน

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

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

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

ดูเพิ่มเติม


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

รับรายชื่อติดต่อที่ตรงกับที่อยู่ โดยจำกัดเฉพาะบางช่อง

// The code below returns an array of contacts where the contact's address
// contains "San Francisco" in the Home address field.
const contacts = ContactsApp.getContactsByAddress(
    'San Francisco',
    ContactsApp.Field.HOME_ADDRESS,
);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
queryStringสตริงที่จะค้นหาในที่อยู่ของรายชื่อติดต่อ
labelFieldฟิลด์ที่จะค้นหา

รีเทิร์น

Contact[] — อาร์เรย์ของรายชื่อติดต่อที่ตรงกัน

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

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

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

ดูเพิ่มเติม


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

รับรายชื่อติดต่อที่ตรงกับที่อยู่ โดยจำกัดไว้ที่ป้ายกำกับที่อยู่ที่กำหนดเองที่ระบุ

// The code below returns an array of contacts where the contact's address
// contains "San Francisco" in a custom address label (created by the user)
// called "vacation".
const contacts = ContactsApp.getContactsByAddress('San Francisco', 'vacation');

พารามิเตอร์

ชื่อประเภทคำอธิบาย
queryStringสตริงที่จะค้นหาในที่อยู่ของรายชื่อติดต่อที่มีป้ายกำกับที่อยู่ที่กำหนดเองที่ระบุ
labelStringป้ายกำกับที่อยู่ที่กำหนดเองที่จะค้นหาภายใน

รีเทิร์น

Contact[] — อาร์เรย์ของรายชื่อติดต่อที่ตรงกัน

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

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

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

ดูเพิ่มเติม


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

ดูรายชื่อติดต่อที่ตรงกับช่องบริษัท

// The code below returns an array of contacts where the contact's company field
// contains "Google".
const contacts = ContactsApp.getContactsByCompany('Google');

พารามิเตอร์

ชื่อประเภทคำอธิบาย
queryStringสตริงที่จะค้นหาในช่องบริษัทของผู้ติดต่อ

รีเทิร์น

Contact[] — อาร์เรย์ของรายชื่อติดต่อที่ตรงกัน

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

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

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

ดูเพิ่มเติม


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

รับรายชื่อติดต่อที่ตรงกับค่าที่ระบุในช่องที่กำหนดเอง

ฟิลด์ที่กำหนดเองสามารถระบุด้วยสตริงหรือเป็นค่าใดค่าหนึ่งของ ContactsApp.ExtendedField

// The code below returns an array of contacts where the contact's custom field
// named "Favorite Sport" contains "tennis".
const contacts = ContactsApp.getContactsByCustomField(
    'tennis',
    'Favorite Sport',
);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
queryObjectสตริงที่จะค้นหาในช่องที่กำหนดเองของรายชื่อติดต่อ
labelExtendedFieldช่องที่กำหนดเองที่จะค้นหา

รีเทิร์น

Contact[] — อาร์เรย์ของรายชื่อติดต่อที่ตรงกัน

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

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

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

ดูเพิ่มเติม


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

รับรายชื่อติดต่อที่ตรงกับเดือนและวันที่ที่ระบุสำหรับช่องมาตรฐานที่เฉพาะเจาะจง

// The code below returns an array of contacts where the contact's "Birthday"
// field contains April for the month and 19 for the day.
const contacts = ContactsApp.getContactsByDate(
    ContactsApp.Month.APRIL,
    19,
    ContactsApp.Field.BIRTHDAY,
);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
monthMonthเดือนที่จะจับคู่ ซึ่งเป็นหนึ่งในค่าจาก ContactsApp.Month
dayIntegerวันที่ที่จะจับคู่
labelFieldฟิลด์ที่จะค้นหาจาก ContactsApp.Field

รีเทิร์น

Contact[] — อาร์เรย์ของรายชื่อติดต่อที่ตรงกัน

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

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

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

ดูเพิ่มเติม


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

รับรายชื่อติดต่อที่ตรงกับเดือน วัน และปีที่กำหนดสำหรับช่องมาตรฐานหนึ่งๆ

// The code below returns an array of contacts where the contact's "Birthday"
// field contains April for the month, 19 for the day, and 1950 for the year.
const contacts = ContactsApp.getContactsByDate(
    ContactsApp.Month.APRIL,
    19,
    1950,
    ContactsApp.Field.BIRTHDAY,
);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
monthMonthเดือนที่จะจับคู่ ซึ่งเป็นหนึ่งในค่าจาก ContactsApp.Month
dayIntegerวันที่ที่จะจับคู่
yearIntegerปีที่จะจับคู่ (อาจเป็นค่า Null)
labelFieldฟิลด์ที่จะค้นหาจาก ContactsApp.Field

รีเทิร์น

Contact[] — อาร์เรย์ของรายชื่อติดต่อที่ตรงกัน

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

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

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

ดูเพิ่มเติม


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

รับรายชื่อติดต่อที่ตรงกับเดือน วัน และปีที่กำหนดสำหรับช่องที่กำหนดเองรายการหนึ่งๆ

// The code below returns an array of contacts where the contact's custom "Start
// Date" field contains April for the month, 19 for the day, and 2011 for the
// year.
const contacts = ContactsApp.getContactsByDate(
    ContactsApp.Month.APRIL,
    19,
    2011,
    'Start Date',
);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
monthMonthเดือนที่จะจับคู่ ซึ่งเป็นหนึ่งในค่าจาก ContactsApp.Month
dayIntegerวันที่ที่จะจับคู่
yearIntegerปีที่จะจับคู่ (อาจเป็นค่า Null)
labelStringช่องที่กำหนดเองที่จะค้นหา

รีเทิร์น

Contact[] — อาร์เรย์ของรายชื่อติดต่อที่ตรงกัน

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

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

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

ดูเพิ่มเติม


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

รับรายชื่อติดต่อที่ตรงกับเดือนและวันที่ที่ระบุสำหรับช่องที่กำหนดเองรายการใดรายการหนึ่ง

// The code below returns an array of contacts where the contact's custom "Start
// Date" field contains April for the month and 19 for the day.
const contacts = ContactsApp.getContactsByDate(
    ContactsApp.Month.APRIL,
    19,
    'Start Date',
);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
monthMonthเดือนที่จะจับคู่ ซึ่งเป็นหนึ่งในค่าจาก ContactsApp.Month
dayIntegerวันที่ที่จะจับคู่
labelStringช่องที่กำหนดเองที่จะค้นหา

รีเทิร์น

Contact[] — อาร์เรย์ของรายชื่อติดต่อที่ตรงกัน

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

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

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

ดูเพิ่มเติม


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

ดูรายชื่อติดต่อที่ตรงกับอีเมล

// The code below returns an array of contacts where the contact's email address
// contains "john.doe@example.com'.
const contacts = ContactsApp.getContactsByEmailAddress('john.doe@example.com');

พารามิเตอร์

ชื่อประเภทคำอธิบาย
queryStringสตริงที่จะค้นหาในอีเมลของรายชื่อติดต่อ

รีเทิร์น

Contact[] — อาร์เรย์ของรายชื่อติดต่อที่ตรงกัน

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

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

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

ดูเพิ่มเติม


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

รับรายชื่อติดต่อที่ตรงกับอีเมล โดยจำกัดเฉพาะบางช่อง

// The code below returns an array of contacts where the contact's email address
// contains "john.doe@example.com" in the Home email field.
const contacts = ContactsApp.getContactsByEmailAddress(
    'john.doe@example.com',
    ContactsApp.Field.HOME_EMAIL,
);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
queryStringสตริงที่จะค้นหาในอีเมลของรายชื่อติดต่อ
labelFieldฟิลด์ที่จะค้นหา

รีเทิร์น

Contact[] — อาร์เรย์ของรายชื่อติดต่อที่ตรงกัน

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

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

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

ดูเพิ่มเติม


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

ดูรายชื่อติดต่อที่ตรงกับอีเมล โดยจำกัดเฉพาะป้ายกำกับอีเมลที่กำหนดเองที่ระบุ

// The code below returns an array of contacts where the contact's email address
// contains "john.doe@example.com" in a custom email address label (created by
// the user) called "alternate".
const contacts = ContactsApp.getContactsByEmailAddress(
    'john.doe@example.com',
    'alternate',
);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
queryStringสตริงที่จะค้นหาในอีเมลสำหรับติดต่อซึ่งมีป้ายกำกับอีเมลที่กำหนดเองที่ระบุ
labelStringป้ายกํากับอีเมลที่กําหนดเองที่จะค้นหาภายใน

รีเทิร์น

Contact[] — อาร์เรย์ของรายชื่อติดต่อที่ตรงกัน

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

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

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

ดูเพิ่มเติม


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

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

// The code below returns an array of contacts in the ContactGroup with the name
// "Work Friends".
const group = ContactsApp.getContactGroup('Work Friends');
const contacts = ContactsApp.getContactsByGroup(group);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
groupContactGroupกลุ่มรายชื่อติดต่อ

รีเทิร์น

Contact[] — อาร์เรย์ของรายชื่อติดต่อในกลุ่มที่ระบุ

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

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

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

ดูเพิ่มเติม


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

ดูรายชื่อติดต่อที่ตรงกับอีเมลสำหรับรับส่งข้อความทันที

// The code below returns an array of contacts where the contact's instant
// messaging address contains "ChatWithJohnDoe" in any instant messaging field.
const contacts = ContactsApp.getContactsByIM('ChatWithJohnDoe');

พารามิเตอร์

ชื่อประเภทคำอธิบาย
queryStringสตริงที่จะค้นหาในที่อยู่การรับส่งข้อความทันทีของผู้ติดต่อ

รีเทิร์น

Contact[] — อาร์เรย์ของรายชื่อติดต่อที่ตรงกัน

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

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

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

ดูเพิ่มเติม


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

รับรายชื่อติดต่อที่ตรงกับอีเมลการรับส่งข้อความทันที โดยจำกัดเฉพาะบางช่อง

// The code below returns an array of contacts where the contact's instant
// messaging address contains "ChatWithJohnDoe" in the AIM instant messaging
// field.
const contacts = ContactsApp.getContactsByIM(
    'ChatWithJohnDoe',
    ContactsApp.Field.AIM,
);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
queryStringสตริงที่จะค้นหาในที่อยู่การรับส่งข้อความทันทีของผู้ติดต่อ
labelFieldฟิลด์ที่จะค้นหา

รีเทิร์น

Contact[] — อาร์เรย์ของรายชื่อติดต่อที่ตรงกัน

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

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

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

ดูเพิ่มเติม


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

รับรายชื่อติดต่อที่ตรงกับที่อยู่การรับส่งข้อความทันที โดยจำกัดไว้ที่ป้ายกำกับการรับส่งข้อความทันทีที่กำหนดเอง

// The code below returns an array of contacts where the contact's instant
// messaging address contains "ChatWithJohnDoe" in a custom instant messaging
// label (created by the user) called "eBuddy".
const contacts = ContactsApp.getContactsByIM('ChatWithJohnDoe', 'eBuddy');

พารามิเตอร์

ชื่อประเภทคำอธิบาย
queryStringสตริงที่จะค้นหาในอีเมลสำหรับรับส่งข้อความทันทีของผู้ติดต่อซึ่งมีป้ายกำกับการรับส่งข้อความทันทีที่กำหนดเอง
labelStringป้ายกำกับการรับส่งข้อความโต้ตอบแบบทันทีที่กำหนดเองเพื่อค้นหา

รีเทิร์น

Contact[] — อาร์เรย์ของรายชื่อติดต่อที่ตรงกัน

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

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

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

ดูเพิ่มเติม


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

รับรายชื่อติดต่อที่ตรงกับช่องตำแหน่งงาน

// The code below returns an array of contacts where the contact's job title
// field contains "Product Manager".
const contacts = ContactsApp.getContactsByJobTitle('Product Manager');

พารามิเตอร์

ชื่อประเภทคำอธิบาย
queryStringสตริงที่จะค้นหาในช่องตำแหน่งงานของผู้ติดต่อ

รีเทิร์น

Contact[] — อาร์เรย์ของรายชื่อติดต่อที่ตรงกัน

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

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

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

ดูเพิ่มเติม


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

ดูรายชื่อติดต่อที่ตรงกับชื่อ

// The code below returns an array of contacts where the contact name contains
// "John"
const contacts = ContactsApp.getContactsByName('John');

พารามิเตอร์

ชื่อประเภทคำอธิบาย
queryStringสตริงที่จะค้นหาในชื่อรายชื่อติดต่อ

รีเทิร์น

Contact[] — อาร์เรย์ของรายชื่อติดต่อที่ตรงกัน

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

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

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

ดูเพิ่มเติม


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

รับรายชื่อติดต่อที่ตรงกับชื่อ โดยจำกัดเฉพาะบางช่อง

// The code below returns an array of contacts where the contact name contains
// "John" in the Given Name field.
const contacts = ContactsApp.getContactsByName(
    'John',
    ContactsApp.Field.GIVEN_NAME,
);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
queryStringสตริงที่จะค้นหาในชื่อรายชื่อติดต่อ
labelFieldฟิลด์ที่จะค้นหา

รีเทิร์น

Contact[] — อาร์เรย์ของรายชื่อติดต่อที่ตรงกัน

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

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

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

ดูเพิ่มเติม


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

รับรายชื่อติดต่อที่ตรงกับช่องโน้ต

// The code below returns an array of contacts where the contact's notes field
// contains "sent birthday card".
const contacts = ContactsApp.getContactsByNotes('sent birthday card');

พารามิเตอร์

ชื่อประเภทคำอธิบาย
queryStringสตริงที่จะค้นหาในช่องบันทึกของรายชื่อติดต่อ

รีเทิร์น

Contact[] — อาร์เรย์ของรายชื่อติดต่อที่ตรงกัน

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

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

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

ดูเพิ่มเติม


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

ดูรายชื่อติดต่อที่ตรงกับหมายเลขโทรศัพท์

วิธีนี้จะขยายหมายเลขโทรศัพท์ที่มีตัวอักษร ดังนั้นหากคุณค้นหา "212-555-CODE" และคุณมี "212-555-2633" ในรายชื่อติดต่อหรือในทางกลับกัน วิธีนี้จะค้นหารายชื่อติดต่อที่เหมาะสม

// The code below returns an array of contacts where the contact's phone number
// contains "212-555-1234' in any phone number field.
const contacts = ContactsApp.getContactsByPhone('212-555-1234');

พารามิเตอร์

ชื่อประเภทคำอธิบาย
queryStringสตริงที่จะค้นหาในหมายเลขโทรศัพท์ของผู้ติดต่อ

รีเทิร์น

Contact[] — อาร์เรย์ของรายชื่อติดต่อที่ตรงกัน

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

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

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

ดูเพิ่มเติม


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

รับรายชื่อติดต่อที่ตรงกับหมายเลขโทรศัพท์ โดยจำกัดเฉพาะบางช่อง

วิธีนี้จะขยายหมายเลขโทรศัพท์ที่มีตัวอักษร ดังนั้นหากคุณค้นหา "212-555-CODE" และคุณมี "212-555-2633" ในรายชื่อติดต่อหรือในทางกลับกัน วิธีนี้จะค้นหารายชื่อติดต่อที่เหมาะสม

// The code below returns an array of contacts where the contact's phone number
// contains "212-555-1234" in the Home phone number field.
const contacts = ContactsApp.getContactsByPhone(
    '212-555-1234',
    ContactsApp.Field.HOME_PHONE,
);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
queryStringสตริงที่จะค้นหาในหมายเลขโทรศัพท์ของผู้ติดต่อ
labelFieldฟิลด์ที่จะค้นหา

รีเทิร์น

Contact[] — อาร์เรย์ของรายชื่อติดต่อที่ตรงกัน

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

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

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

ดูเพิ่มเติม


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

รับรายชื่อติดต่อที่ตรงกับหมายเลขโทรศัพท์ โดยจำกัดเฉพาะป้ายกำกับหมายเลขโทรศัพท์ที่กำหนดเอง

วิธีนี้จะขยายหมายเลขโทรศัพท์ที่มีตัวอักษร ดังนั้นหากคุณค้นหา "212-555-CODE" และคุณมี "212-555-2633" ในรายชื่อติดต่อหรือในทางกลับกัน วิธีนี้จะค้นหารายชื่อติดต่อที่เหมาะสม

// The code below returns an array of contacts where the contact's phone number
// contains "212-555-1234" in a custom phone number label (created by the user)
// called "alternate".
const contacts = ContactsApp.getContactsByPhone('212-555-1234', 'alternate');

พารามิเตอร์

ชื่อประเภทคำอธิบาย
queryStringสตริงที่จะค้นหาในหมายเลขโทรศัพท์ของผู้ติดต่อที่มีป้ายกำกับหมายเลขโทรศัพท์ที่กำหนดเอง
labelStringป้ายกำกับหมายเลขโทรศัพท์ที่กำหนดเองที่จะค้นหาภายใน

รีเทิร์น

Contact[] — อาร์เรย์ของรายชื่อติดต่อที่ตรงกัน

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

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

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

ดูเพิ่มเติม


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

ดูรายชื่อติดต่อที่ตรงกับ URL

// The code below returns an array of contacts where the contact's URL contains
// "www.example.com' in any URL field.
const contacts = ContactsApp.getContactsByUrl('www.example.com');

พารามิเตอร์

ชื่อประเภทคำอธิบาย
queryStringสตริงที่จะค้นหาใน URL ของรายชื่อติดต่อ

รีเทิร์น

Contact[] — อาร์เรย์ของรายชื่อติดต่อที่ตรงกัน

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

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

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

ดูเพิ่มเติม


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

รับรายชื่อติดต่อที่ตรงกับ URL ซึ่งจํากัดเฉพาะบางช่อง

// The code below returns an array of contacts where the contact's URL contains
// "www.example.com" in the Work URL field.
const contacts = ContactsApp.getContactsByUrl(
    'www.example.com',
    ContactsApp.Field.WORK_WEBSITE,
);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
queryStringสตริงที่จะค้นหาใน URL ของรายชื่อติดต่อ
labelFieldฟิลด์ที่จะค้นหา

รีเทิร์น

Contact[] — อาร์เรย์ของรายชื่อติดต่อที่ตรงกัน

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

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

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

ดูเพิ่มเติม


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

รับรายชื่อติดต่อที่ตรงกับ URL โดยจำกัดเฉพาะป้ายกำกับ URL ที่กำหนดเองที่ระบุ

// The code below returns an array of contacts where the contact's URL contains
// "www.example.com" in a custom URL label (created by the user) called
// "alternate work".
const contacts = ContactsApp.getContactsByUrl(
    'www.example.com',
    'alternate work',
);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
queryStringสตริงที่จะค้นหาใน URL ของรายชื่อติดต่อที่มีป้ายกํากับ URL ที่กําหนดเอง
labelStringป้ายกํากับ URL ที่กําหนดเองที่จะค้นหา

รีเทิร์น

Contact[] — อาร์เรย์ของรายชื่อติดต่อที่ตรงกัน

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

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

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

ดูเพิ่มเติม