Class ContactsApp

برنامه مخاطبین

منسوخ شده است. در عوض، از سرویس پیشرفته People API استفاده کنید

این کلاس به کاربران امکان می دهد به Google Contacts خود دسترسی داشته باشند و مخاطبین فهرست شده در آن را ایجاد، حذف و به روز کنند.

اموال تایپ کنید توضیحات
ExtendedField ExtendedField
Field Field
Gender Gender
Month Month
Priority Priority
Sensitivity Sensitivity
روش نوع برگشت شرح مختصر
createContact(givenName, familyName, email) Contact یک مخاطب جدید ایجاد می کند.
createContactGroup(name) ContactGroup یک گروه تماس با نام داده شده ایجاد می کند
deleteContact(contact) void مخاطب را حذف می کند.
deleteContactGroup(group) void گروه تماس را حذف می کند
findByEmailAddress(email) Contact مخاطبی را با آدرس ایمیل داده شده پیدا می کند.
findContactGroup(name) ContactGroup یک گروه تماس با نام داده شده را پیدا می کند.
getAllContacts() Contact[] تمام مخاطبین متعلق به این کاربر را دریافت کنید.
getContact(emailAddress) Contact مخاطبی را از طریق آدرس ایمیل دریافت می کند.
getContactById(id) Contact تماس را با این شناسه دریافت می کند.
getContactGroup(name) ContactGroup یک گروه تماس با نام داده شده دریافت می کند، یا اگر چنین گروه مخاطبی پیدا نشد، آن را باطل می کند.
getContactGroupById(id) ContactGroup یک گروه تماس با شناسه داده شده دریافت می کند، یا اگر چنین گروه تماسی پیدا نشد، آن را باطل می کند.
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[] مخاطبین را در یک گروه تماس خاص دریافت کنید.
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".
var contact = ContactsApp.createContact('John', 'Doe', 'john.doe@example.com');

پارامترها

نام تایپ کنید توضیحات
givenName String نام اول مخاطب
familyName String نام خانوادگی مخاطب
email String آدرس ایمیل مخاطب

بازگشت

Contact - شیء تماس تازه ایجاد شده

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

همچنین ببینید

منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.

یک گروه تماس با نام داده شده ایجاد می کند

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

پارامترها

نام تایپ کنید توضیحات
name String نام گروه تماس جدید

بازگشت

ContactGroup - گروه تماس تازه ایجاد شده

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • 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.
var contact = ContactsApp.getContact('john.doe@example.com');
ContactsApp.deleteContact(contact);

پارامترها

نام تایپ کنید توضیحات
contact Contact مخاطبی که باید حذف شود

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

همچنین ببینید

منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.

گروه تماس را حذف می کند

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

پارامترها

نام تایپ کنید توضیحات
group ContactGroup گروه تماس برای حذف

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

همچنین ببینید

منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.

مخاطبی را با آدرس ایمیل داده شده پیدا می کند.

پارامترها

نام تایپ کنید توضیحات
email String آدرس ایمیل مخاطبی که باید پیدا شود

بازگشت

Contact - مخاطبی که حاوی آن آدرس ایمیل است

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.

یک گروه تماس با نام داده شده را پیدا می کند.

پارامترها

نام تایپ کنید توضیحات
name String نام گروه تماس برای پیدا کردن

بازگشت

ContactGroup - گروه مخاطبی که با نام داده شده مطابقت دارد

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.

تمام مخاطبین متعلق به این کاربر را دریافت کنید.

بازگشت

Contact[] - همه مخاطبین برای این کاربر

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.

مخاطبی را از طریق آدرس ایمیل دریافت می کند.

اگر چندین مخاطب آدرس ایمیل یکسانی را به اشتراک بگذارند، این روش به نفع مخاطبینی است که آدرس ایمیل را به عنوان اصلی علامت‌گذاری کرده‌اند. اگر هیچ یک از مخاطبین آدرس ایمیل را به‌عنوان اصلی علامت‌گذاری نکرده باشند یا چندین مخاطب، آدرس ایمیل را به‌عنوان اصلی علامت‌گذاری کرده باشند، اولین نتیجه را به ترتیب مخاطبین مرتب شده برمی‌گرداند.

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

پارامترها

نام تایپ کنید توضیحات
emailAddress String آدرس ایمیل مخاطب

بازگشت

Contact - مخاطبی که حاوی آن آدرس ایمیل است

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • 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"
var id = 'http://www.google.com/m8/feeds/contacts/john.doe%40example.com/base/7c86afde08d34c';
var contact = ContactApp.getContactById(id);

پارامترها

نام تایپ کنید توضیحات
id String شناسه مخاطب برای بازیابی

بازگشت

Contact - مخاطب منطبق یا تهی

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

همچنین ببینید

منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.

یک گروه تماس با نام داده شده دریافت می کند، یا اگر چنین گروه مخاطبی پیدا نشد، آن را باطل می کند.

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

پارامترها

نام تایپ کنید توضیحات
name String نام گروه تماس برای مطابقت

بازگشت

ContactGroup - گروه مخاطب منطبق یا اگر گروه مخاطب منطبقی یافت نشد، صفر است

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

همچنین ببینید

منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.

یک گروه تماس با شناسه داده شده دریافت می کند، یا اگر چنین گروه تماسی پیدا نشد، آن را باطل می کند.

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

پارامترها

نام تایپ کنید توضیحات
id String شناسه گروه تماس برای مطابقت

بازگشت

ContactGroup - گروه مخاطب منطبق یا اگر گروه مخاطب منطبقی یافت نشد، صفر است

همچنین ببینید

منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.

لیست کامل گروه های تماس کاربر را دریافت می کند.

یک کاربر می‌تواند فهرستی از مخاطبین و احتمالاً فهرستی از گروه‌های تماس نیز داشته باشد. هر گروه تماس می تواند حاوی مخاطبین باشد. این روش لیستی از تمام گروه های تماس را برمی گرداند.

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

بازگشت

ContactGroup[] - آرایه ای از گروه های تماس کاربر

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

همچنین ببینید

منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.

تمام مخاطبین کاربر را دریافت می کند. 

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

بازگشت

Contact[] - آرایه ای از تمام مخاطبین کاربر

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

همچنین ببینید

منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.

دریافت مخاطبین مطابق با یک آدرس. 

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

پارامترها

نام تایپ کنید توضیحات
query String رشته مورد جستجو در آدرس مخاطبین

بازگشت

Contact[] - آرایه ای از مخاطبین منطبق

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • 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.
var contacts = ContactsApp.getContactsByAddress('San Francisco',
                                                ContactsApp.Field.HOME_ADDRESS);

پارامترها

نام تایپ کنید توضیحات
query String رشته مورد جستجو در آدرس مخاطبین
label Field فیلدی برای جستجو

بازگشت

Contact[] - آرایه ای از مخاطبین منطبق

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • 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".
var contacts = ContactsApp.getContactsByAddress('San Francisco', 'vacation');

پارامترها

نام تایپ کنید توضیحات
query String رشته مورد جستجو در آدرس های مخاطب با برچسب آدرس سفارشی مشخص شده
label String برچسب آدرس سفارشی برای جستجو در داخل

بازگشت

Contact[] - آرایه ای از مخاطبین منطبق

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

همچنین ببینید

منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.

دریافت مخاطبین مطابق با زمینه شرکت. 

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

پارامترها

نام تایپ کنید توضیحات
query String رشته مورد جستجو در قسمت شرکت مخاطبین

بازگشت

Contact[] - آرایه ای از مخاطبین منطبق

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • 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".
var contacts = ContactsApp.getContactsByCustomField('tennis', 'Favorite Sport');

پارامترها

نام تایپ کنید توضیحات
query Object رشته مورد جستجو در قسمت سفارشی مخاطب
label ExtendedField فیلد سفارشی برای جستجو در آن

بازگشت

Contact[] - آرایه ای از مخاطبین منطبق

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • 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.
var contacts = ContactsApp.getContactsByDate(ContactsApp.Month.APRIL, 19,
                                              ContactsApp.Field.BIRTHDAY);

پارامترها

نام تایپ کنید توضیحات
month Month ماه برای مطابقت، به عنوان یکی از مقادیر از ContactsApp.Month
day Integer روز مطابقت
label Field فیلد برای جستجو در آن، از ContactsApp.Field

بازگشت

Contact[] - آرایه ای از مخاطبین منطبق

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • 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.
var contacts = ContactsApp.getContactsByDate(ContactsApp.Month.APRIL, 19, 1950,
                                             ContactsApp.Field.BIRTHDAY);

پارامترها

نام تایپ کنید توضیحات
month Month ماه برای مطابقت، به عنوان یکی از مقادیر از ContactsApp.Month
day Integer روز مطابقت
year Integer سالی که باید مطابقت داشته باشد، می تواند تهی باشد
label Field فیلد برای جستجو در آن، از ContactsApp.Field

بازگشت

Contact[] - آرایه ای از مخاطبین منطبق

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • 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.
var contacts = ContactsApp.getContactsByDate(ContactsApp.Month.APRIL, 19, 2011, 'Start Date');

پارامترها

نام تایپ کنید توضیحات
month Month ماه برای مطابقت، به عنوان یکی از مقادیر از ContactsApp.Month
day Integer روز مطابقت
year Integer سالی که باید مطابقت داشته باشد، می تواند تهی باشد
label String فیلد سفارشی برای جستجو در آن

بازگشت

Contact[] - آرایه ای از مخاطبین منطبق

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • 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.
var contacts = ContactsApp.getContactsByDate(ContactsApp.Month.APRIL, 19, 'Start Date');

پارامترها

نام تایپ کنید توضیحات
month Month ماه برای مطابقت، به عنوان یکی از مقادیر از ContactsApp.Month
day Integer روز مطابقت
label String فیلد سفارشی برای جستجو در آن

بازگشت

Contact[] - آرایه ای از مخاطبین منطبق

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • 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'.
var contacts = ContactsApp.getContactsByEmailAddress('john.doe@example.com');

پارامترها

نام تایپ کنید توضیحات
query String رشته مورد جستجو در آدرس های ایمیل تماس

بازگشت

Contact[] - آرایه ای از مخاطبین منطبق

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • 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.
var contacts = ContactsApp.getContactsByEmailAddress('john.doe@example.com',
                                                     ContactsApp.Field.HOME_EMAIL);

پارامترها

نام تایپ کنید توضیحات
query String رشته مورد جستجو در آدرس های ایمیل تماس
label Field فیلدی برای جستجو

بازگشت

Contact[] - آرایه ای از مخاطبین منطبق

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • 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".
var contacts = ContactsApp.getContactsByEmailAddress('john.doe@example.com', 'alternate');

پارامترها

نام تایپ کنید توضیحات
query String رشته مورد جستجو در آدرس های ایمیل مخاطب با برچسب آدرس ایمیل سفارشی مشخص شده
label String برچسب آدرس ایمیل سفارشی برای جستجو در داخل

بازگشت

Contact[] - آرایه ای از مخاطبین منطبق

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

همچنین ببینید

منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.

مخاطبین را در یک گروه تماس خاص دریافت کنید. 

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

پارامترها

نام تایپ کنید توضیحات
group ContactGroup گروه مخاطبین

بازگشت

Contact[] - آرایه ای از مخاطبین در گروه داده شده

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • 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.
var contacts = ContactsApp.getContactsByIM('ChatWithJohnDoe');

پارامترها

نام تایپ کنید توضیحات
query String رشته مورد جستجو در آدرس های پیام فوری مخاطبین

بازگشت

Contact[] - آرایه ای از مخاطبین منطبق

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • 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.
var contacts = ContactsApp.getContactsByIM('ChatWithJohnDoe',
                                            ContactsApp.Field.AIM);

پارامترها

نام تایپ کنید توضیحات
query String رشته مورد جستجو در آدرس های پیام فوری مخاطبین
label Field فیلدی برای جستجو

بازگشت

Contact[] - آرایه ای از مخاطبین منطبق

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • 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".
var contacts = ContactsApp.getContactsByIM('ChatWithJohnDoe', 'eBuddy');

پارامترها

نام تایپ کنید توضیحات
query String رشته ای برای جستجو در آدرس های پیام فوری مخاطب با برچسب پیام فوری سفارشی مشخص شده
label String برچسب پیام فوری سفارشی برای جستجو در داخل

بازگشت

Contact[] - آرایه ای از مخاطبین منطبق

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

همچنین ببینید

منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.

مخاطبین مطابق با قسمت عنوان شغلی را دریافت کنید. 

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

پارامترها

نام تایپ کنید توضیحات
query String رشته مورد جستجو در قسمت عنوان شغلی مخاطب

بازگشت

Contact[] - آرایه ای از مخاطبین منطبق

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

همچنین ببینید

منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.

دریافت مخاطبین مطابق با نام. 

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

پارامترها

نام تایپ کنید توضیحات
query String رشته مورد جستجو در نام مخاطبین

بازگشت

Contact[] - آرایه ای از مخاطبین منطبق

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • 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.
var contacts = ContactsApp.getContactsByName('John', ContactsApp.Field.GIVEN_NAME);

پارامترها

نام تایپ کنید توضیحات
query String رشته مورد جستجو در نام مخاطبین
label Field فیلدی برای جستجو

بازگشت

Contact[] - آرایه ای از مخاطبین منطبق

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

همچنین ببینید

منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.

دریافت مخاطبین مطابق با قسمت یادداشت ها. 

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

پارامترها

نام تایپ کنید توضیحات
query String رشته مورد جستجو در قسمت یادداشت های مخاطب

بازگشت

Contact[] - آرایه ای از مخاطبین منطبق

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • 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.
var contacts = ContactsApp.getContactsByPhone('212-555-1234');

پارامترها

نام تایپ کنید توضیحات
query String رشته مورد جستجو در شماره تلفن مخاطبین

بازگشت

Contact[] - آرایه ای از مخاطبین منطبق

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • 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.
var contacts = ContactsApp.getContactsByPhone('212-555-1234',
                                              ContactsApp.Field.HOME_PHONE);

پارامترها

نام تایپ کنید توضیحات
query String رشته مورد جستجو در شماره تلفن مخاطبین
label Field فیلدی برای جستجو

بازگشت

Contact[] - آرایه ای از مخاطبین منطبق

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • 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".
var contacts = ContactsApp.getContactsByPhone('212-555-1234', 'alternate');

پارامترها

نام تایپ کنید توضیحات
query String رشته ای که در شماره تلفن مخاطبین با برچسب شماره تلفن سفارشی مشخص شده جستجو می شود
label String برچسب شماره تلفن سفارشی برای جستجو در داخل

بازگشت

Contact[] - آرایه ای از مخاطبین منطبق

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • 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.
var contacts = ContactsApp.getContactsByUrl('www.example.com');

پارامترها

نام تایپ کنید توضیحات
query String رشته مورد جستجو در آدرس های اینترنتی مخاطبین

بازگشت

Contact[] - آرایه ای از مخاطبین منطبق

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • 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.
var contacts = ContactsApp.getContactsByUrl('www.example.com',
                                            ContactsApp.Field.WORK_WEBSITE);

پارامترها

نام تایپ کنید توضیحات
query String رشته مورد جستجو در URL مخاطبین
label Field فیلدی برای جستجو

بازگشت

Contact[] - آرایه ای از مخاطبین منطبق

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • 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".
var contacts = ContactsApp.getContactsByUrl('www.example.com', 'alternate work');

پارامترها

نام تایپ کنید توضیحات
query String رشته مورد جستجو در URL های مخاطب با برچسب URL سفارشی مشخص شده
label String برچسب URL سفارشی برای جستجو در داخل

بازگشت

Contact[] - آرایه ای از مخاطبین منطبق

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

همچنین ببینید