People API

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

خدمات: people.googleapis.com

برای تماس با این سرویس، توصیه می کنیم از کتابخانه های سرویس گیرنده ارائه شده توسط Google استفاده کنید. اگر برنامه شما نیاز به استفاده از کتابخانه های خود برای فراخوانی این سرویس دارد، هنگام درخواست API از اطلاعات زیر استفاده کنید.

سند کشف

Discovery Document یک ویژگی قابل خواندن توسط ماشین برای توصیف و مصرف API های REST است. از آن برای ساخت کتابخانه های سرویس گیرنده، پلاگین های IDE و سایر ابزارهایی که با Google API در تعامل هستند استفاده می شود. یک سرویس ممکن است چندین سند کشف را ارائه دهد. این سرویس سند کشف زیر را ارائه می دهد:

نقطه پایان خدمات

نقطه پایانی سرویس یک URL پایه است که آدرس شبکه یک سرویس API را مشخص می کند. یک سرویس ممکن است چندین نقطه پایانی سرویس داشته باشد. این سرویس دارای نقطه پایانی سرویس زیر است و همه URI های زیر مربوط به این نقطه پایانی سرویس هستند:

  • https://people.googleapis.com

منبع REST: v1.contactGroups

مواد و روش ها
batchGet GET /v1/contactGroups:batchGet
با مشخص کردن لیستی از نام منابع گروه تماس، فهرستی از گروه های مخاطب متعلق به کاربر تأیید شده را دریافت کنید.
create POST /v1/contactGroups
یک گروه تماس جدید متعلق به کاربر تأیید شده ایجاد کنید.
delete DELETE /v1/{resourceName=contactGroups/*}
با تعیین نام منبع گروه مخاطب، گروه تماس موجود متعلق به کاربر تأیید شده را حذف کنید.
get GET /v1/{resourceName=contactGroups/*}
با تعیین نام منبع گروه تماس، یک گروه تماس خاص متعلق به کاربر تأیید شده دریافت کنید.
list GET /v1/contactGroups
لیست تمام گروه های تماس متعلق به کاربر تایید شده.
update PUT /v1/{contactGroup.resourceName=contactGroups/*}
نام گروه تماس موجود متعلق به کاربر احراز هویت شده را به روز کنید.

منبع REST: v1.contactGroups.members

مواد و روش ها
modify POST /v1/{resourceName=contactGroups/*}/members:modify
اعضای گروه تماس متعلق به کاربر احراز هویت شده را تغییر دهید.

منبع REST: v1.otherContacts

مواد و روش ها
copyOtherContactToMyContactsGroup POST /v1/{resourceName=otherContacts/*}:copyOtherContactToMyContactsGroup

یک "مخاطب دیگر" را در یک مخاطب جدید در گروه "myContacts" کاربر کپی می کند

درخواست های جهش برای همان کاربر باید به صورت متوالی ارسال شوند تا از افزایش تاخیر و خرابی جلوگیری شود.

list GET /v1/otherContacts
فهرست همه «مخاطبین دیگر»، یعنی مخاطبینی که در یک گروه مخاطب نیستند.
search GET /v1/otherContacts:search
فهرستی از مخاطبین را در سایر مخاطبین کاربر تأیید شده ارائه می دهد که با عبارت جستجو مطابقت دارد.

منبع REST: v1.people

مواد و روش ها
batchCreateContacts POST /v1/people:batchCreateContacts

دسته ای از مخاطبین جدید ایجاد کنید و PersonResponses را برای جدیدا برگردانید

درخواست های جهش برای همان کاربر باید به صورت متوالی ارسال شوند تا از افزایش تاخیر و خرابی جلوگیری شود.

batchDeleteContacts POST /v1/people:batchDeleteContacts
دسته ای از مخاطبین را حذف کنید.
batchUpdateContacts POST /v1/people:batchUpdateContacts
دسته ای از مخاطبین را به روز کنید و نقشه ای از نام منابع را برای مخاطبین به روز شده به PersonResponses برگردانید.
createContact POST /v1/people:createContact
یک مخاطب جدید ایجاد کنید و منبع شخصی آن مخاطب را برگردانید.
deleteContact DELETE /v1/{resourceName=people/*}:deleteContact
یک مخاطب را حذف کنید
deleteContactPhoto DELETE /v1/{resourceName=people/*}:deleteContactPhoto
عکس مخاطب را حذف کنید
get GET /v1/{resourceName=people/*}
با تعیین نام منبع، اطلاعاتی در مورد یک شخص ارائه می دهد.
getBatchGet GET /v1/people:batchGet
با تعیین لیستی از نام منابع درخواستی، اطلاعاتی در مورد لیستی از افراد خاص ارائه می دهد.
listDirectoryPeople GET /v1/people:listDirectoryPeople
فهرستی از نمایه های دامنه و مخاطبین دامنه را در فهرست دامنه کاربر تأیید شده ارائه می دهد.
searchContacts GET /v1/people:searchContacts
فهرستی از مخاطبین را در مخاطبین گروه‌بندی شده کاربر احراز هویت شده ارائه می‌کند که با عبارت جستجو مطابقت دارد.
searchDirectoryPeople GET /v1/people:searchDirectoryPeople
فهرستی از نمایه های دامنه و مخاطبین دامنه را در فهرست دامنه کاربر تأیید شده ارائه می دهد که با عبارت جستجو مطابقت دارند.
updateContact PATCH /v1/{person.resourceName=people/*}:updateContact
اطلاعات تماس را برای یک فرد مخاطب موجود به روز کنید.
updateContactPhoto PATCH /v1/{resourceName=people/*}:updateContactPhoto
عکس یک مخاطب را به روز کنید.

منبع REST: v1.people.connections

مواد و روش ها
list GET /v1/{resourceName=people/*}/connections
لیستی از مخاطبین کاربر احراز هویت شده را ارائه می دهد.