Method: people.getBatchGet

يوفّر معلومات عن قائمة بمستخدمين محدّدين من خلال تحديد قائمة بأسماء الموارد المطلوبة. استخدِم people/me للإشارة إلى المستخدم الذي تمّت مصادقته.

يعرض الطلب خطأ 400 إذا لم يتم تحديد "personFields".

طلب HTTP

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

يستخدِم عنوان URL بنية تحويل ترميز gRPC.

مَعلمات طلب البحث

المعلمات
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)

مطلوب. قناع حقل لتقييد الحقول التي يتم عرضها لكل شخص يمكن تحديد حقول متعددة من خلال فصلها بفواصل. القيم الصالحة هي:

  • عناوين
  • ageRanges
  • السير الذاتية
  • أعياد الميلاد
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • الفعاليات
  • externalIds
  • أنواع
  • imClients
  • الاهتمامات
  • اللغات
  • مواقع جغرافية
  • للقناة
  • البيانات الوصفية
  • miscKeywords
  • الأسماء
  • الألقاب
  • المهن
  • المؤسسات
  • phoneNumbers
  • photos
  • العلاقات
  • sipAddresses
  • مهارات
  • عناوين url
  • 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

لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.