People API به شما امکان می دهد:
- مخاطبین کاربر احراز هویت شده را بخوانید و مدیریت کنید
- "دیگر مخاطبین" کاربر احراز هویت شده را بخوانید و کپی کنید
- اطلاعات نمایه کاربران احراز هویت شده و مخاطبین آنها را بخوانید
- پروفایل ها و مخاطبین دامنه را بخوانید
برای مثال، فرض کنید که کاربر احراز هویت شده، جن، فابین و رانجیت را در مخاطبین خصوصی خود دارد. وقتی برنامه شما با people.connections.list تماس می گیرد تا لیستی از اتصالات خود را بخواند، جن با یک صفحه رضایت نمایش داده می شود که از برنامه می خواهد به برنامه اجازه دسترسی به لیست را بدهد. اگر جن موافقت کند، برنامه فهرستی حاوی person resources برای فابین و رانجیث می خواند.
اگر برنامه برای شخص خاصی به اطلاعات نیاز داشته باشد، می‌تواند با people.get تماس بگیرد و نام منبع را ارسال کند تا person resource برای آن شخص دریافت کند.
این برنامه همچنین می‌تواند با ایجاد مخاطبین جدید با استفاده از people.createContact ، مخاطبین موجود را که از people.connections.list خوانده است با استفاده از people.updateContact به‌روزرسانی کند، و مخاطبین را با استفاده از people.deleteContact حذف کند.
کاربران Google Workspace همچنین می‌توانند نمایه‌های دامنه فهرست راهنما و مخاطبین دامنه خود را با استفاده از people.listDirectoryPeople فهرست کنند یا با استفاده از people.searchDirectoryPeople آنها را جستجو کنند.
نمای ادغامی از اطلاعات افراد
اطلاعات افراد که People API می خواند از منابع مختلف بسته به شرایط زیر ادغام می شود:
| منبع | وضعیت |
|---|---|
| اطلاعات نمایه عمومی Google | همیشه. |
| داده های نمایه دامنه Google Workspace | سرپرست دامنه اشتراک خارجی و اشتراک‌گذاری نمایه داده‌های دامنه را فعال کرده است و دامنه directory.readonly اعطا شده است. |
| اطلاعات پروفایل خصوصی کاربر تایید شده | یکی از دامنه های profile اعطا شده است. |
| مخاطبین کاربر احراز هویت شده | محدوده contacts داده شده است. |
درک داده های افراد ادغام شده
داده های یک شخص از یک نوع منبع اصلی مشتق شده است. اگر منابع از طریق آدرس‌های ایمیل تأیید شده، شماره تلفن یا نشانی‌های اینترنتی نمایه به هم متصل باشند، داده‌های منابع دیگر با این داده‌ها ادغام می‌شوند. اینها روش هایی است که یک فرد ممکن است ترکیب شود:
| منبع اصلی | مخاطب | پروفایل ها | نمایه های دامنه Google Workspace | مخاطبین دامنه Google Workspace | استفاده |
|---|---|---|---|---|---|
| مخاطب | 1 | 0+ | 0+ | 0+ | برای اکثر نقاط پایانی برگردانده شد |
| مشخصات | 0+ | 1 | 0 یا 1 | 0 | هنگامی که برای دریافت شخص برای کاربر واردشده به سیستم یا دریافت یک شخص برای حساب Google کاربر دیگری استفاده می‌شود، در people.get برگردانده می‌شود. |
| تماس دامنه | 0+ | 0 | 0 | 1 | در people.listDirectoryPeople یا people.searchDirectoryPeople برگردانده شد. |
فقط افراد مبتنی بر تماس را می توان با نقاط پایانی جهش تغییر داد. جهش های مخاطبین نمایه و دامنه پشتیبانی نمی شوند.