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. Если у Person есть больше телефонных номеров, весь набор можно получить, вызвав 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

Только вывод. True, если ресурс person был удален. Заполняется только для запросов синхронизации 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 .

Метаданные об источнике типа ПРОФИЛЬ.

Тип источника

Тип источника.

Перечисления
SOURCE_TYPE_UNSPECIFIED Не указано.
ACCOUNT Аккаунт Google .
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 )

Только вывод. Пользователь печатает.

ТипОбъекта

Тип объекта-человека.

Перечисления
OBJECT_TYPE_UNSPECIFIED Не указано.
PERSON Человек.
PAGE Страница текущих событий.

Тип пользователя

Тип пользователя.

Перечисления
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 альфа-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

True, если обложка является фотографией обложки по умолчанию; 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 )

Метаданные о файле-as.

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

ImClient

Клиент обмена мгновенными сообщениями для человека.

JSON-представление 
{
  "metadata": {
    object (FieldMetadata)
  },
  "username": string,
  "type": string,
  "formattedType": string,
  "protocol": string,
  "formattedProtocol": string
}
Поля
metadata

object ( FieldMetadata )

Метаданные о IM-клиенте.

username

string

Имя пользователя, используемое в IM-клиенте.

type

string

Тип клиента обмена мгновенными сообщениями. Тип может быть пользовательским или одним из следующих предопределенных значений:

  • home
  • work
  • other
formattedType

string

Только вывод. Тип клиента обмена мгновенными сообщениями, переведенный и отформатированный в языковом стандарте учетной записи зрителя или языковом стандарте HTTP-заголовка Accept-Language .

protocol

string

Протокол IM-клиента. Протокол может быть пользовательским или иметь одно из следующих предопределенных значений:

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

Только вывод. Членство в домене.

КонтактГруппаЧленство

Членство в контактной группе Google.

JSON-представление 
{
  "contactGroupId": string,
  "contactGroupResourceName": string
}
Поля
contactGroupId
(deprecated)

string

Только вывод. Идентификатор группы контактов для членства в группе контактов.

contactGroupResourceName

string

Имя ресурса для группы контактов, назначенное сервером. Строка ASCII в форме contactGroups/{contactGroupId} . Для изменения членства можно использовать только contactGroupResourceName. Любое членство в группе контактов можно удалить, но можно добавить только членство в группах пользователей или в системных группах «Мои контакты» или «Избранные». Контакт всегда должен иметь хотя бы одно членство в группе контактов.

Членство в домене

Членство в домене Google Workspace.

JSON-представление 
{
  "inViewerDomain": boolean
}
Поля
inViewerDomain

boolean

True, если человек находится в домене 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

Истинно, если организация является текущей организацией человека; false, если организация является прошлой организацией.

name

string

Название организации.

phoneticName

string

Фонетическое название организации.

department

string

Отделение человека в организации.

title

string

Должность человека в организации.

jobDescription

string

Должностная инструкция человека в организации.

symbol

string

Символ, связанный с организацией; например, биржевой символ, аббревиатура или аббревиатура.

domain

string

Доменное имя, связанное с организацией; например, google.com .

location

string

Место нахождения офиса организации, в котором работает человек.

costCenter

string

Центр затрат человека в организации.

fullTimeEquivalentMillipercent

integer

Миллипроцент, эквивалентный полной занятости человека в организации (100 000 = 100%).

Номер телефона

Номер телефона человека.

JSON-представление 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "canonicalForm": string,
  "type": string,
  "formattedType": string
}
Поля
metadata

object ( FieldMetadata )

Метаданные о номере телефона.

value

string

Номер телефона.

canonicalForm

string

Только вывод. Канонизированная форма телефонного номера ITU-T E.164 .

type

string

Тип номера телефона. Тип может быть пользовательским или одним из следующих предопределенных значений:

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

string

Только вывод. Тип номера телефона, переведенный и отформатированный в языковом стандарте учетной записи зрителя или языковом стандарте HTTP-заголовка Accept-Language .

Фото

Фотография человека. Изображение рядом с именем человека, чтобы помочь другим узнать его.

JSON-представление 
{
  "metadata": {
    object (FieldMetadata)
  },
  "url": string,
  "default": boolean
}
Поля
metadata

object ( FieldMetadata )

Метаданные о фотографии.

url

string

URL-адрес фотографии. Вы можете изменить желаемый размер, добавив параметр запроса sz={size} в конце URL-адреса, где {size} — это размер в пикселях. Пример: https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50 .

default

boolean

True, если фотография является фотографией по умолчанию; false, если фотография предоставлена ​​пользователем.

Связь

Отношение человека к другому человеку.

JSON-представление 
{
  "metadata": {
    object (FieldMetadata)
  },
  "person": string,
  "type": string,
  "formattedType": string
}
Поля
metadata

object ( FieldMetadata )

Метаданные об отношении.

person

string

Имя другого человека, к которому относится это отношение.

type

string

Отношение человека к другому человеку. Тип может быть пользовательским или одним из следующих предопределенных значений:

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

string

Только вывод. Тип отношения, преобразованного и отформатированного в языковом стандарте учетной записи средства просмотра или языковом стандарте, указанном в HTTP-заголовке Accept-Language.

ОтношенияИнтерес

УСТАРЕЛО : данные не будут возвращены. Интерес человека в отношениях.

JSON-представление 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "formattedValue": string
}
Поля
metadata

object ( FieldMetadata )

Метаданные об интересах отношений.

value

string

Какие отношения ищет человек. Значение может быть пользовательским или одним из следующих предопределенных значений:

  • friend
  • date
  • relationship
  • networking
formattedValue

string

Только вывод. Значение отношения, переведенное и отформатированное в языковом стандарте учетной записи зрителя или языковом стандарте, указанном в HTTP-заголовке Accept-Language.

Статус отношений

УСТАРЕЛО : данные не будут возвращены. Статус отношений человека.

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, если место жительства является прошлым местом жительства.

SIP-адрес

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 .

Определяется пользователем

Произвольные пользовательские данные, заполняемые конечными пользователями.

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

 Обновите фотографию контакта.