Method: people.listDirectoryPeople
تنظيم صفحاتك في مجموعات
يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.
يوفّر هذا الإجراء قائمة بالملفات الشخصية للنطاقات وجهات اتصال النطاق في دليل نطاق المستخدم الذي تمّت مصادقته.
عند تحديد syncTokenPersonMetadata.deleted
عند تحديد pageTokensyncToken
قد تتأخر عمليات النشر لعدد دقائق في طلبات المزامنة. لا تُستخدَم عمليات المزامنة المتزايدة في حالات الاستخدام التي تتطلّب القراءة بعد الكتابة.
يمكنك الاطّلاع على مثال للاستخدام على إدراج الأشخاص الذين أجروا تغييرات في الدليل.
طلب 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
اختياريّ. ما إذا كان يجب أن يعرض الرد nextSyncTokensyncToken يمكنك الاطّلاع على مزيد من التفاصيل حول سلوك المزامنة على 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
لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.
إنّ محتوى هذه الصفحة مرخّص بموجب ترخيص Creative Commons Attribution 4.0 ما لم يُنصّ على خلاف ذلك، ونماذج الرموز مرخّصة بموجب ترخيص Apache 2.0. للاطّلاع على التفاصيل، يُرجى مراجعة سياسات موقع Google Developers. إنّ Java هي علامة تجارية مسجَّلة لشركة Oracle و/أو شركائها التابعين.
تاريخ التعديل الأخير: 2024-11-08 (حسب التوقيت العالمي المتفَّق عليه)
[[["يسهُل فهم المحتوى.","easyToUnderstand","thumb-up"],["ساعَدني المحتوى في حلّ مشكلتي.","solvedMyProblem","thumb-up"],["غير ذلك","otherUp","thumb-up"]],[["لا يحتوي على المعلومات التي أحتاج إليها.","missingTheInformationINeed","thumb-down"],["الخطوات معقدة للغاية / كثيرة جدًا.","tooComplicatedTooManySteps","thumb-down"],["المحتوى قديم.","outOfDate","thumb-down"],["ثمة مشكلة في الترجمة.","translationIssue","thumb-down"],["مشكلة في العيّنات / التعليمات البرمجية","samplesCodeIssue","thumb-down"],["غير ذلك","otherDown","thumb-down"]],["تاريخ التعديل الأخير: 2024-11-08 (حسب التوقيت العالمي المتفَّق عليه)"],[[["Lists domain profiles and contacts within the authenticated user's domain directory."],["Allows for filtering and pagination of results using query parameters like `readMask`, `sources`, `pageSize`, `pageToken`, and `syncToken`."],["Supports incremental synchronization to retrieve changes since the last request using the `syncToken` and `requestSyncToken` parameters."],["Returns a list of `Person` objects containing directory information, along with pagination and synchronization tokens."],["Requires the `https://www.googleapis.com/auth/directory.readonly` OAuth scope for authorization."]]],["This outlines how to list domain profiles and contacts via a `GET` request to `https://people.googleapis.com/v1/people:listDirectoryPeople`. Key actions include specifying `readMask`, `sources`, `mergeSources`, `pageSize`, `pageToken`, `requestSyncToken`, and `syncToken` as query parameters. An empty request body is required. The response, containing an array of `people`, `nextPageToken`, and `nextSyncToken` fields, allows for pagination and synchronization of changes. The `https://www.googleapis.com/auth/directory.readonly` authorization scope is required.\n"]]
