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
  • الاهتمامات
  • locales
  • المواقع الجغرافية
  • للقناة
  • البيانات الوصفية
  • miscKeywords
  • names
  • الألقاب
  • المهن
  • organizations
  • phoneNumbers
  • صور
  • علاقات
  • sipAddresses
  • مهارات
  • urls
  • 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

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