Method: people.listDirectoryPeople

تنظيم صفحاتك في مجموعات يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.

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

عند تحديد syncToken، سيتم عرض الموارد المحذوفة منذ آخر مزامنة كشخص تم ضبط PersonMetadata.deleted على true.

عند تحديد pageToken أو syncToken، يجب أن تتطابق جميع معلمات الطلب الأخرى مع المكالمة الأولى.

قد يكون هناك تأخير في النشر في عمليات الكتابة يصل إلى عدة دقائق لطلبات المزامنة. ليس الغرض من عمليات المزامنة التدريجية استخدام حالات القراءة بعد الكتابة.

اطلع على مثال للاستخدام على إدراج الدليل الذي أجرى الأشخاص تغييرات عليه.

طلب HTTP

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

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

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

المَعلمات
readMask

string (FieldMask format)

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

  • عنوان واحد
  • الفئات العمرية
  • سير ذاتية
  • أعياد ميلاد
  • عناوين URL للتقويم
  • بيانات العميل
  • صور الغلاف
  • عناوين البريد الإلكتروني
  • فعاليات
  • المعرّفات الخارجية
  • أنواع
  • عملاء IIM
  • الاهتمامات
  • اللغات
  • مواقع جغرافية
  • للقناة
  • البيانات الوصفية
  • كلمات رئيسية متنوعة
  • أسماء
  • الألقاب
  • مهن
  • المؤسسات
  • أرقام الهاتف
  • صور
  • علاقات
  • sipAddresses
  • مهارات
  • عناوين url
  • من تحديد المستخدم
sources[]

enum (DirectorySourceType)

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

enum (DirectoryMergeSourceType)

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

integer

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

string

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

عند إجراء التقسيم على صفحات، يجب أن تتطابق جميع المعلّمات الأخرى المقدَّمة إلى people.listDirectoryPeople مع الاستدعاء الأول الذي وفّر الرمز المميز للصفحة.
requestSyncToken

boolean

اختياريّ. لتحديد ما إذا كان يجب أن تعرض الاستجابة nextSyncToken أم لا. ويمكن استخدامها للحصول على التغييرات المتزايدة منذ آخر طلب من خلال ضبطه على الطلب syncToken.

يمكنك الاطّلاع على مزيد من التفاصيل حول سلوك المزامنة على الرابط people.listDirectoryPeople.
syncToken

string

اختياريّ. رمز المزامنة المميز الذي تم استلامه من رد سابق nextSyncToken يمكنك توفير هذا الرمز لاسترداد الموارد التي تم تغييرها فقط منذ آخر طلب.

عند المزامنة، يجب أن تتطابق جميع المعلمات الأخرى المقدمة إلى people.listDirectoryPeople مع الاستدعاء الأول الذي قدم الرمز المميز للمزامنة.

يمكنك الاطّلاع على مزيد من التفاصيل حول سلوك المزامنة على الرابط people.listDirectoryPeople.

نص الطلب

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

نص الاستجابة

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

الاستجابة لطلب دليل نطاق المستخدم الذي تمت المصادقة عليه.

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

object (Person)

قائمة الأشخاص في دليل النطاق.
nextPageToken

string

الرمز المميز الذي يمكن إرساله كـ pageToken لاسترداد الصفحة التالية. إذا تم حذف هذا الحقل، فلن تظهر أية صفحات لاحقة.
nextSyncToken

string

الرمز المميز الذي يمكن إرساله كـ syncToken لاسترداد التغييرات منذ آخر طلب. يجب أن يعيّن الطلب requestSyncToken لعرض الرمز المميز للمزامنة.

نطاقات الأذونات

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

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

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