Method: people.searchDirectoryPeople

فهرستی از نمایه های دامنه و مخاطبین دامنه را در فهرست دامنه کاربر تأیید شده ارائه می دهد که با عبارت جستجو مطابقت دارند.

درخواست HTTP

GET https://people.googleapis.com/v1/people:searchDirectoryPeople

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای پرس و جو

پارامترها
query

string

مورد نیاز. پرس و جوی پیشوندی که با فیلدهای شخص مطابقت دارد. از readMask برای تعیین فیلدهای مطابقت استفاده نمی کند.

readMask

string ( FieldMask format)

مورد نیاز. یک فیلد ماسک برای محدود کردن اینکه کدام فیلد برای هر فرد بازگردانده می شود. چندین فیلد را می توان با جدا کردن آنها با کاما مشخص کرد. مقادیر معتبر عبارتند از:

  • آدرس ها
  • محدوده سنی
  • بیوگرافی ها
  • تولدها
  • calendarUrls
  • کلاینت دیتا
  • جلدعکس ها
  • آدرس های ایمیل
  • رویدادها
  • شناسه های خارجی
  • جنسیت ها
  • imClients
  • منافع
  • مناطق
  • مکان ها
  • عضویت ها
  • ابرداده
  • کلمات کلیدی اشتباه
  • نام ها
  • نام مستعار
  • مشاغل
  • سازمان ها
  • شماره تلفن
  • عکس ها
  • روابط
  • آدرس های sip
  • مهارت ها
  • آدرس های اینترنتی
  • userDefined
sources[]

enum ( DirectorySourceType )

مورد نیاز. منابع دایرکتوری برای بازگشت.

mergeSources[]

enum ( DirectoryMergeSourceType )

اختیاری. داده‌های اضافی برای ادغام در منابع دایرکتوری اگر از طریق کلیدهای اتصال تأیید شده مانند آدرس‌های ایمیل یا شماره تلفن وصل شده باشند.

pageSize

integer

اختیاری. تعداد افرادی که در پاسخ باید لحاظ شود. مقادیر معتبر شامل 1 تا 500 است. در صورت تنظیم نشدن، 100 پیش‌فرض می‌شود یا روی 0 تنظیم می‌شود.

pageToken

string

اختیاری. یک نشانه صفحه، دریافت شده از پاسخ قبلی nextPageToken . این را برای بازیابی صفحه بعدی ارائه کنید.

هنگام صفحه‌بندی، همه پارامترهای دیگر ارائه شده به [ people.searchDirectoryPeople ][google.people.v1.SearchDirectoryPeople] باید با اولین تماسی که کد صفحه را ارائه کرده است مطابقت داشته باشد.

درخواست بدن

بدنه درخواست باید خالی باشد.

بدن پاسخگو

پاسخ به درخواستی برای افرادی که در فهرست دامنه کاربر احراز هویت شده هستند که با عبارت جستجوی مشخص شده مطابقت دارند.

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

نمایندگی JSON 
{
  "people": [
    {
      object (Person)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
فیلدها
people[]

object ( Person )

لیست افراد موجود در فهرست دامنه که با پرس و جو مطابقت دارند.

nextPageToken

string

یک نشانه، که می تواند به عنوان pageToken برای بازیابی صفحه بعدی ارسال شود. اگر این قسمت حذف شود، هیچ صفحه بعدی وجود ندارد.

totalSize

integer

تعداد کل موارد موجود در لیست بدون صفحه بندی.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/directory.readonly

برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.