REST Resource: people

تنظيم صفحاتك في مجموعات يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.

المورد: الشخص

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

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

تمثيل 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)

البيانات التي يحددها المستخدم.

البيانات الوصفية للأشخاص

البيانات الوصفية عن شخص

تمثيل 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,
  "profileMetadata": {
    object (ProfileMetadata)
  }
}
الحقول
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".
profileMetadata

object (ProfileMetadata)

الإخراج فقط. يتم التعبئة في person.metadata.sources فقط.

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

نوع المصدر

نوع المصدر.

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

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

البيانات الوصفية المتعلّقة بملف شخصي

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

enum (ObjectType)

الإخراج فقط. نوع كائن الملف الشخصي.
userTypes[]

enum (UserType)

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

نوع الكائن

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

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

نوع المستخدم

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

عمليات التعداد
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 للعنوان.

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

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

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

boolean

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

boolean

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

boolean

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

object (Source)

مصدر الحقل.

معدل العمر

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

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

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

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

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

تمثيل 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)

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

نوع المحتوى

نوع المحتوى.

عمليات التعداد
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 لتحديد سنة بمفردها أو السنة والشهر حيث لا يكون اليوم كبيرًا.

مغرور

متوقّف: لن يتم إرجاع أي بيانات تتباهى بها جهة معيّنة.

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

object (FieldMetadata)

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

string

حقوق التباهي، مثل climbed mount everest

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

عنوان 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.

بيانات العميل

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

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

object (FieldMetadata)

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

string

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

string

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

صورة الغلاف

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

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

object (FieldMetadata)

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

string

عنوان URL لصورة الغلاف.
default

boolean

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

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

عنوان البريد الإلكتروني لشخص.

تمثيل 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.

الرقم التعريفي الخارجي

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

تمثيل 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.

ملف باسم

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

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

object (FieldMetadata)

البيانات الوصفية لملف بتنسيق.
value

string

القيمة كملف

الجنس

جنس الشخص.

تمثيل 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

إمام

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

تمثيل 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

الإخراج فقط. تمت ترجمة نوع برنامج المراسلة الفورية (IM) وتنسيقه في لغة حساب المشاهد أو في لغة عنوان 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)

الإخراج فقط. عضوية النطاق.

عضوية ContactGroup

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

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

string

الإخراج فقط. رقم تعريف مجموعة جهات الاتصال لعضوية مجموعة جهات الاتصال.
contactGroupResourceName

string

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

عضوية النطاق

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

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

boolean

صحيح إذا كان الشخص في نطاق Google Workspace للمشاهد.

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

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

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

object (FieldMetadata)

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

string

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

enum (KeywordType)

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

string

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

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

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

عمليات التعداد
TYPE_UNSPECIFIED غير محدد
OUTLOOK_BILLING_INFORMATION حقل Outlook لمعلومات الفوترة.
OUTLOOK_DIRECTORY_SERVER حقل Outlook لخادم الدليل.
OUTLOOK_KEYWORD Outlook في حقل الكلمة الرئيسية.
OUTLOOK_MILEAGE حقل Outlook للمسافة بالميل.
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)

نوع اللقب

اللقب

نوع اللقب

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

القيمة المئوية بالملي ثانية التي يعمل بها الشخص بدوام كامل في المؤسسة (100000 = 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 التي تقبل اللغة.

الاهتمام بالعلاقات

مُعطل: لن يتم عرض أي بيانات لمصلحة علاقة الشخص .

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

object (FieldMetadata)

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

string

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

  • friend
  • date
  • relationship
  • networking
formattedValue

string

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

حالة العلاقة

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

تمثيل 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

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

عنوان SIP

عنوان 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.

من تحديد المستخدم

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

تمثيل 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

 تحديث صورة جهة اتصال.