Method: otherContacts.search

فهرستی از مخاطبین را در سایر مخاطبین کاربر تأیید شده ارائه می دهد که با عبارت جستجو مطابقت دارد. پرس و جو در names مخاطب، emailAddresses و phoneNumbers که از منبع OTHER_CONTACT هستند مطابقت دارد.

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

درخواست HTTP

GET https://people.googleapis.com/v1/otherContacts:search

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)

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

  • آدرس ایمیل
  • فراداده
  • نام ها
  • شماره تلفن ها

درخواست بدن

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

بدن پاسخگو

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

محدوده مجوز

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

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

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