Method: people.listDirectoryPeople

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

وقتی syncToken مشخص شد، منابع حذف شده از زمان آخرین همگام‌سازی به‌عنوان شخصی با تنظیم PersonMetadata.deleted روی true برگردانده می‌شوند.

وقتی pageToken یا syncToken مشخص می‌شود، تمام پارامترهای درخواست دیگر باید با اولین تماس مطابقت داشته باشند.

نوشته‌ها ممکن است برای درخواست‌های همگام‌سازی چند دقیقه تاخیر در انتشار داشته باشند. همگام‌سازی‌های افزایشی برای موارد استفاده خواندن پس از نوشتن در نظر گرفته نشده‌اند.

نمونه استفاده را در فهرست افراد دایرکتوری که تغییر کرده اند ببینید.

درخواست HTTP

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

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

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

پارامترها
readMask

string ( FieldMask format)

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

  • آدرس ها
  • محدوده سنی
  • بیوگرافی ها
  • تولدها
  • calendarUrls
  • کلاینت دیتا
  • جلدعکس ها
  • آدرس های ایمیل
  • رویدادها
  • شناسه های خارجی
  • جنسیت ها
  • imClients
  • منافع
  • مناطق
  • مکان ها
  • عضویت ها
  • فراداده
  • کلمات کلیدی اشتباه
  • نام ها
  • نام مستعار
  • مشاغل
  • سازمان ها
  • شماره تلفن
  • عکس ها
  • روابط
  • آدرس های sip
  • مهارت ها
  • آدرس های اینترنتی
  • 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

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