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