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

Только вывод. Истинно, если ресурс человека был удален. Заполняется только для запросов синхронизации people.connections.list и otherContacts.list .

objectType
(deprecated)

enum ( ObjectType )

Только вывод. УСТАРЕЛО (вместо этого используйте person.metadata.sources.profileMetadata.objectType )

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

Источник

Источник поля.

Представление JSON
{
  "type": enum (SourceType),
  "id": string,
  "etag": string,
  "updateTime": string,
  "profileMetadata": {
    object (ProfileMetadata)
  }
}
Поля
type

enum ( SourceType )

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

id

string

Уникальный идентификатор в исходном типе, сгенерированный сервером.

etag

string

Заполняется только в person.metadata.sources .

Тег сущности HTTP источника. Используется для проверки веб-кеша.

updateTime

string ( Timestamp format)

Только вывод. Заполняется только в person.metadata.sources .

Отметка времени последнего обновления этого источника.

Временная метка в формате RFC3339 UTC "Zulu" с разрешением в наносекунды и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

profileMetadata

object ( ProfileMetadata )

Только вывод. Заполняется только в person.metadata.sources .

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

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

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

перечисления
SOURCE_TYPE_UNSPECIFIED Неопределенные.
ACCOUNT Аккаунт Гугл .
PROFILE Гугл профиль . Профиль можно просмотреть по адресу https://profiles.google.com/ {id}, где {id} – идентификатор источника.
DOMAIN_PROFILE Профиль домена Google Workspace .
CONTACT Гугл контакт . Вы можете просмотреть контакт на странице https://contact.google.com/ {id}, где {id} – идентификатор источника.
OTHER_CONTACT Гуглите "Другой контакт" .
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 alpha-2 адреса.

Метаданные поля

Метаданные о поле.

Представление 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 )

Возрастной диапазон человека.

перечисления
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 )

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

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 )

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

username

string

Имя пользователя, используемое в клиенте обмена мгновенными сообщениями.

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

Эквивалент полной занятости человека в миллипроцентах в организации (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/AAAAAAAAAAAI/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, если место жительства является прошлым местом жительства.

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 .

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

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

Представление 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

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