REST Resource: people

リソース: Person

認証済みユーザーの連絡先やプロフィール データなど、さまざまなデータソースから統合された人物に関する情報。

ほとんどのフィールドには複数のアイテムを指定できます。フィールド内のアイテムの順序は保証されませんが、空でない各フィールドには、metadata.primary が true に設定されたフィールドが 1 つだけ含まれることが保証されます。

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

サーバーによって割り当てられた人物のリソース名。people/{person_id} 形式の ASCII 文字列。

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.listotherContacts.list の場合、メールアドレスの数は 100 個に制限されています。Person が複数のメールアドレスを持っている場合は、people.getBatchGet を呼び出すことで、セット全体を取得できます。

events[]

object (Event)

人物の予定。

externalIds[]

object (ExternalId)

ユーザーの外部 ID。

fileAses[]

object (FileAs)

その人物の File-ass。

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.listotherContacts.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)

個人のユーザー定義のデータ。

PersonMetadata

人物に関するメタデータ。

JSON 表現
{
  "sources": [
    {
      object (Source)
    }
  ],
  "previousResourceNames": [
    string
  ],
  "linkedPeopleResourceNames": [
    string
  ],
  "deleted": boolean,
  "objectType": enum (ObjectType)
}
フィールド
sources[]

object (Source)

個人のデータのソース。

previousResourceNames[]

string

出力専用。この人物が使用していた以前のリソース名。同期トークンを含む people.connections.list リクエストの場合のみ入力されます。

リソース名は、連絡先とプロフィールをリンクする項目(確認済みメールアドレス、確認済みの電話番号、プロフィールの URL など)を追加または削除すると、変更される可能性があります。

linkedPeopleResourceNames[]

string

出力専用。このリソースにリンクされているユーザーのリソース名。

deleted

boolean

出力専用。個人リソースが削除された場合は true。people.connections.listotherContacts.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「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

共用体フィールド metadataperson.metadata.sources にのみ入力されます。

ソースに関するメタデータ。metadata は次のいずれかになります。

profileMetadata

object (ProfileMetadata)

出力専用。person.metadata.sources にのみ入力されます。

PROFILE タイプのソースに関するメタデータ。

SourceType

ソースのタイプ。

列挙型
SOURCE_TYPE_UNSPECIFIED (指定なし)
ACCOUNT Google アカウント
PROFILE Google プロフィール。プロファイルは https://profiles.google.com/{id} で確認できます。{id} はソース ID です。
DOMAIN_PROFILE Google Workspace ドメイン プロファイル
CONTACT Google コンタクト。連絡先は https://contact.google.com/{id} で確認できます。{id} はソース ID です。
OTHER_CONTACT Google の「その他の連絡先」
DOMAIN_CONTACT Google Workspace ドメインの共有の連絡先

ProfileMetadata

プロフィールに関するメタデータ。

JSON 表現
{
  "objectType": enum (ObjectType),
  "userTypes": [
    enum (UserType)
  ]
}
フィールド
objectType

enum (ObjectType)

出力専用。プロファイル オブジェクト タイプ。

userTypes[]

enum (UserType)

出力専用。ユーザーが入力します。

ObjectType

人物オブジェクトのタイプ。

列挙型
OBJECT_TYPE_UNSPECIFIED (指定なし)
PERSON ユーザーです。
PAGE Currents ページ。

UserType

ユーザーのタイプ。

列挙型
USER_TYPE_UNKNOWN ユーザータイプが不明です。
GOOGLE_USER ユーザーが Google ユーザーである。
GPLUS_USER ユーザーが Currents ユーザーである。
GOOGLE_APPS_USER ユーザーが Google Workspace ユーザーである。

住所

個人の住所。私書箱の場合もあります入力します。すべてのフィールドは任意です。

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

出力専用。閲覧者のアカウントの言語 / 地域または Accept-Language HTTP ヘッダーの言語 / 地域に翻訳およびフォーマットされた住所のタイプ。

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

出力専用。フィールドが人物のすべてのソースのプライマリ フィールドの場合は true。各ユーザーには、primary が true に設定されたフィールドが 1 つだけあります。

sourcePrimary

boolean

フィールドが source のプライマリ フィールドの場合は true。各ソースには、sourcePrimary を true に設定したフィールドを 1 つだけ含める必要があります。

verified

boolean

出力専用。フィールドが検証されている場合は true、フィールドが未確認の場合は false。確認済みフィールドとは、通常、個人が所有するものであることが確認された名前、メールアドレス、電話番号、ウェブサイトなどです。

source

object (Source)

フィールドのソース。

年齢

非推奨(代わりに person.ageRanges を使用してください)

個人の年齢層。

列挙型
AGE_RANGE_UNSPECIFIED (指定なし)
LESS_THAN_EIGHTEEN 18 歳未満。
EIGHTEEN_TO_TWENTY 18 から 20 の間。
TWENTY_ONE_OR_OLDER 21 歳以上です。

AgeRangeType

個人の年齢層。

JSON 表現
{
  "metadata": {
    object (FieldMetadata)
  },
  "ageRange": enum (AgeRange)
}
フィールド
metadata

object (FieldMetadata)

年齢層に関するメタデータ。

ageRange

enum (AgeRange)

年齢層。

伝記

人物の簡単な経歴。

JSON 表現
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "contentType": enum (ContentType)
}
フィールド
metadata

object (FieldMetadata)

略歴に関するメタデータ。

value

string

略歴。

contentType

enum (ContentType)

略歴のコンテンツ タイプ。

ContentType

コンテンツのタイプ。

列挙型
CONTENT_TYPE_UNSPECIFIED (指定なし)
TEXT_PLAIN 書式なしテキスト。
TEXT_HTML HTML テキスト。

誕生日

人の誕生日。date フィールドと text フィールドの少なくとも 1 つが指定されている。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 年の中の月。1~12、または月と日のない年を指定する場合は 0 にする必要があります。

day

integer

1 月の中の日付。1~31 で、その年と月に対して有効である必要があります。または、日が重要でない場合に、年のみか年と月を指定するには 0 にする必要があります。

BraggingRights

非推奨: 個人の自慢の権利に対するデータは返されません。

JSON 表現
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
フィールド
metadata

object (FieldMetadata)

自慢する権利に関するメタデータ。

value

string

自慢できること例: climbed mount everest

CalendarUrl

ユーザーのカレンダーの URL。

JSON 表現
{
  "metadata": {
    object (FieldMetadata)
  },
  "url": string,
  "type": string,
  "formattedType": string
}
フィールド
metadata

object (FieldMetadata)

カレンダーの URL に関するメタデータ。

url

string

カレンダーの URL。

type

string

カレンダーの URL のタイプ。型は、カスタム値、または次の定義済みの値のいずれかです。

  • home
  • freeBusy
  • work
formattedType

string

出力専用。閲覧者のアカウントの言語 / 地域または Accept-Language HTTP ヘッダーの言語 / 地域に翻訳およびフォーマットされたカレンダーの URL のタイプ。

ClientData

クライアントによって入力される任意のクライアント データ。重複するキーと値は使用できます。

JSON 表現
{
  "metadata": {
    object (FieldMetadata)
  },
  "key": string,
  "value": string
}
フィールド
metadata

object (FieldMetadata)

クライアント データに関するメタデータ。

key

string

クライアントがクライアント データのキーを指定した。

value

string

クライアントがクライアント データの値に指定した値。

CoverPhoto

人のカバー写真。ユーザーのプロフィール ページに表示される大きな画像で、そのユーザーが誰で、何を気にかけているかを表す画像。

JSON 表現
{
  "metadata": {
    object (FieldMetadata)
  },
  "url": string,
  "default": boolean
}
フィールド
metadata

object (FieldMetadata)

カバー写真に関するメタデータ。

url

string

カバー写真の URL。

default

boolean

カバー写真がデフォルトのカバー写真の場合は true、カバー写真がユーザー提供のカバー写真の場合は false。

EmailAddress

ユーザーのメールアドレス。

JSON 表現
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": string,
  "formattedType": string,
  "displayName": string
}
フィールド
metadata

object (FieldMetadata)

メールアドレスに関するメタデータ。

value

string

メールアドレス。

type

string

メールアドレスのタイプ。型は、カスタム値、または次の定義済みの値のいずれかです。

  • home
  • work
  • other
formattedType

string

出力専用。閲覧者のアカウントの言語 / 地域または Accept-Language HTTP ヘッダーの言語 / 地域に翻訳およびフォーマットされたメールアドレスのタイプ。

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

出力専用。閲覧者のアカウントの言語 / 地域または Accept-Language HTTP ヘッダーの言語 / 地域に翻訳およびフォーマットされたイベントのタイプ。

外部 ID

人物に関連する外部エンティティから取得した識別子。

JSON 表現
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": string,
  "formattedType": string
}
フィールド
metadata

object (FieldMetadata)

外部 ID に関するメタデータ。

value

string

外部 ID の値。

type

string

外部 ID のタイプ。型は、カスタム値、または次の定義済みの値のいずれかです。

  • account
  • customer
  • loginId
  • network
  • organization
formattedType

string

出力専用。閲覧者のアカウントの言語 / 地域または Accept-Language HTTP ヘッダーの言語 / 地域に翻訳およびフォーマットされたイベントのタイプ。

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

出力専用。視聴者のアカウントの言語 / 地域または Accept-Language HTTP ヘッダーの言語 / 地域に翻訳およびフォーマットされた性別の値。未指定またはカスタム値はローカライズされません。

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

出力専用。閲覧者のアカウントの言語 / 地域または Accept-Language HTTP ヘッダーの言語 / 地域に翻訳およびフォーマットされた IM クライアントのタイプ。

protocol

string

IM クライアントのプロトコル。プロトコルは、カスタム値、または次の定義済みの値のいずれかです。

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

string

出力専用。閲覧者のアカウントの言語 / 地域または Accept-Language HTTP ヘッダーの言語 / 地域に対応した IM クライアントのプロトコル。

興味 / 関心

ユーザーの関心事のいずれか。

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

建物の ID。

floor

string

階の名前または番号。

floorSection

string

floor_name の階数セクション。

deskCode

string

個々のデスクの場所。

メンバーシップ

グループ内のユーザーのメンバーシップ。変更できるのは連絡先グループのメンバーのみです。

JSON 表現
{
  "metadata": {
    object (FieldMetadata)
  },

  // Union field membership can be only one of the following:
  "contactGroupMembership": {
    object (ContactGroupMembership)
  },
  "domainMembership": {
    object (DomainMembership)
  }
  // End of list of possible types for union field membership.
}
フィールド
metadata

object (FieldMetadata)

メンバーシップに関するメタデータ。

共用体フィールド membership。メンバーシップ。membership は次のいずれかになります。
contactGroupMembership

object (ContactGroupMembership)

連絡先グループのメンバー。

domainMembership

object (DomainMembership)

出力専用。ドメイン メンバーシップ。

ContactGroupMembership

Google コンタクト グループのメンバー。

JSON 表現
{
  "contactGroupId": string,
  "contactGroupResourceName": string
}
フィールド
contactGroupId
(deprecated)

string

出力専用。連絡先グループ メンバーの連絡先グループ ID。

contactGroupResourceName

string

サーバーによって割り当てられた連絡先グループのリソース名。contactGroups/{contactGroupId} 形式の ASCII 文字列。メンバーシップの変更に使用できるのは contactGroupResourceName のみです。連絡先グループのメンバーは削除できますが、削除できるのはユーザー グループまたは「myContacts」のみです「スター付き」システム グループのメンバーを追加できます。連絡先には、常に 1 つ以上の連絡先グループ メンバーシップが必要です。

DomainMembership

Google Workspace ドメイン メンバーシップ。

JSON 表現
{
  "inViewerDomain": boolean
}
フィールド
inViewerDomain

boolean

閲覧者の Google Workspace ドメインに属している場合は true。

MiscKeyword

人のその他のキーワード。

JSON 表現
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": enum (KeywordType),
  "formattedType": string
}
フィールド
metadata

object (FieldMetadata)

その他のキーワードに関するメタデータ。

value

string

その他のキーワードの値。

type

enum (KeywordType)

その他のキーワード タイプ。

formattedType

string

出力専用。閲覧者のアカウントの言語 / 地域または Accept-Language HTTP ヘッダーの言語 / 地域に翻訳およびフォーマットされた、その他のキーワードのタイプ。

KeywordType

その他のキーワードのタイプ。

列挙型
TYPE_UNSPECIFIED (指定なし)
OUTLOOK_BILLING_INFORMATION お支払い情報の Outlook フィールド。
OUTLOOK_DIRECTORY_SERVER ディレクトリ サーバーの Outlook フィールド。
OUTLOOK_KEYWORD キーワードの見通しフィールド。
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

出力専用。閲覧者のアカウントまたは 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)

ニックネームのタイプ。

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

出力専用。閲覧者のアカウントの言語 / 地域または Accept-Language HTTP ヘッダーの言語 / 地域に翻訳およびフォーマットされた組織のタイプ。

startDate

object (Date)

そのユーザーが組織に参加した開始日。

endDate

object (Date)

そのユーザーが退職した日の終了日。

current

boolean

その組織がその人の現在の組織である場合は true。組織が過去の組織である場合は 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%)。

PhoneNumber

個人の電話番号。

JSON 表現
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "canonicalForm": string,
  "type": string,
  "formattedType": string
}
フィールド
metadata

object (FieldMetadata)

電話番号に関するメタデータ。

value

string

電話番号。

canonicalForm

string

出力専用。正規化された ITU-T E.164 形式の電話番号。

type

string

電話番号のタイプ。型は、カスタム値、または次の定義済みの値のいずれかです。

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

string

出力専用。閲覧者のアカウントの言語 / 地域または Accept-Language HTTP ヘッダーの言語 / 地域に翻訳およびフォーマットされた電話番号のタイプ。

写真

人物の写真個人の名前の横に表示される画像で、他のユーザーが識別できるようにします。

JSON 表現
{
  "metadata": {
    object (FieldMetadata)
  },
  "url": string,
  "default": boolean
}
フィールド
metadata

object (FieldMetadata)

写真に関するメタデータ。

url

string

写真の URL。希望のサイズを変更するには、URL の末尾にクエリ パラメータ sz={size} を追加します。{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

出力専用。閲覧者のアカウント ロケール、または Accept-Language HTTP ヘッダーで指定されたロケールに翻訳およびフォーマットされたリレーションのタイプ。

RelationshipInterest

非推奨: データは返されません。人の関係への関心。

JSON 表現
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "formattedValue": string
}
フィールド
metadata

object (FieldMetadata)

関係性に関するメタデータ。

value

string

相手が求めている関係の種類。値はカスタムまたは次のいずれかの定義済みの値になります。

  • friend
  • date
  • relationship
  • networking
formattedValue

string

出力専用。閲覧者のアカウント ロケール、または Accept-Language HTTP ヘッダーで指定されたロケールに翻訳およびフォーマットされた関係関心の値。

RelationshipStatus

DEPRECATED: データは返されません。個人の関係ステータス。

JSON 表現
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "formattedValue": string
}
フィールド
metadata

object (FieldMetadata)

関係ステータスに関するメタデータ。

value

string

関係のステータス。値はカスタムまたは次のいずれかの定義済みの値になります。

  • single
  • inARelationship
  • engaged
  • married
  • itsComplicated
  • openRelationship
  • widowed
  • inDomesticPartnership
  • inCivilUnion
formattedValue

string

出力専用。閲覧者のアカウントの言語 / 地域または Accept-Language HTTP ヘッダーの言語 / 地域に翻訳およびフォーマットされた関係ステータスの値。

住居

非推奨: 代わりに person.locations を使用してください。個人の過去または現在の居住地。

JSON 表現
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "current": boolean
}
フィールド
metadata

object (FieldMetadata)

住居に関するメタデータ。

value

string

居住地の住所。

current

boolean

居住地がその人の現在の居住地である場合は true、過去の住居である場合は false。

SipAddress

個人の SIP アドレス。セッション初期プロトコル アドレスは、インターネット経由で音声通話またはビデオ通話を行う VoIP 通信に使用されます。

JSON 表現
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": string,
  "formattedType": string
}
フィールド
metadata

object (FieldMetadata)

SIP アドレスに関するメタデータ。

value

string

RFC 3261 19.1 SIP URI 形式の SIP アドレス。

type

string

SIP アドレスのタイプ。型は、カスタム値、または次の定義済みの値のいずれかです。

  • home
  • work
  • mobile
  • other
formattedType

string

出力専用。閲覧者のアカウントの言語 / 地域または Accept-Language HTTP ヘッダーの言語 / 地域に翻訳およびフォーマットされた SIP アドレスのタイプ。

スキル

その個人が持っているスキル。

JSON 表現
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
フィールド
metadata

object (FieldMetadata)

スキルに関するメタデータ。

value

string

スキル例: underwater basket weaving

キャッチフレーズ

非推奨: データは返されません。人物に関する 1 行の簡単な説明。

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

出力専用。閲覧者のアカウントの言語 / 地域または Accept-Language HTTP ヘッダーの言語 / 地域に翻訳およびフォーマットされた URL のタイプ。

UserDefined

エンドユーザーによって入力される任意のユーザーデータ。

JSON 表現
{
  "metadata": {
    object (FieldMetadata)
  },
  "key": string,
  "value": string
}
フィールド
metadata

object (FieldMetadata)

ユーザー定義のデータに関するメタデータ。

key

string

ユーザー定義データのエンドユーザー指定キー。

value

string

ユーザー定義データのエンドユーザー指定値。

メソッド

batchCreateContacts

新しい連絡先のバッチを作成し、新しい連絡先の PersonResponses を返します。

レイテンシの増加や失敗を避けるため、同じユーザーに対する DoFn リクエストは順次送信する必要があります。

batchDeleteContacts

複数の連絡先を一括削除します。

batchUpdateContacts

一連の連絡先を更新し、更新された連絡先の PersonResponses にリソース名のマップを返します。

createContact

新しい連絡先を作成し、その連絡先の人物リソースを返します。

deleteContact

連絡先担当者を削除する。

deleteContactPhoto

連絡先の写真を削除する。

get

リソース名を指定して、個人に関する情報を提供します。

getBatchGet

リクエストされたリソース名のリストを指定して、特定のユーザーのリストに関する情報を提供します。

listDirectoryPeople

認証されたユーザーのドメイン ディレクトリにあるドメイン プロフィールとドメインの連絡先のリストを提供します。

searchContacts

認証済みユーザーのグループ化された連絡先のうち、検索クエリに一致する連絡先のリストを提供します。

searchDirectoryPeople

認証済みユーザーのドメイン ディレクトリ内で、検索クエリに一致するドメイン プロフィールとドメインの連絡先のリストを提供します。

updateContact

既存の連絡先担当者の連絡先データを更新する。

updateContactPhoto

連絡先の写真を更新します。