Method: people.listDirectoryPeople

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

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

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

قد تتأخر عمليات النشر لعدد دقائق في طلبات المزامنة. لا تُستخدَم عمليات المزامنة المتزايدة في حالات الاستخدام التي تتطلّب القراءة بعد الكتابة.

يمكنك الاطّلاع على مثال للاستخدام على إدراج الأشخاص الذين أجروا تغييرات في الدليل.

طلب HTTP

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

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

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

المعلمات
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 و1, 000. وتكون القيم التلقائية 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

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