Method: people.get

با تعیین نام منبع، اطلاعاتی در مورد یک شخص ارائه می دهد. people/me برای نشان دادن کاربر تایید شده استفاده کنید.

اگر «personFields» مشخص نشده باشد، درخواست یک خطای 400 برمی‌گرداند.

درخواست HTTP

GET https://people.googleapis.com/v1/{resourceName=people/*}

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

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

مولفه های
resourceName

string

ضروری. نام منبع شخص برای ارائه اطلاعات در مورد.

  • برای دریافت اطلاعات در مورد کاربر احراز هویت شده، people/me را مشخص کنید.
  • برای دریافت اطلاعات درباره حساب Google، people/{account_id} را مشخص کنید.
  • برای دریافت اطلاعات در مورد یک مخاطب، نام منبعی را مشخص کنید که مخاطب را به عنوان بازگردانده شده توسط people.connections.list مشخص می کند.

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

مولفه های
requestMask
(deprecated)

object ( RequestMask )

منسوخ شده (لطفا به جای آن از personFields استفاده کنید)

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

personFields

string ( FieldMask format)

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

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

enum ( ReadSourceType )

اختیاری. ماسکی از نوع منبع برای بازگشت. در صورت تنظیم نشدن، پیش‌فرض READ_SOURCE_TYPE_PROFILE و READ_SOURCE_TYPE_CONTACT است.

درخواست بدن

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

بدن پاسخگو

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

محدوده مجوز

برای دسترسی به داده های عمومی نیازی به مجوز نیست. برای داده های خصوصی، یکی از حوزه های OAuth زیر مورد نیاز است:

  • https://www.googleapis.com/auth/contacts
  • https://www.googleapis.com/auth/contacts.readonly
  • https://www.googleapis.com/auth/contacts.other.readonly
  • https://www.googleapis.com/auth/directory.readonly
  • https://www.googleapis.com/auth/profile.agerange.read
  • https://www.googleapis.com/auth/profile.emails.read
  • https://www.googleapis.com/auth/profile.language.read
  • https://www.googleapis.com/auth/user.addresses.read
  • https://www.googleapis.com/auth/user.birthday.read
  • https://www.googleapis.com/auth/user.emails.read
  • https://www.googleapis.com/auth/user.gender.read
  • https://www.googleapis.com/auth/user.organization.read
  • https://www.googleapis.com/auth/user.phonenumbers.read
  • https://www.googleapis.com/auth/userinfo.email
  • https://www.googleapis.com/auth/userinfo.profile
  • https://www.googleapis.com/auth/profile.language.read

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