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 )

نشانی‌های اینترنتی تقویم افراد.

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 )

نشانی‌های وب مرتبط شخص.

userDefined[]

object ( UserDefined )

داده های تعریف شده توسط کاربر شخص.

Metadata شخص

فراداده در مورد یک شخص

نمایندگی 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 پر شده است.metadata.sources.

تگ موجودیت HTTP منبع. برای اعتبار سنجی وب کش استفاده می شود.

updateTime

string ( Timestamp format)

فقط خروجی فقط به صورت person.metadata.sources پر شده است.metadata.sources.

آخرین به روز رسانی مهر زمانی این منبع.

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

metadata میدان اتحادیه فقط به صورت person.metadata.sources پر شده است.metadata.sources.

فراداده در مورد منبع metadata تنها می تواند یکی از موارد زیر باشد:

profileMetadata

object ( ProfileMetadata )

فقط خروجی فقط به صورت person.metadata.sources پر شده است.metadata.sources.

فراداده درباره منبعی از نوع PROFILE.

SourceType

نوع منبع

Enums
SOURCE_TYPE_UNSPECIFIED نامشخص
ACCOUNT حساب کاربری گوگل .
PROFILE نمایه گوگل می‌توانید نمایه را در https://profiles.google.com/ {id} مشاهده کنید، جایی که {id} شناسه منبع است.
DOMAIN_PROFILE نمایه دامنه Google Workspace .
CONTACT تماس گوگل . می‌توانید مخاطب را در 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 )

فقط خروجی کاربر تایپ می کند.

ObjectType

نوع اعتراض شخص

Enums
OBJECT_TYPE_UNSPECIFIED نامشخص
PERSON شخص
PAGE صفحه جریان ها.

نوع کاربر

نوع کاربر.

Enums
USER_TYPE_UNKNOWN نوع کاربر مشخص نیست.
GOOGLE_USER کاربر یک کاربر گوگل است.
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

فقط خروجی درست است اگر فیلد فیلد اصلی برای همه منابع در شخص باشد. هر فرد حداکثر یک فیلد با مجموعه primary برابر با true خواهد داشت.

sourcePrimary

boolean

اگر فیلد فیلد اصلی source باشد درست است. هر منبع باید حداکثر یک فیلد داشته باشد که sourcePrimary روی true تنظیم شده باشد.

verified

boolean

فقط خروجی درست است اگر فیلد تأیید شود. false اگر فیلد تأیید نشده باشد. یک فیلد تأیید شده معمولاً نام، آدرس ایمیل، شماره تلفن یا وب‌سایتی است که تأیید شده است که متعلق به آن شخص است.

source

object ( Source )

منبع میدان.

رده سنی

منسوخ شده (لطفاً به جای آن از person.ageRanges استفاده کنید)

محدوده سنی یک فرد.

Enums
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 )

نوع محتوای بیوگرافی.

نوع محتوا

نوع محتوا.

Enums
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

نشانی وب تقویم یک شخص.

نمایندگی JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "url": string,
  "type": string,
  "formattedType": string
}
زمینه های
metadata

object ( FieldMetadata )

فراداده درباره URL تقویم.

url

string

آدرس تقویم

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

آدرس عکس روی جلد.

default

boolean

درست است اگر عکس روی جلد عکس پیش‌فرض روی جلد باشد. اگر عکس روی جلد یک عکس روی جلد ارائه شده توسط کاربر باشد، نادرست است.

آدرس ایمیل

آدرس ایمیل یک شخص

نمایندگی 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 )

فراداده در مورد file-as.

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 )

فراداده در مورد مشتری IM.

username

string

نام کاربری استفاده شده در سرویس گیرنده IM.

type

string

نوع مشتری IM. نوع می تواند سفارشی یا یکی از این مقادیر از پیش تعریف شده باشد:

  • home
  • work
  • other
formattedType

string

فقط خروجی نوع کلاینت پیام فوری ترجمه و قالب‌بندی شده در محلی حساب بیننده یا زبان محلی هدر HTTP Accept-Language .

protocol

string

پروتکل مشتری IM. پروتکل می تواند سفارشی یا یکی از این مقادیر از پیش تعریف شده باشد:

  • 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 )

فقط خروجی عضویت دامنه

عضویت در گروه تماس

عضویت در گروه تماس 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 بیننده باشد.

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 .

نوع کلمه کلیدی

نوع کلمه کلیدی متفرقه

Enums
TYPE_UNSPECIFIED نامشخص
OUTLOOK_BILLING_INFORMATION فیلد چشم انداز برای اطلاعات صورتحساب.
OUTLOOK_DIRECTORY_SERVER فیلد Outlook برای سرور دایرکتوری.
OUTLOOK_KEYWORD فیلد چشم انداز برای کلمه کلیدی.
OUTLOOK_MILEAGE میدان چشم انداز برای مسافت پیموده شده.
OUTLOOK_PRIORITY فیلد چشم انداز برای اولویت.
OUTLOOK_SENSITIVITY زمینه چشم انداز برای حساسیت.
OUTLOOK_SUBJECT زمینه چشم انداز برای موضوع.
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

فقط خروجی نام نمایشی با توجه به محلی که توسط حساب بیننده یا هدر Accept-Language HTTP مشخص شده است، قالب‌بندی شده است.

displayNameLastFirst

string

فقط خروجی نام نمایشی با نام خانوادگی که ابتدا با توجه به محلی مشخص شده توسط حساب بیننده یا هدر Accept-Language HTTP فرمت شده است.

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 )

نوع نام مستعار.

نوع مستعار

نوع نام مستعار.

Enums
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%).

شماره تلفن

شماره تلفن یک شخص

نمایندگی 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

آدرس عکس. می توانید اندازه مورد نظر را با اضافه کردن یک پارامتر پرس و جو sz={size} در انتهای آدرس اینترنتی تغییر دهید، جایی که {size} اندازه آن به پیکسل است. مثال: https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50

default

boolean

درست است اگر عکس یک عکس پیش فرض باشد. نادرست است اگر عکس یک عکس ارائه شده توسط کاربر باشد.

رابطه

رابطه شخص با شخص دیگر.

نمایندگی 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

فقط خروجی نوع رابطه ترجمه شده و قالب‌بندی شده در زبان حساب بیننده یا محلی که در سرصفحه Accept-Language HTTP مشخص شده است.

علاقه رابطه

منسوخ شده : هیچ داده ای برگردانده نمی شود علاقه رابطه شخص.

نمایندگی JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "formattedValue": string
}
زمینه های
metadata

object ( FieldMetadata )

فراداده در مورد علاقه رابطه

value

string

نوع رابطه ای که فرد به دنبال آن است. مقدار می تواند سفارشی یا یکی از این مقادیر از پیش تعریف شده باشد:

  • friend
  • date
  • relationship
  • networking
formattedValue

string

فقط خروجی مقدار علاقه رابطه ترجمه و قالب‌بندی شده در محلی حساب بیننده یا منطقه محلی مشخص شده در سرصفحه Accept-Language 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

درست است اگر محل سکونت محل سکونت فعلی فرد باشد. اگر محل سکونت محل سکونت قبلی باشد، نادرست است.

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

شعار.

آدرس اینترنتی

نشانی‌های وب مرتبط یک شخص.

نمایندگی 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

 عکس یک مخاطب را به روز کنید.