Method: people.getBatchGet

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

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

درخواست HTTP

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

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

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

پارامترها
resourceNames[]

string

مورد نیاز. نام منابع افراد برای ارائه اطلاعات در مورد. قابل تکرار است پارامتر پرس و جو URL باید باشد

resourceNames=<name1>&resourceNames=<name2>&...

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

حداکثر 200 نام منبع وجود دارد.

requestMask
(deprecated)

object ( RequestMask )

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

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

personFields

string ( FieldMask format)

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

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

enum ( ReadSourceType )

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

درخواست بدن

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

بدن پاسخگو

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

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

نمایندگی JSON 
{
  "responses": [
    {
      object (PersonResponse)
    }
  ]
}
فیلدها
responses[]

object ( PersonResponse )

پاسخ برای هر نام منبع درخواستی.

محدوده مجوز

برای دسترسی به داده های عمومی نیازی به مجوز نیست. برای داده های خصوصی، یکی از حوزه های 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

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