REST Resource: people

المرجع: شخص

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

يمكن أن تتضمّن معظم الحقول عناصر متعدّدة. ولا تتضمّن العناصر المدرَجة في أحد الحقول ترتيبًا مضمونًا، ولكن يمكن ضمان أن يحتوي كل حقل غير فارغ على حقل واحد فقط مع ضبط metadata.primary على "صحيح".

تمثيل JSON
{
  "resourceName": string,
  "etag": string,
  "metadata": {
    object (PersonMetadata)
  },
  "addresses": [
    {
      object (Address)
    }
  ],
  "ageRange": enum (AgeRange),
  "ageRanges": [
    {
      object (AgeRangeType)
    }
  ],
  "biographies": [
    {
      object (Biography)
    }
  ],
  "birthdays": [
    {
      object (Birthday)
    }
  ],
  "braggingRights": [
    {
      object (BraggingRights)
    }
  ],
  "calendarUrls": [
    {
      object (CalendarUrl)
    }
  ],
  "clientData": [
    {
      object (ClientData)
    }
  ],
  "coverPhotos": [
    {
      object (CoverPhoto)
    }
  ],
  "emailAddresses": [
    {
      object (EmailAddress)
    }
  ],
  "events": [
    {
      object (Event)
    }
  ],
  "externalIds": [
    {
      object (ExternalId)
    }
  ],
  "fileAses": [
    {
      object (FileAs)
    }
  ],
  "genders": [
    {
      object (Gender)
    }
  ],
  "imClients": [
    {
      object (ImClient)
    }
  ],
  "interests": [
    {
      object (Interest)
    }
  ],
  "locales": [
    {
      object (Locale)
    }
  ],
  "locations": [
    {
      object (Location)
    }
  ],
  "memberships": [
    {
      object (Membership)
    }
  ],
  "miscKeywords": [
    {
      object (MiscKeyword)
    }
  ],
  "names": [
    {
      object (Name)
    }
  ],
  "nicknames": [
    {
      object (Nickname)
    }
  ],
  "occupations": [
    {
      object (Occupation)
    }
  ],
  "organizations": [
    {
      object (Organization)
    }
  ],
  "phoneNumbers": [
    {
      object (PhoneNumber)
    }
  ],
  "photos": [
    {
      object (Photo)
    }
  ],
  "relations": [
    {
      object (Relation)
    }
  ],
  "relationshipInterests": [
    {
      object (RelationshipInterest)
    }
  ],
  "relationshipStatuses": [
    {
      object (RelationshipStatus)
    }
  ],
  "residences": [
    {
      object (Residence)
    }
  ],
  "sipAddresses": [
    {
      object (SipAddress)
    }
  ],
  "skills": [
    {
      object (Skill)
    }
  ],
  "taglines": [
    {
      object (Tagline)
    }
  ],
  "urls": [
    {
      object (Url)
    }
  ],
  "userDefined": [
    {
      object (UserDefined)
    }
  ]
}
الحقول
resourceName

string

اسم المورد للمستخدم، الذي يعينه الخادم. سلسلة ASCII على شكل people/{person_id}.

etag

string

علامة كيان HTTP للمصدر. يُستخدم للتحقّق من ذاكرة التخزين المؤقت على الويب.

metadata

object (PersonMetadata)

النتائج فقط. بيانات التعريف حول الشخص.

addresses[]

object (Address)

عناوين الشوارع للشخص.

ageRange
(deprecated)

enum (AgeRange)

النتائج فقط. تم الإيقاف (يُرجى استخدام person.ageRanges بدلاً من ذلك)

الفئة العمرية للشخص.

ageRanges[]

object (AgeRangeType)

النتائج فقط. الفئات العمرية للشخص

biographies[]

object (Biography)

السيرة الذاتية للشخص. يتم تخصيص هذا الحقل لمصادر جهات الاتصال.

birthdays[]

object (Birthday)

أعياد ميلاد الشخص يتم تخصيص هذا الحقل لمصادر جهات الاتصال.

braggingRights[]
(deprecated)

object (BraggingRights)

تم إيقافها: لن يتم إرجاع حقوق الشخص التي يتباهى بها.

calendarUrls[]

object (CalendarUrl)

عناوين URL لتقويم الشخص.

clientData[]

object (ClientData)

بيانات عميل الشخص.

coverPhotos[]

object (CoverPhoto)

النتائج فقط. صور غلاف المستخدم

emailAddresses[]

object (EmailAddress)

عناوين البريد الإلكتروني للشخص. بالنسبة إلى people.connections.list وotherContacts.list، لا يمكن أن يزيد عدد عناوين البريد الإلكتروني عن 100 عنوان. إذا كان أحد الأشخاص لديه المزيد من عناوين البريد الإلكتروني، يمكن الحصول على المجموعة بالكامل من خلال الاتصال بـ people.getBatchGet.

events[]

object (Event)

أحداث الشخص.

externalIds[]

object (ExternalId)

المعرّفات الخارجية للشخص.

fileAses[]

object (FileAs)

ملفات تعريف الشخص.

genders[]

object (Gender)

جنس الشخص. يتم تخصيص هذا الحقل لمصادر جهات الاتصال.

imClients[]

object (ImClient)

برامج المراسلة الفورية للشخص.

interests[]

object (Interest)

اهتمامات الشخص

locales[]

object (Locale)

الإعدادات المفضّلة للغة الشخص

locations[]

object (Location)

مواقع الشخص.

memberships[]

object (Membership)

عضويات الشخص في المجموعة.

miscKeywords[]

object (MiscKeyword)

الكلمات الرئيسية المتنوعة للشخص.

names[]

object (Name)

تمثّل هذه السمة أسماء الأشخاص. يتم تخصيص هذا الحقل لمصادر جهات الاتصال.

nicknames[]

object (Nickname)

ألقاب الشخص.

occupations[]

object (Occupation)

مهن الشخص.

organizations[]

object (Organization)

المؤسسات السابقة أو الحالية للشخص

phoneNumbers[]

object (PhoneNumber)

أرقام هواتف الشخص بالنسبة إلى people.connections.list وotherContacts.list، يقتصر عدد أرقام الهواتف على 100 رقم. إذا كان الشخص لديه المزيد من أرقام الهواتف، يمكن الحصول على المجموعة بالكامل عن طريق الاتصال بـ people.getBatchGet.

photos[]

object (Photo)

النتائج فقط. صور الشخص.

relations[]

object (Relation)

علاقات الشخص.

relationshipInterests[]
(deprecated)

object (RelationshipInterest)

النتائج فقط. تم الإيقاف: لن يتم عرض أي بيانات عن الاهتمامات المتعلقة بعلاقة الشخص.

relationshipStatuses[]
(deprecated)

object (RelationshipStatus)

النتائج فقط. تم إيقافها: لن يتم عرض أي بيانات لحالات علاقة الشخص.

residences[]
(deprecated)

object (Residence)

تم إيقافها: (يُرجى استخدام person.locations بدلاً من ذلك) أماكن إقامة الشخص.

sipAddresses[]

object (SipAddress)

عناوين SIP للشخص.

skills[]

object (Skill)

مهارات الشخص.

taglines[]
(deprecated)

object (Tagline)

النتائج فقط. تم الإيقاف: لن يتم عرض الجُمل الترويجية للشخص.

urls[]

object (Url)

عناوين URL المرتبطة بالشخص

userDefined[]

object (UserDefined)

تمثّل هذه السمة البيانات التي يحدّدها المستخدم للشخص.

PersonMetadata

بيانات التعريف حول شخص ما.

تمثيل JSON
{
  "sources": [
    {
      object (Source)
    }
  ],
  "previousResourceNames": [
    string
  ],
  "linkedPeopleResourceNames": [
    string
  ],
  "deleted": boolean,
  "objectType": enum (ObjectType)
}
الحقول
sources[]

object (Source)

مصادر البيانات للشخص.

previousResourceNames[]

string

النتائج فقط. أي أسماء موارد سابقة لدى هذا الشخص وتتم تعبئة هذا الحقل لطلبات people.connections.list التي تتضمّن رمزًا مميّزًا للمزامنة.

قد يتغيّر اسم المورد عند إضافة أو إزالة الحقول التي تربط جهة اتصال وملف شخصي، مثل عنوان بريد إلكتروني تمّ إثبات ملكيته أو رقم هاتف تمّ إثبات ملكيته أو عنوان URL لملف شخصي.

linkedPeopleResourceNames[]

string

النتائج فقط. أسماء الموارد للأشخاص المرتبطين بهذا المورد

deleted

boolean

النتائج فقط. صحيح إذا تم حذف مورد الشخص. تتم تعبئة هذا الحقل فقط لطلبات مزامنة people.connections.list وotherContacts.list.

objectType
(deprecated)

enum (ObjectType)

النتائج فقط. تم الإيقاف (يُرجى استخدام person.metadata.sources.profileMetadata.objectType بدلاً من ذلك)

نوع كائن الشخص.

المصدر

مصدر الحقل.

تمثيل JSON
{
  "type": enum (SourceType),
  "id": string,
  "etag": string,
  "updateTime": string,

  // Union field metadata can be only one of the following:
  "profileMetadata": {
    object (ProfileMetadata)
  }
  // End of list of possible types for union field metadata.
}
الحقول
type

enum (SourceType)

نوع المصدر

id

string

المعرّف الفريد ضمن نوع المصدر الذي ينشئه الخادم.

etag

string

تتم تعبئة هذا الحقل فقط في person.metadata.sources.

علامة كيان HTTP للمصدر. يُستخدم للتحقّق من ذاكرة التخزين المؤقت على الويب.

updateTime

string (Timestamp format)

النتائج فقط. تتم تعبئة هذا الحقل فقط في person.metadata.sources.

الطابع الزمني لآخر تعديل لهذا المصدر

طابع زمني بتنسيق RFC3339 UTC "Zulu" ، مع دقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z"

حقل الاتحاد metadata تتم تعبئة هذا الحقل فقط في person.metadata.sources.

بيانات التعريف حول المصدر يمكن أن يكون الحقل "metadata" واحدًا فقط مما يلي:

profileMetadata

object (ProfileMetadata)

النتائج فقط. تتم تعبئة هذا الحقل فقط في person.metadata.sources.

بيانات التعريف حول مصدر من النوع PROFILE.

SourceType

نوع المصدر

عمليات التعداد
SOURCE_TYPE_UNSPECIFIED غير محدد
ACCOUNT حساب Google
PROFILE الملف الشخصي في Google. يمكنك الاطّلاع على الملف الشخصي على https://profiles.google.com/{id}، حيث يكون {id} هو رقم تعريف المصدر.
DOMAIN_PROFILE الملف الشخصي لنطاق Google Workspace:
CONTACT جهة اتصال Google يمكنك الاطّلاع على جهة الاتصال على https://contact.google.com/{id}، حيث يكون {id} هو رقم تعريف المصدر.
OTHER_CONTACT "جهة اتصال أخرى" من Google:
DOMAIN_CONTACT جهة اتصال مشترَكة في نطاق Google Workspace.

ProfileMetadata

البيانات الوصفية حول الملف الشخصي.

تمثيل JSON
{
  "objectType": enum (ObjectType),
  "userTypes": [
    enum (UserType)
  ]
}
الحقول
objectType

enum (ObjectType)

النتائج فقط. نوع كائن الملف الشخصي.

userTypes[]

enum (UserType)

النتائج فقط. أنواع المستخدمين.

ObjectType

تمثّل هذه السمة نوع كائن شخص.

عمليات التعداد
OBJECT_TYPE_UNSPECIFIED غير محدد
PERSON شخص.
PAGE صفحة Currents:

UserType

نوع المستخدم.

عمليات التعداد
USER_TYPE_UNKNOWN نوع المستخدم غير معروف.
GOOGLE_USER المستخدم هو أحد مستخدمي Google.
GPLUS_USER المستخدم هو مستخدم Currents.
GOOGLE_APPS_USER كان المستخدم أحد مستخدمي Google Workspace.

العنوان

تمثّل هذه السمة العنوان الجغرافي للشخص. قد يكون عنوان صندوق بريد أو عنوان شارع. جميع الحقول اختيارية.

تمثيل JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "formattedValue": string,
  "type": string,
  "formattedType": string,
  "poBox": string,
  "streetAddress": string,
  "extendedAddress": string,
  "city": string,
  "region": string,
  "postalCode": string,
  "country": string,
  "countryCode": string
}
الحقول
metadata

object (FieldMetadata)

بيانات التعريف حول العنوان

formattedValue

string

القيمة غير المنظَّمة للعنوان. إذا لم يحدّد المستخدم هذا الخيار، سيتم إنشاؤه تلقائيًا من القيم المنظَّمة.

type

string

نوع العنوان ويمكن أن يكون النوع مخصّصًا أو أحد القيم التالية المحدّدة مسبقًا:

  • home
  • work
  • other
formattedType

string

النتائج فقط. تشير هذه السمة إلى نوع العنوان المترجَم والمنسّق في لغة حساب المشاهد أو لغة عنوان HTTP Accept-Language.

poBox

string

صندوق البريد الخاص بالعنوان

streetAddress

string

تمثّل هذه السمة عنوان الشارع.

extendedAddress

string

العنوان الموسَّع للعنوان، مثل رقم الشقة

city

string

تمثّل هذه السمة المدينة التي يقع ضمنها العنوان.

region

string

المنطقة التي يقع ضمنها العنوان، مثل الولاية أو المقاطعة.

postalCode

string

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

country

string

تمثّل هذه السمة البلد الذي يقع فيه العنوان.

countryCode

string

تمثّل هذه السمة رمز البلد الخاص بالعنوان وفقًا لمعيار ISO 3166-1 alpha-2.

FieldMetadata

بيانات التعريف عن أحد المجالات.

تمثيل JSON
{
  "primary": boolean,
  "sourcePrimary": boolean,
  "verified": boolean,
  "source": {
    object (Source)
  }
}
الحقول
primary

boolean

النتائج فقط. True إذا كان الحقل هو الحقل الأساسي لكل المصادر في الشخص. يجب أن يكون لكل مستخدم حقل واحد على الأكثر مع ضبط primary على "صحيح".

sourcePrimary

boolean

True إذا كان الحقل هو الحقل الأساسي لـ source. يجب أن يحتوي كل مصدر على حقل واحد على الأكثر مع ضبط sourcePrimary على "صحيح".

verified

boolean

النتائج فقط. صحيح إذا تم التحقق من الحقل، وخطأ إذا لم يتم التحقق من الحقل. عادةً ما يكون الحقل الذي تم إثبات ملكيته هو اسم أو عنوان بريد إلكتروني أو رقم هاتف أو موقع إلكتروني تم تأكيد ملكيته للمستخدم.

source

object (Source)

مصدر الحقل.

AgeRange

تم الإيقاف (يُرجى استخدام person.ageRanges بدلاً من ذلك)

الفئة العمرية للشخص.

عمليات التعداد
AGE_RANGE_UNSPECIFIED غير محدد
LESS_THAN_EIGHTEEN أصغر من ثمانية عشر عامًا.
EIGHTEEN_TO_TWENTY بَيْنَ ثَمَانِي عَشْرَةَ وَأَرْبَعٍ وَعِشْرِينَ دَرَجَة.
TWENTY_ONE_OR_OLDER واحد وعشرون وأكثر.

AgeRangeType

الفئة العمرية للشخص.

تمثيل JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "ageRange": enum (AgeRange)
}
الحقول
metadata

object (FieldMetadata)

بيانات التعريف حول الفئة العمرية.

ageRange

enum (AgeRange)

الفئة العمرية.

سيرة ذاتية

السيرة الذاتية القصيرة لشخص ما.

تمثيل JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "contentType": enum (ContentType)
}
الحقول
metadata

object (FieldMetadata)

بيانات وصفية حول السيرة الذاتية

value

string

السيرة الذاتية القصيرة.

contentType

enum (ContentType)

تمثّل هذه السمة نوع محتوى السيرة الذاتية.

ContentType

نوع المحتوى

عمليات التعداد
CONTENT_TYPE_UNSPECIFIED غير محدد
TEXT_PLAIN نص عادي:
TEXT_HTML نص HTML.

عيد ميلاد

تاريخ ميلاد المستخدم تم تحديد حقل واحد على الأقل من الحقول date وtext. يمثّل الحقلان date وtext عادةً التاريخ نفسه، ولكن لا يمكننا ضمانهما. على العملاء دائمًا ضبط الحقل date عند تغيير أعياد الميلاد.

تمثيل JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "date": {
    object (Date)
  },
  "text": string
}
الحقول
metadata

object (FieldMetadata)

بيانات التعريف حول تاريخ الميلاد.

date

object (Date)

تمثّل هذه السمة التاريخ المنظَّم لعيد الميلاد.

text
(deprecated)

string

أفضّل استخدام الحقل date في حال ضبطه.

سلسلة حرة الشكل تمثل تاريخ ميلاد المستخدم لم يتم التحقّق من صحة هذه القيمة.

التاريخ

تمثل تاريخًا كاملاً أو جزئيًا في التقويم، مثل عيد ميلاد. تم تحديد الوقت من اليوم والمنطقة الزمنية في مكان آخر أو معلومات مهمة. يرتبط التاريخ بالتقويم الميلادي. ويمكن أن يمثّل ذلك أحد الخيارات التالية:

  • تاريخ كامل، مع قيم غير صفرية للسنة والشهر واليوم.
  • شهر ويوم مع السنة الصفرية (على سبيل المثال، ذكرى سنوية).
  • عام في حد ذاته، مع شهر صفر ويوم صفر.
  • سنة وشهر بدون تحديد يوم (على سبيل المثال، تاريخ انتهاء صلاحية بطاقة الائتمان).

أنواع ذات صلة:

تمثيل JSON
{
  "year": integer,
  "month": integer,
  "day": integer
}
الحقول
year

integer

سنة من التاريخ. يجب أن تتراوح القيمة بين 1 و9999، أو 0 لتحديد تاريخ بدون سنة.

month

integer

شهر من السنة يجب أن تتراوح القيمة من 1 إلى 12 أو 0 لتحديد عام بدون شهر ويوم.

day

integer

يوم من الشهر يجب أن تتراوح القيمة من 1 إلى 31 وأن تكون صالحة للسنة والشهر، أو 0 لتحديد عام بحد ذاته أو العام والشهر اللذين لا يكون فيهما اليوم أهمية.

BraggingRights

تم إيقافها: لن يتم إرجاع حقوق الشخص الذي يتباهى به.

تمثيل JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
الحقول
metadata

object (FieldMetadata)

بيانات وصفية حول الحقوق التي تتباهى بها

value

string

بعض الأشياء التي يجب التباهي بها، على سبيل المثال climbed mount everest.

CalendarUrl

عنوان URL لتقويم المستخدم

تمثيل JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "url": string,
  "type": string,
  "formattedType": string
}
الحقول
metadata

object (FieldMetadata)

البيانات الوصفية حول عنوان URL للتقويم

url

string

عنوان URL للتقويم

type

string

نوع عنوان URL للتقويم. ويمكن أن يكون النوع مخصّصًا أو أحد القيم التالية المحدّدة مسبقًا:

  • home
  • freeBusy
  • work
formattedType

string

النتائج فقط. تشير هذه السمة إلى نوع عنوان URL للتقويم الذي تمت ترجمة تنسيقه وتنسيقه في لغة حساب المشاهد أو لغة عنوان HTTP Accept-Language.

ClientData

بيانات العميل العشوائية التي تتم تعبئتها من قِبل العملاء. يُسمح بالمفاتيح والقيم المكررة.

تمثيل JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "key": string,
  "value": string
}
الحقول
metadata

object (FieldMetadata)

بيانات التعريف حول بيانات العميل.

key

string

حدَّد العميل مفتاح بيانات العميل.

value

string

القيمة المحدّدة للعميل لبيانات العميل.

CoverPhoto

صورة غلاف المستخدم صورة كبيرة يتم عرضها على صفحة الملف الشخصي للشخص وتمثِّل هويته أو ما يهتم به.

تمثيل JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "url": string,
  "default": boolean
}
الحقول
metadata

object (FieldMetadata)

البيانات الوصفية حول صورة الغلاف

url

string

تمثّل هذه السمة عنوان URL لصورة الغلاف.

default

boolean

صحيح إذا كانت صورة الغلاف هي صورة الغلاف التلقائية، وخطأ إذا كانت صورة الغلاف هي صورة غلاف مقدّمة من المستخدم.

EmailAddress

تمثّل هذه السمة عنوان البريد الإلكتروني لأحد المستخدمين.

تمثيل JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": string,
  "formattedType": string,
  "displayName": string
}
الحقول
metadata

object (FieldMetadata)

بيانات التعريف حول عنوان البريد الإلكتروني.

value

string

عنوان البريد الإلكتروني

type

string

نوع عنوان البريد الإلكتروني. ويمكن أن يكون النوع مخصّصًا أو أحد القيم التالية المحدّدة مسبقًا:

  • home
  • work
  • other
formattedType

string

النتائج فقط. تمثّل هذه السمة نوع عنوان البريد الإلكتروني الذي تمت ترجمته وتنسيقه بلغة حساب المُشاهد أو لغة عنوان HTTP Accept-Language.

displayName

string

الاسم المعروض للرسالة الإلكترونية.

حدث

حدث متعلق بالشخص.

تمثيل JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "date": {
    object (Date)
  },
  "type": string,
  "formattedType": string
}
الحقول
metadata

object (FieldMetadata)

البيانات الوصفية حول الحدث.

date

object (Date)

تاريخ الحدث.

type

string

نوع الحدث ويمكن أن يكون النوع مخصّصًا أو أحد القيم التالية المحدّدة مسبقًا:

  • anniversary
  • other
formattedType

string

النتائج فقط. نوع الحدث المترجَم وتنسيقه في لغة حساب المُشاهد أو لغة عنوان HTTP Accept-Language

ExternalId

معرّف من كيان خارجي مرتبط بالشخص.

تمثيل JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": string,
  "formattedType": string
}
الحقول
metadata

object (FieldMetadata)

البيانات الوصفية حول المعرّف الخارجي

value

string

قيمة المعرّف الخارجي.

type

string

نوع المعرّف الخارجي. ويمكن أن يكون النوع مخصّصًا أو أحد القيم التالية المحدّدة مسبقًا:

  • account
  • customer
  • loginId
  • network
  • organization
formattedType

string

النتائج فقط. نوع الحدث المترجَم وتنسيقه في لغة حساب المُشاهد أو لغة عنوان HTTP Accept-Language

FileAs

الاسم الذي يجب استخدامه لترتيب الشخص في قائمة.

تمثيل JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
الحقول
metadata

object (FieldMetadata)

بيانات التعريف حول الملف باسم.

value

string

تشير قيمة file-as إلى ...

الجنس

جنس المستخدم

تمثيل JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "formattedValue": string,
  "addressMeAs": string
}
الحقول
metadata

object (FieldMetadata)

بيانات التعريف عن الجنس.

value

string

تمثّل هذه السمة الجنس للشخص. ويمكن أن يكون الجنس مخصّصًا أو إحدى القيم المحدّدة مسبقًا التالية:

  • male
  • female
  • unspecified
formattedValue

string

النتائج فقط. قيمة الجنس التي تمت ترجمتها وتنسيقها في لغة حساب المُشاهد أو لغة عنوان HTTP Accept-Language. لا تتم ترجمة القيم غير المحدَّدة أو المخصّصة.

addressMeAs

string

حقل نصي يتضمّن تصميمًا مجانيًا للضمائر التي يجب استخدامها لمخاطبة الأشخاص القيم الشائعة هي:

  • he/him
  • she/her
  • they/them

ImClient

برنامج المراسلة الفورية لأحد الأشخاص.

تمثيل JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "username": string,
  "type": string,
  "formattedType": string,
  "protocol": string,
  "formattedProtocol": string
}
الحقول
metadata

object (FieldMetadata)

بيانات وصفية عن عميل المراسلة الفورية

username

string

اسم المستخدم في برنامج المراسلة الفورية

type

string

نوع عميل المراسلة الفورية ويمكن أن يكون النوع مخصّصًا أو أحد القيم التالية المحدّدة مسبقًا:

  • home
  • work
  • other
formattedType

string

النتائج فقط. نوع برنامج الرسائل الفورية المترجَم وتنسيقه في لغة حساب المُشاهد أو لغة عنوان HTTP Accept-Language.

protocol

string

بروتوكول عميل المراسلة الفورية. يمكن أن يكون البروتوكول مخصّصًا أو أحد القيم التالية المحدّدة مسبقًا:

  • aim
  • msn
  • yahoo
  • skype
  • qq
  • googleTalk
  • icq
  • jabber
  • netMeeting
formattedProtocol

string

النتائج فقط. تمثّل هذه السمة بروتوكول برنامج الرسائل الفورية المنسّق في لغة حساب المشاهد أو لغة عنوان HTTP Accept-Language.

الاهتمام

أحد اهتمامات الشخص.

تمثيل JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
الحقول
metadata

object (FieldMetadata)

بيانات وصفية حول الاهتمام

value

string

الاهتمام، على سبيل المثال، stargazing.

اللغة

اللغة المفضَّلة للشخص.

تمثيل JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
الحقول
metadata

object (FieldMetadata)

البيانات الوصفية حول اللغة

value

string

علامة اللغة IETF BCP 47 المنسَّقة بشكل صحيح والتي تمثّل اللغة

الموقع الجغرافي

الموقع الجغرافي للمستخدم

تمثيل JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": string,
  "current": boolean,
  "buildingId": string,
  "floor": string,
  "floorSection": string,
  "deskCode": string
}
الحقول
metadata

object (FieldMetadata)

البيانات الوصفية حول الموقع الجغرافي

value

string

القيمة الحرة للموقع الجغرافي.

type

string

نوع الموقع الجغرافي. ويمكن أن يكون النوع مخصّصًا أو أحد القيم التالية المحدّدة مسبقًا:

  • desk
  • grewUp
current

boolean

ما إذا كان الموقع الجغرافي هو الموقع الجغرافي الحالي

buildingId

string

معرّف المبنى.

floor

string

تمثّل هذه السمة اسم الطابق أو رقمه.

floorSection

string

قسم الطابق في floor_name

deskCode

string

تمثّل هذه السمة الموقع الجغرافي للمكتب.

الاشتراك

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

تمثيل JSON
{
  "metadata": {
    object (FieldMetadata)
  },

  // Union field membership can be only one of the following:
  "contactGroupMembership": {
    object (ContactGroupMembership)
  },
  "domainMembership": {
    object (DomainMembership)
  }
  // End of list of possible types for union field membership.
}
الحقول
metadata

object (FieldMetadata)

بيانات التعريف حول الاشتراك

حقل الاتحاد membership العضوية. يمكن أن يكون الحقل "membership" واحدًا فقط مما يلي:
contactGroupMembership

object (ContactGroupMembership)

عضوية مجموعة جهات الاتصال.

domainMembership

object (DomainMembership)

النتائج فقط. عضوية النطاق.

ContactGroupMembership

اشتراك في مجموعة "جهات اتصال Google"

تمثيل JSON
{
  "contactGroupId": string,
  "contactGroupResourceName": string
}
الحقول
contactGroupId
(deprecated)

string

النتائج فقط. رقم تعريف مجموعة جهات الاتصال لعضوية مجموعة جهات الاتصال.

contactGroupResourceName

string

اسم المورد لمجموعة جهات الاتصال، الذي يعينه الخادم. تمثّل هذه السمة سلسلة ASCII على شكل contactGroups/{contactGroupId}. يمكن استخدام contactGroupResourceName فقط لتعديل العضويات. يمكن إزالة أي عضوية في مجموعة جهات اتصال، ولكن يمكن إضافة مجموعة مستخدمين أو مجموعات نظام "myContacts" أو "مميّزة بنجمة" فقط. يجب أن يكون لجهة الاتصال دائمًا عضوية واحدة على الأقل في مجموعة جهات اتصال.

DomainMembership

اشتراك في نطاق Google Workspace:

تمثيل JSON
{
  "inViewerDomain": boolean
}
الحقول
inViewerDomain

boolean

صحيح إذا كان المستخدم ضمن نطاق Google Workspace للمُشاهد.

MiscKeyword

الكلمة الرئيسية المتنوعة لأحد الأشخاص.

تمثيل JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": enum (KeywordType),
  "formattedType": string
}
الحقول
metadata

object (FieldMetadata)

البيانات الوصفية عن الكلمات الرئيسية المتنوعة

value

string

قيمة الكلمة الرئيسية المتنوعة.

type

enum (KeywordType)

نوع الكلمات الرئيسية المتنوعة.

formattedType

string

النتائج فقط. نوع الكلمة الرئيسية المتنوعة التي تمت ترجمتها وتنسيقها في لغة حساب المشاهد أو لغة عنوان HTTP Accept-Language.

KeywordType

نوع كلمة رئيسية متنوعة.

عمليات التعداد
TYPE_UNSPECIFIED غير محدد
OUTLOOK_BILLING_INFORMATION حقل Outlook لمعلومات الفوترة.
OUTLOOK_DIRECTORY_SERVER حقل Outlook لخادم الدليل.
OUTLOOK_KEYWORD حقل Outlook للكلمة الرئيسية.
OUTLOOK_MILEAGE حقل توقعات للمسافة المقطوعة
OUTLOOK_PRIORITY حقل Outlook للأولوية.
OUTLOOK_SENSITIVITY حقل Outlook للحساسية.
OUTLOOK_SUBJECT حقل Outlook للموضوع.
OUTLOOK_USER حقل Outlook للمستخدم.
HOME المنزل.
WORK العمل.
OTHER غير ذلك

الاسم

تمثّل هذه السمة اسم المستخدم. وإذا كان الاسم اسمًا مختصرًا، يكون اسم العائلة فارغًا.

تمثيل JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "displayName": string,
  "displayNameLastFirst": string,
  "unstructuredName": string,
  "familyName": string,
  "givenName": string,
  "middleName": string,
  "honorificPrefix": string,
  "honorificSuffix": string,
  "phoneticFullName": string,
  "phoneticFamilyName": string,
  "phoneticGivenName": string,
  "phoneticMiddleName": string,
  "phoneticHonorificPrefix": string,
  "phoneticHonorificSuffix": string
}
الحقول
metadata

object (FieldMetadata)

بيانات التعريف حول الاسم

displayName

string

النتائج فقط. الاسم المعروض الذي تم تنسيقه وفقًا للّغة المحدّدة في حساب المشاهد أو عنوان HTTP Accept-Language.

displayNameLastFirst

string

النتائج فقط. الاسم المعروض مع تنسيق اسم العائلة أولاً وفقًا للّغة المحدّدة في حساب المشاهد أو عنوان HTTP Accept-Language.

unstructuredName

string

تمثّل هذه السمة قيمة اسم التصميم المرن.

familyName

string

اسم العائلة

givenName

string

الاسم الذي أدخلته.

middleName

string

تمثّل هذه السمة الاسم الأوسط.

honorificPrefix

string

البادئات الشرفية، مثل Mrs. أو Dr.

honorificSuffix

string

اللاحقات التشريفية، مثل Jr.

phoneticFullName

string

عليك كتابة الاسم الكامل على النحو الموضّح.

phoneticFamilyName

string

اسم العائلة يُهجى كما يبدو.

phoneticGivenName

string

يتم تهجئة الاسم الذي تم إدخاله كما يبدو.

phoneticMiddleName

string

الاسم الأوسط مكتوبًا بالطريقة نفسها.

phoneticHonorificPrefix

string

البادئات الشرفية تُكتب كما هي.

phoneticHonorificSuffix

string

اللاحقات التشريفية مكتوبة بالطريقة نفسها.

اللقب

لقب المستخدم.

تمثيل JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": enum (NicknameType)
}
الحقول
metadata

object (FieldMetadata)

البيانات الوصفية حول اللقب

value

string

اللقب.

type

enum (NicknameType)

تمثّل هذه السمة نوع اللقب.

NicknameType

تمثّل هذه السمة نوع اللقب.

عمليات التعداد
DEFAULT لقب عام.
MAIDEN_NAME

اسم العائلة قبل الزواج أو اسم العائلة. يُستخدم عند تغيير اسم عائلة الشخص نتيجة الزواج.

INITIALS

الأحرف الأولى

GPLUS

لقب الملف الشخصي في Google+.

OTHER_NAME

ارتباط مهني أو اسم آخر، مثل Dr. Smith.

ALTERNATE_NAME الاسم البديل معروف بواسطة.
SHORT_NAME

نسخة أقصر من اسم الشخص.

المهنة

مهنة شخص.

تمثيل JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
الحقول
metadata

object (FieldMetadata)

بيانات وصفية حول المهنة.

value

string

المهنة، على سبيل المثال، carpenter.

مؤسسة

المؤسسة الحالية أو السابقة للمستخدم النطاقات الزمنية المتداخلة مسموح بها.

تمثيل JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "type": string,
  "formattedType": string,
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  },
  "current": boolean,
  "name": string,
  "phoneticName": string,
  "department": string,
  "title": string,
  "jobDescription": string,
  "symbol": string,
  "domain": string,
  "location": string,
  "costCenter": string,
  "fullTimeEquivalentMillipercent": integer
}
الحقول
metadata

object (FieldMetadata)

بيانات التعريف حول المؤسسة.

type

string

نوع المؤسسة. ويمكن أن يكون النوع مخصّصًا أو أحد القيم التالية المحدّدة مسبقًا:

  • work
  • school
formattedType

string

النتائج فقط. نوع المؤسسة الذي تمت الترجمة وتنسيقه في لغة حساب المشاهد أو لغة عنوان HTTP Accept-Language.

startDate

object (Date)

تاريخ البدء الذي انضم فيه الشخص إلى المؤسسة.

endDate

object (Date)

تاريخ الانتهاء عندما غادر الشخص المؤسسة.

current

boolean

صحيح إذا كانت المؤسسة هي المؤسسة الحالية للشخص، وخطأ إذا كانت المؤسسة في الماضي.

name

string

اسم المؤسسة

phoneticName

string

تمثّل هذه السمة الاسم الصوتي للمؤسسة.

department

string

قسم الشخص في المؤسسة.

title

string

المسمى الوظيفي للشخص في المؤسسة.

jobDescription

string

الوصف الوظيفي للشخص في المؤسسة.

symbol

string

الرمز المرتبط بالمؤسسة، على سبيل المثال، رمز شريط أسهم أو اختصار أو اختصار.

domain

string

تمثّل هذه السمة اسم النطاق المرتبط بالمؤسسة، على سبيل المثال، google.com.

location

string

تمثّل هذه السمة الموقع الجغرافي لمكتب المؤسسة الذي يعمل فيه الشخص.

costCenter

string

مركز التكلفة للشخص في المؤسسة.

fullTimeEquivalentMillipercent

integer

النسبة المئوية للملليِن بدوام كامل للشخص داخل المؤسسة (100,000 = 100%).

PhoneNumber

رقم هاتف أحد المستخدمين

تمثيل JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "canonicalForm": string,
  "type": string,
  "formattedType": string
}
الحقول
metadata

object (FieldMetadata)

البيانات الوصفية حول رقم الهاتف

value

string

رقم الهاتف

canonicalForm

string

النتائج فقط. النموذج ITU-T E.164 المتعارف عليه لرقم الهاتف

type

string

نوع رقم الهاتف. ويمكن أن يكون النوع مخصّصًا أو أحد القيم التالية المحدّدة مسبقًا:

  • home
  • work
  • mobile
  • homeFax
  • workFax
  • otherFax
  • pager
  • workMobile
  • workPager
  • main
  • googleVoice
  • other
formattedType

string

النتائج فقط. تشير هذه السمة إلى نوع رقم الهاتف المترجَم وتنسيقه في لغة حساب المشاهد أو لغة عنوان HTTP Accept-Language.

صورة

صورة شخص صورة معروضة بجانب اسم الشخص لمساعدة الآخرين في التعرّف عليه.

تمثيل JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "url": string,
  "default": boolean
}
الحقول
metadata

object (FieldMetadata)

البيانات الوصفية حول الصورة

url

string

عنوان URL للصورة يمكنك تغيير المقاس المطلوب من خلال إلحاق معلَمة طلب البحث sz={size} في نهاية عنوان URL، حيث يكون {size} هو الحجم بالبكسل. مثال: https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50

default

boolean

True إذا كانت الصورة صورة افتراضية، وfalse إذا كانت الصورة صورة مقدمة من المستخدم.

العلاقة

علاقة الشخص بشخص آخر.

تمثيل JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "person": string,
  "type": string,
  "formattedType": string
}
الحقول
metadata

object (FieldMetadata)

بيانات التعريف حول العلاقة.

person

string

اسم الشخص الآخر الذي تشير إليه هذه العلاقة.

type

string

علاقة الشخص بالشخص الآخر. ويمكن أن يكون النوع مخصّصًا أو أحد القيم التالية المحدّدة مسبقًا:

  • spouse
  • child
  • mother
  • father
  • parent
  • brother
  • sister
  • friend
  • relative
  • domesticPartner
  • manager
  • assistant
  • referredBy
  • partner
formattedType

string

النتائج فقط. نوع العلاقة المترجمة وتنسيقها في لغة حساب المشاهد أو اللغة المحدّدة في عنوان HTTP Accept-Language

RelationshipInterest

تم إيقافها: لن يتم عرض أي بيانات عن علاقة الشخص .

تمثيل JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "formattedValue": string
}
الحقول
metadata

object (FieldMetadata)

بيانات وصفية حول العلاقة بين المعلِن

value

string

نوع العلاقة التي يبحث عنها الشخص. يمكن أن تكون القيمة مخصّصة أو إحدى القيم المحدّدة مسبقًا التالية:

  • friend
  • date
  • relationship
  • networking
formattedValue

string

النتائج فقط. قيمة العلاقة بالعلاقة التي تتم ترجمتها وتنسيقها في لغة حساب المشاهد أو اللغة المحدّدة في عنوان HTTP الخاص بالموافقة على اللغة.

RelationshipStatus

تم إيقافها: لن يتم عرض أي بيانات عن الحالة الاجتماعية للشخص.

تمثيل JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "formattedValue": string
}
الحقول
metadata

object (FieldMetadata)

بيانات التعريف حول حالة العلاقة.

value

string

حالة العلاقة. يمكن أن تكون القيمة مخصّصة أو إحدى القيم المحدّدة مسبقًا التالية:

  • single
  • inARelationship
  • engaged
  • married
  • itsComplicated
  • openRelationship
  • widowed
  • inDomesticPartnership
  • inCivilUnion
formattedValue

string

النتائج فقط. قيمة حالة العلاقة تتم ترجمتها وتنسيقها في لغة حساب المُشاهد أو لغة عنوان HTTP Accept-Language.

الإقامة

تم إيقافها: يُرجى استخدام person.locations بدلاً منها. مكان الإقامة السابق أو الحالي للشخص

تمثيل JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "current": boolean
}
الحقول
metadata

object (FieldMetadata)

بيانات وصفية حول مكان الإقامة.

value

string

تمثّل هذه السمة عنوان الإقامة.

current

boolean

صحيح إذا كان مكان الإقامة هو محل الإقامة الحالي للشخص، وعلى خطأ إذا كان مكان الإقامة هو محل إقامة سابق.

SipAddress

عنوان SIP لمستخدم. يتم استخدام عناوين البروتوكول الأولية للجلسة لاتصالات VoIP لإجراء مكالمات صوتية أو مكالمات فيديو على الإنترنت.

تمثيل JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": string,
  "formattedType": string
}
الحقول
metadata

object (FieldMetadata)

البيانات الوصفية حول عنوان SIP.

value

string

عنوان SIP بتنسيق معرّف الموارد المنتظم (URI) لبروتوكول SIP RFC 3261 19.1.

type

string

نوع عنوان SIP. ويمكن أن يكون النوع مخصّصًا أو أحد القيم التالية المحدّدة مسبقًا:

  • home
  • work
  • mobile
  • other
formattedType

string

النتائج فقط. تشير هذه السمة إلى نوع عنوان SIP المترجَم وتنسيقه في لغة حساب المُشاهد أو لغة عنوان HTTP Accept-Language.

المهارة

مهارة يمتلكها الشخص.

تمثيل JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
الحقول
metadata

object (FieldMetadata)

بيانات التعريف حول المهارة.

value

string

المهارة، على سبيل المثال، underwater basket weaving.

جملة ترويجية

متوقف: لن يتم عرض أي بيانات. سيتم عرض وصف موجز من سطر واحد للشخص.

تمثيل JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
الحقول
metadata

object (FieldMetadata)

البيانات الوصفية حول الجملة الترويجية

value

string

الجملة الترويجية.

عنوان URL

عناوين URL المرتبطة بأحد الأشخاص

تمثيل JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": string,
  "formattedType": string
}
الحقول
metadata

object (FieldMetadata)

البيانات الوصفية حول عنوان URL

value

string

عنوان URL.

type

string

نوع عنوان URL. ويمكن أن يكون النوع مخصّصًا أو أحد القيم التالية المحدّدة مسبقًا:

  • home
  • work
  • blog
  • profile
  • homePage
  • ftp
  • reservations
  • appInstallPage: الموقع الإلكتروني لتطبيق Currents
  • other
formattedType

string

النتائج فقط. نوع عنوان URL الذي تمت الترجمة وتنسيقه في لغة حساب المشاهد أو لغة عنوان HTTP Accept-Language.

UserDefined

بيانات المستخدمين العشوائية التي يملأها المستخدمون.

تمثيل JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "key": string,
  "value": string
}
الحقول
metadata

object (FieldMetadata)

بيانات التعريف حول البيانات التي يحددها المستخدم.

key

string

مفتاح تحديد المستخدم النهائي للبيانات التي يحدِّدها المستخدم.

value

string

القيمة المحدّدة للمستخدم النهائي للبيانات التي يحدِّدها المستخدم.

الطُرق

batchCreateContacts

قم بإنشاء مجموعة من جهات الاتصال الجديدة وعرض PersonResponses لأول مرة

يجب إرسال طلبات التبديل للمستخدم نفسه بشكل تسلسلي لتجنُّب زيادة وقت الاستجابة وعمليات الإخفاق.

batchDeleteContacts

حذف مجموعة من جهات الاتصال

batchUpdateContacts

قم بتحديث مجموعة من جهات الاتصال وإرجاع خريطة لأسماء الموارد إلى PersonResponses لجهات الاتصال التي تم تحديثها.

createContact

إنشاء جهة اتصال جديدة وعرض مورد الشخص لجهة الاتصال هذه.

deleteContact

حذف جهة اتصال

deleteContactPhoto

حذف صورة جهة اتصال

get

توفر معلومات عن أحد الأشخاص من خلال تحديد اسم مورد.

getBatchGet

يوفر معلومات عن قائمة أشخاص محددين عن طريق تحديد قائمة بأسماء الموارد المطلوبة.

listDirectoryPeople

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

searchContacts

توفّر هذه السياسة قائمة بجهات الاتصال في جهات الاتصال المجمَّعة للمستخدم الذي تمت المصادقة عليه والتي تتطابق مع طلب البحث.

searchDirectoryPeople

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

updateContact

تعديل بيانات جهة الاتصال لجهة اتصال حالية

updateContactPhoto

تعديل صورة جهة الاتصال