توفر قائمة بالملفات الشخصية للنطاق وجهات اتصال النطاق في دليل نطاق المستخدم الذي تمت المصادقة عليه.
عند تحديد
، سيتم عرض الموارد المحذوفة منذ آخر مزامنة كشخص تم ضبط syncToken
على true.PersonMetadata.deleted
عند تحديد
أو pageToken
، يجب أن تتطابق جميع معلمات الطلب الأخرى مع المكالمة الأولى.syncToken
قد يكون هناك تأخير في النشر في عمليات الكتابة يصل إلى عدة دقائق لطلبات المزامنة. ليس الغرض من عمليات المزامنة التدريجية استخدام حالات القراءة بعد الكتابة.
اطلع على مثال للاستخدام على إدراج الدليل الذي أجرى الأشخاص تغييرات عليه.
طلب HTTP
GET https://people.googleapis.com/v1/people:listDirectoryPeople
يستخدم عنوان URL بنية تحويل ترميز gRPC.
معامِلات طلب البحث
المَعلمات | |
---|---|
readMask |
مطلوبة. قناع حقل لتقييد الحقول التي يتم عرضها على كل شخص. يمكن تحديد حقول متعددة من خلال فصلها بفواصل. القيم الصالحة هي:
|
sources[] |
مطلوبة. مصادر الدليل المراد عرضها. |
mergeSources[] |
اختياريّ. بيانات إضافية لدمجها في مصادر الدليل إذا كانت متصلة من خلال مفاتيح الانضمام التي تم التحقق منها، مثل عناوين البريد الإلكتروني أو أرقام الهواتف |
pageSize |
اختياريّ. عدد الأشخاص المطلوب تضمينهم في الرد. وتتراوح القيم الصالحة بين 1 و1000، بما في ذلك القيمتان. ويتم ضبط القيمة تلقائيًا على 100 في حال عدم ضبطها أو ضبطها على 0. |
pageToken |
اختياريّ. تم تلقّي رمز مميز للصفحة من ردّ سابق عند إجراء التقسيم على صفحات، يجب أن تتطابق جميع المعلّمات الأخرى المقدَّمة إلى |
requestSyncToken |
اختياريّ. لتحديد ما إذا كان يجب أن تعرض الاستجابة يمكنك الاطّلاع على مزيد من التفاصيل حول سلوك المزامنة على الرابط |
syncToken |
اختياريّ. رمز المزامنة المميز الذي تم استلامه من رد سابق عند المزامنة، يجب أن تتطابق جميع المعلمات الأخرى المقدمة إلى يمكنك الاطّلاع على مزيد من التفاصيل حول سلوك المزامنة على الرابط |
نص الطلب
يجب أن يكون نص الطلب فارغًا.
نص الاستجابة
إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:
الاستجابة لطلب دليل نطاق المستخدم الذي تمت المصادقة عليه.
تمثيل JSON |
---|
{
"people": [
{
object ( |
الحقول | |
---|---|
people[] |
قائمة الأشخاص في دليل النطاق. |
nextPageToken |
الرمز المميز الذي يمكن إرساله كـ |
nextSyncToken |
الرمز المميز الذي يمكن إرساله كـ |
نطاقات الأذونات
يجب توفير نطاق OAuth التالي:
https://www.googleapis.com/auth/directory.readonly
لمزيد من المعلومات، راجع دليل التفويض.