Method: people.searchDirectoryPeople

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

طلب HTTP

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

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

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

المَعلمات
query

string

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

string (FieldMask format)

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

  • عنوان واحد
  • الفئات العمرية
  • سير ذاتية
  • أعياد ميلاد
  • عناوين URL للتقويم
  • بيانات العميل
  • صور الغلاف
  • عناوين البريد الإلكتروني
  • فعاليات
  • المعرّفات الخارجية
  • أنواع
  • عملاء IIM
  • الاهتمامات
  • اللغات
  • مواقع جغرافية
  • للقناة
  • البيانات الوصفية
  • كلمات رئيسية متنوعة
  • أسماء
  • الألقاب
  • مهن
  • المؤسسات
  • أرقام الهاتف
  • صور
  • علاقات
  • sipAddresses
  • مهارات
  • عناوين url
  • من تحديد المستخدم
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

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