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

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