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.

معلمات طلب البحث

المَعلمات
query

string

مطلوبة. طلب البحث بالنص العادي للطلب. يتم استخدام طلب البحث لمطابقة العبارات البادئة في الحقول الخاصة بالشخص. على سبيل المثال، يتطابق مستخدم الاسم "foo name" مع طلبات البحث مثل "f" أو "fo" أو "foo" أو "foo n" أو "nam" وما إلى ذلك، ولكن ليس "oo n".
pageSize

integer

اختياريّ. عدد النتائج المطلوب عرضها. يتم ضبط القيمة على 10 تلقائيًا في حال عدم ضبط الحقل، أو يتم ضبطها على 0. سيتم تحديد القيم الأكبر من 30 لتصبح 30.
readMask

string (FieldMask format)

مطلوبة. قناع حقل لتقييد الحقول التي يتم عرضها لكل مستخدم يمكن تحديد عدة حقول من خلال الفصل بينها بفواصل. القيم الصالحة هي:

  • عنوان واحد
  • ageRanges
  • السير الذاتية
  • أعياد الميلاد
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • الفعاليات
  • externalIds
  • أنواع
  • imClients
  • الاهتمامات
  • locales
  • المواقع الجغرافية
  • للقناة
  • البيانات الوصفية
  • miscKeywords
  • names
  • الألقاب
  • المهن
  • organizations
  • phoneNumbers
  • صور
  • علاقات
  • sipAddresses
  • مهارات
  • urls
  • userDefined
sources[]

enum (ReadSourceType)

اختياريّ. قناع لأنواع المصادر المطلوب عرضها. يتم ضبط السياسة تلقائيًا على READ_SOURCE_TYPE_CONTACT إذا لم يتم ضبطها.

نص الطلب

يجب أن يكون نص الطلب فارغًا.

نص الاستجابة

إذا كانت الاستجابة ناجحة، يحتوي نص الاستجابة على مثال SearchResponse.

نطاقات التفويض

يتطلب استخدام أحد نطاقات OAuth التالية:

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

لمزيد من المعلومات، يُرجى الاطّلاع على دليل التفويض.