Method: people.searchContacts

فهرستی از مخاطبین را در مخاطبین گروه‌بندی شده کاربر احراز هویت شده ارائه می‌کند که با عبارت جستجو مطابقت دارد. پرس و جو با names مخاطب، nickNames ، emailAddresses ، phoneNumbers و فیلدهای organizations که از منبع CONTACT هستند مطابقت دارد.

مهم : قبل از جستجو، کلاینت‌ها باید برای به‌روزرسانی حافظه پنهان، یک درخواست گرم کردن با یک درخواست خالی ارسال کنند. به https://developers.google.com/people/v1/contacts#search_the_users_contacts مراجعه کنید

درخواست HTTP

GET https://people.googleapis.com/v1/people:searchContacts

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای پرس و جو

مولفه های
query

string

ضروری. پرس و جوی متن ساده برای درخواست. پرس و جو برای تطبیق عبارات پیشوند فیلدها در یک شخص استفاده می شود. به عنوان مثال، شخصی با نام "foo name" با پرس و جوهایی مانند "f"، "fo"، "foo"، "foo n"، "nam" و غیره مطابقت دارد، اما "oo n" نیست.

pageSize

integer

اختیاری. تعداد نتایج برای بازگشت. اگر فیلد تنظیم نشده باشد، پیش‌فرض 10 می‌شود، یا روی 0 تنظیم می‌شود. مقادیر بیشتر از 30 به 30 محدود می‌شوند.

readMask

string ( FieldMask format)

ضروری. یک فیلد ماسک برای محدود کردن اینکه کدام فیلد برای هر فرد بازگردانده می شود. چندین فیلد را می توان با جدا کردن آنها با کاما مشخص کرد. مقادیر معتبر عبارتند از:

  • آدرس ها
  • محدوده سنی
  • بیوگرافی ها
  • تولدها
  • calendarUrls
  • کلاینت دیتا
  • عکسهای روی جلد
  • آدرس ایمیل
  • مناسبت ها
  • شناسه های خارجی
  • جنسیت ها
  • imClients
  • منافع
  • مناطق
  • مکان ها
  • عضویت ها
  • فراداده
  • کلمات کلیدی اشتباه
  • نام ها
  • نام مستعار
  • مشاغل
  • سازمان های
  • شماره تلفن ها
  • عکس ها
  • روابط
  • آدرس های sip
  • مهارت ها
  • آدرس های اینترنتی
  • تعریف شده توسط کاربر
sources[]

enum ( ReadSourceType )

اختیاری. ماسکی از نوع منبع برای بازگشت. در صورت تنظیم نشدن، پیش‌فرض READ_SOURCE_TYPE_CONTACT است.

درخواست بدن

بدنه درخواست باید خالی باشد.

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی نمونه‌ای از SearchResponse است.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/contacts
  • https://www.googleapis.com/auth/contacts.readonly

برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.