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
  • الاهتمامات
  • locales
  • المواقع الجغرافية
  • للقناة
  • البيانات الوصفية
  • miscKeywords
  • names
  • الألقاب
  • المهن
  • organizations
  • phoneNumbers
  • صور
  • علاقات
  • sipAddresses
  • مهارات
  • urls
  • 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

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