Method: people.get

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

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

طلب HTTP

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

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

معلمات المسار

المَعلمات
resourceName

string

مطلوبة. تمثّل هذه السمة اسم المورد للشخص الذي يجب تقديم معلومات عنه.

  • للحصول على معلومات حول المستخدم الذي تمت المصادقة عليه، حدِّد people/me.
  • للحصول على معلومات حول حساب Google، اختَر people/{account_id}.
  • للحصول على معلومات عن جهة اتصال، عليك تحديد اسم المورد الذي يعرّف جهة الاتصال على أنّها معروضة في people.connections.list.

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

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

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