يوفّر هذا الإعداد قائمة بملفات النطاق الشخصية وجهات اتصال النطاق في دليل نطاق المستخدم الذي تمت المصادقة عليه.
عند تحديد
، سيتم إرجاع الموارد المحذوفة منذ آخر مزامنة كشخص تم ضبط syncToken
على "صحيح".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
لمزيد من المعلومات، يُرجى الاطّلاع على دليل التفويض.