Method: people.searchDirectoryPeople

يوفّر هذا الحقل قائمة بالملفات الشخصية للنطاقات وجهات اتصال النطاق في دليل نطاق المستخدم الذي تمّت المصادقة عليه والتي تتطابق مع طلب البحث.

طلب HTTP

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

يستخدِم عنوان URL بنية تحويل ترميز gRPC.

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

المعلمات
query

string

مطلوب. طلب بحث بادئة يتطابق مع الحقول في الشخص لا يستخدم readMask لتحديد الحقول التي ستتم مطابقتها.
readMask

string (FieldMask format)

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

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

enum (DirectorySourceType)

مطلوب. مصادر الدليل المطلوب عرضها
mergeSources[]

enum (DirectoryMergeSourceType)

اختياريّ. بيانات إضافية لدمجها في مصادر الدليل إذا كانت مرتبطة من خلال مفاتيح الربط التي تم التحقّق منها، مثل عناوين البريد الإلكتروني أو أرقام الهواتف
pageSize

integer

اختياريّ. عدد الأشخاص المطلوب تضمينهم في الردّ. تتراوح القيم الصالحة بين 1 و500. وتكون القيم التلقائية 100 في حال عدم ضبطها أو عند ضبطها على 0.
pageToken

string

اختياريّ. رمز مميّز للصفحة، تم تلقّيه من استجابة سابقة nextPageToken. قدِّم هذا المرجع لاسترداد الصفحة اللاحقة.

عند تقسيم الصفحات، يجب أن تتطابق جميع المَعلمات الأخرى المقدَّمة إلى [people.searchDirectoryPeople][google.people.v1.SearchDirectoryPeople] مع الطلب الأول الذي قدّم رمز مميّز للصفحة.

نص الطلب

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

نص الاستجابة

الردّ على طلب للمستخدمين في دليل نطاق المستخدم الذي تمت مصادقته يتطابق مع طلب البحث المحدّد.

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل JSON 
{
  "people": [
    {
      object (Person)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
الحقول
people[]

object (Person)

قائمة المستخدمين في دليل النطاق الذين يتطابقون مع طلب البحث
nextPageToken

string

رمز مميّز يمكن إرساله على شكل pageToken لاسترداد الصفحة التالية. في حال حذف هذا الحقل، لن تكون هناك صفحات لاحقة.
totalSize

integer

إجمالي عدد العناصر في القائمة بدون تقسيم النتائج على عدّة صفحات.

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

يجب توفير نطاق OAuth التالي:

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

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