مقدمه
با مجموعه‌ها، منظم بمانید
ذخیره و طبقه‌بندی محتوا براساس اولویت‌های شما.
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 می خواند از منابع مختلف بسته به شرایط زیر ادغام می شود:
درک داده های افراد ادغام شده
داده های یک شخص از یک نوع منبع اصلی مشتق شده است. اگر منابع از طریق آدرس‌های ایمیل تأیید شده، شماره تلفن یا نشانی‌های اینترنتی نمایه به هم متصل باشند، داده‌های منابع دیگر با این داده‌ها ادغام می‌شوند. اینها روش هایی است که یک فرد ممکن است ترکیب شود:
فقط افراد مبتنی بر تماس را می توان با نقاط پایانی جهش تغییر داد. جهش های مخاطبین نمایه و دامنه پشتیبانی نمی شوند.
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین به‌روزرسانی 2025-08-29 بهوقت ساعت هماهنگ جهانی.
[[["درک آسان","easyToUnderstand","thumb-up"],["مشکلم را برطرف کرد","solvedMyProblem","thumb-up"],["غیره","otherUp","thumb-up"]],[["اطلاعاتی که نیاز دارم وجود ندارد","missingTheInformationINeed","thumb-down"],["بیشازحد پیچیده/ مراحل بسیار زیاد","tooComplicatedTooManySteps","thumb-down"],["قدیمی","outOfDate","thumb-down"],["مشکل ترجمه","translationIssue","thumb-down"],["مشکل کد / نمونهها","samplesCodeIssue","thumb-down"],["غیره","otherDown","thumb-down"]],["تاریخ آخرین به‌روزرسانی 2025-08-29 بهوقت ساعت هماهنگ جهانی."],[[["\u003cp\u003eThe People API allows reading and managing the authenticated user's contacts, including private contacts and "Other contacts".\u003c/p\u003e\n"],["\u003cp\u003eUsers can access profile information for authenticated users and their contacts, including public Google profile data and, when permitted, Google Workspace domain profile data.\u003c/p\u003e\n"],["\u003cp\u003eThe API facilitates managing contacts by creating, updating, and deleting contacts through specific endpoints.\u003c/p\u003e\n"],["\u003cp\u003eGoogle Workspace users can utilize the API to list and search domain profiles and domain contacts.\u003c/p\u003e\n"],["\u003cp\u003eThe People API merges data from various sources like public profiles, private profiles, contacts, and domain information based on verified email addresses, phone numbers, or profile URLs.\u003c/p\u003e\n"]]],["The People API enables reading and managing authenticated user contacts, \"Other contacts,\" and profile information, including domain profiles. Apps can list connections via `people.connections.list`, retrieve specific person data using `people.get`, create contacts with `people.createContact`, update contacts with `people.updateContact`, and delete contacts via `people.deleteContact`. Google Workspace users can access domain contacts using `people.listDirectoryPeople` or `people.searchDirectoryPeople`. The data is merged from sources like public profiles, domain data, and private information, depending on user consent and scopes granted.\n"],null,["# Introduction\n\nThe People API lets you:\n\n- Read and manage the authenticated user's [Contacts](https://contacts.google.com)\n- Read and copy the authenticated user's [\"Other contacts\"](https://contacts.google.com/other)\n- Read profile information for authenticated users and their contacts\n- Read domain profiles and contacts\n\nFor example, suppose that the authenticated user, Jen, has Fabian and Ranjith in\nher private contacts. When your app calls\n[`people.connections.list`](/people/api/rest/v1/people.connections/list) to read a\nlist of her connections, Jen is presented with a consent screen asking to give\nthe app access to the list. If Jen consents, the app reads a list containing\n[`person resources`](/people/api/rest/v1/people) for Fabian and Ranjith.\n\nIf the app needs information for a specific person, it can then call\n[`people.get`](/people/api/rest/v1/people/get), passing in a resource name, to get\nthe [`person resource`](/people/api/rest/v1/people) for that person.\n\nThe app can also manage contacts by creating new contacts using\n[`people.createContact`](/people/api/rest/v1/people/createContact), update existing\ncontacts it has read from\n[`people.connections.list`](/people/api/rest/v1/people.connections/list) using\n[`people.updateContact`](/people/api/rest/v1/people/updateContact), and delete contacts\nusing [`people.deleteContact`](/people/api/rest/v1/people/deleteContact).\n\nGoogle Workspace users can also list their directory domain profiles and domain\ncontacts using\n[`people.listDirectoryPeople`](/people/api/rest/v1/people/listDirectoryPeople) or search\nthem using\n[`people.searchDirectoryPeople`](/people/api/rest/v1/people/searchDirectoryPeople).\n\nA merged view of people information\n-----------------------------------\n\nThe people information that the People API reads is merged from various\nsources, depending on the following conditions:\n\n| Source | Condition |\n|------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| Public Google profile data | Always. |\n| Google Workspace domain profile data | The domain admin has [enabled external contact and profile sharing](https://support.google.com/a/answer/6343701) of domain-scoped data and the [`directory.readonly` scope](/people/v1/how-tos/authorizing#directory) has been granted |\n| The authenticated user's private profile information | One of the [`profile` scopes](/people/v1/how-tos/authorizing#OAuth2Authorizing) has been granted. |\n| The authenticated user's contacts | The [`contacts` scope](/people/v1/how-tos/authorizing#contacts) has been granted. |\n\nUnderstanding Merged Person Data\n--------------------------------\n\nThe data for a person is derived from one main source type. Data from other\nsources is merged with this data if the sources are connected through verified\nemail addresses, phone numbers, or profile URLs. These are the ways a person may\nbe composed:\n\n| Main Source | Contacts | Profiles | Google Workspace Domain Profiles | Google Workspace Domain Contacts | Usage |\n|----------------|----------|----------|----------------------------------|----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| Contact | 1 | 0+ | 0+ | 0+ | Returned for most endpoints |\n| Profile | 0+ | 1 | 0 or 1 | 0 | Returned in [`people.get`](/people/api/rest/v1/people/get) when it is used to get the person [for the signed-in user](/people/v1/profiles#get_the_person_for_the_authenticated_user) or get a person for [another user's Google Account](/people/v1/read-people#get_the_person_for_a_google_account_id). |\n| Domain Contact | 0+ | 0 | 0 | 1 | Returned in [`people.listDirectoryPeople`](/people/api/rest/v1/people/listDirectoryPeople) or [`people.searchDirectoryPeople`](/people/api/rest/v1/people/searchDirectoryPeople). |\n\nOnly contact based people can be modified by mutation endpoints. Profile and\ndomain contact mutations are not supported."]]
