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) "زولو" بدقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "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.

العنوان

العنوان الجغرافي للشخص قد يكون P.O. المربع أو عنوان الشارع. وجميع الحقول اختيارية.

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

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

sourcePrimary

boolean

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

verified

boolean

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

source

object (Source)

مصدر الحقل.

معدل العمر

تم الإيقاف (يُرجى استخدام 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

صحيح إذا كانت صورة الغلاف هي صورة الغلاف الافتراضية؛ 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

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

اسم المستخدم المستخدم في برنامج المراسلة الفورية (IM).

type

string

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

  • home
  • work
  • other
formattedType

string

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

protocol

string

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

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

string

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

صحيح إذا كانت المؤسسة هي المؤسسة الحالية للشخص، false إذا كانت المؤسسة هي مؤسسة سابقة.

name

string

اسم المؤسسة

phoneticName

string

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

department

string

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

title

string

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

jobDescription

string

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

symbol

string

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

domain

string

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

location

string

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

costCenter

string

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

fullTimeEquivalentMillipercent

integer

مئة مئة في المئة بالنسبة إلى الشخص بدوام كامل في المؤسسة (100000 = 100%).

رقم الهاتف

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

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

صواب إذا كانت الصورة هي صورة افتراضية؛ 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 مقبولة.

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

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

SipAddress

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

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

object (FieldMetadata)

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

value

string

يكون عنوان SIP بتنسيق RFC 3261 19.1 SIP URI.

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

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