REST Resource: people

Tài nguyên: Person

Thông tin về một người được hợp nhất từ nhiều nguồn dữ liệu, chẳng hạn như danh bạ và dữ liệu hồ sơ của người dùng đã xác thực.

Hầu hết các trường có thể chứa nhiều mục. Các mục trong một trường không có thứ tự được đảm bảo, nhưng mỗi trường không trống được đảm bảo có đúng một trường với metadata.primary được đặt thành đúng.

Biểu diễn dưới dạng 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)
    }
  ]
}
Trường
resourceName

string

Tên tài nguyên cho người đó, được máy chủ chỉ định. Một chuỗi ASCII dưới dạng people/{person_id}.

etag

string

Thẻ thực thể HTTP của tài nguyên. Dùng để xác thực bộ nhớ đệm của web.

metadata

object (PersonMetadata)

Chỉ có đầu ra. Siêu dữ liệu về người đó.

addresses[]

object (Address)

Địa chỉ đường phố của người đó.

ageRange
(deprecated)

enum (AgeRange)

Chỉ có đầu ra. KHÔNG DÙNG NỮA (Vui lòng sử dụng person.ageRanges để thay thế)

Độ tuổi của người đó.

ageRanges[]

object (AgeRangeType)

Chỉ có đầu ra. Độ tuổi của người đó.

biographies[]

object (Biography)

Tiểu sử của người đó. Trường này là một singleton cho nguồn liên hệ.

birthdays[]

object (Birthday)

Ngày sinh nhật của người đó. Trường này là một singleton cho nguồn liên hệ.

braggingRights[]
(deprecated)

object (BraggingRights)

KHÔNG DÙNG NỮA: Sẽ không có dữ liệu nào được trả lại thành tích của người đó.

calendarUrls[]

object (CalendarUrl)

URL lịch của người đó.

clientData[]

object (ClientData)

Dữ liệu khách hàng của người đó.

coverPhotos[]

object (CoverPhoto)

Chỉ có đầu ra. Ảnh bìa của người đó.

emailAddresses[]

object (EmailAddress)

Địa chỉ email của người đó. Đối với people.connections.listotherContacts.list, số lượng địa chỉ email được giới hạn ở 100. Nếu một Người có nhiều địa chỉ email hơn thì bạn có thể lấy toàn bộ nhóm bằng cách gọi people.getBatchGet.

events[]

object (Event)

Sự kiện của người đó.

externalIds[]

object (ExternalId)

Mã nhận dạng bên ngoài của người đó.

fileAses[]

object (FileAs)

Tệp của người này.

genders[]

object (Gender)

Giới tính của người đó. Trường này là một singleton cho nguồn liên hệ.

imClients[]

object (ImClient)

Ứng dụng nhắn tin nhanh của người này.

interests[]

object (Interest)

Mối quan tâm của người đó.

locales[]

object (Locale)

Lựa chọn ưu tiên về ngôn ngữ của người đó.

locations[]

object (Location)

Vị trí của người đó.

memberships[]

object (Membership)

Tư cách thành viên trong nhóm của người đó.

miscKeywords[]

object (MiscKeyword)

Các từ khoá khác của người này.

names[]

object (Name)

Tên của người đó. Trường này là một singleton cho nguồn liên hệ.

nicknames[]

object (Nickname)

Biệt hiệu của người đó.

occupations[]

object (Occupation)

Nghề nghiệp của người đó.

organizations[]

object (Organization)

Tổ chức trong quá khứ hoặc hiện tại của người đó.

phoneNumbers[]

object (PhoneNumber)

Số điện thoại của người đó. Đối với people.connections.listotherContacts.list, số lượng số điện thoại được giới hạn ở 100. Nếu một Người có nhiều số điện thoại hơn, thì bạn có thể lấy toàn bộ nhóm bằng cách gọi people.getBatchGet.

photos[]

object (Photo)

Chỉ có đầu ra. Ảnh của người đó.

relations[]

object (Relation)

Mối quan hệ của người đó.

relationshipInterests[]
(deprecated)

object (RelationshipInterest)

Chỉ có đầu ra. KHÔNG DÙNG NỮA: Hệ thống sẽ không trả về dữ liệu nào về mối quan tâm của người đó.

relationshipStatuses[]
(deprecated)

object (RelationshipStatus)

Chỉ có đầu ra. KHÔNG DÙNG NỮA: Hệ thống sẽ không trả về dữ liệu

residences[]
(deprecated)

object (Residence)

KHÔNG DÙNG NỮA: (Vui lòng sử dụng person.locations để thay thế) Nơi ở của người đó.

sipAddresses[]

object (SipAddress)

Địa chỉ SIP của người đó.

skills[]

object (Skill)

Kỹ năng của người đó.

taglines[]
(deprecated)

object (Tagline)

Chỉ có đầu ra. KHÔNG DÙNG NỮA: Dòng giới thiệu của người đó sẽ không được trả về dữ liệu nào.

urls[]

object (Url)

URL liên kết của người đó.

userDefined[]

object (UserDefined)

Dữ liệu do người dùng xác định của người đó.

PersonMetadata

Siêu dữ liệu về một người.

Biểu diễn dưới dạng JSON
{
  "sources": [
    {
      object (Source)
    }
  ],
  "previousResourceNames": [
    string
  ],
  "linkedPeopleResourceNames": [
    string
  ],
  "deleted": boolean,
  "objectType": enum (ObjectType)
}
Trường
sources[]

object (Source)

Nguồn dữ liệu về người đó.

previousResourceNames[]

string

Chỉ có đầu ra. Mọi tên tài nguyên cũ mà người này có. Chỉ được điền sẵn cho các yêu cầu people.connections.list có mã đồng bộ hoá.

Tên tài nguyên có thể thay đổi khi thêm hoặc xoá các trường liên kết một người liên hệ và hồ sơ, chẳng hạn như email đã xác minh, số điện thoại đã xác minh hoặc URL hồ sơ.

linkedPeopleResourceNames[]

string

Chỉ có đầu ra. Tên tài nguyên của những người được liên kết với tài nguyên này.

deleted

boolean

Chỉ có đầu ra. Đúng nếu tài nguyên của người đó đã bị xoá. Chỉ được điền sẵn cho các yêu cầu đồng bộ hoá people.connections.listotherContacts.list.

objectType
(deprecated)

enum (ObjectType)

Chỉ có đầu ra. KHÔNG DÙNG NỮA (Vui lòng sử dụng person.metadata.sources.profileMetadata.objectType để thay thế)

Loại đối tượng người.

Nguồn

Nguồn của một trường.

Biểu diễn dưới dạng 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.
}
Trường
type

enum (SourceType)

Loại nguồn.

id

string

Giá trị nhận dạng duy nhất trong loại nguồn do máy chủ tạo.

etag

string

Chỉ được điền bằng person.metadata.sources.

Thẻ thực thể HTTP của nguồn. Dùng để xác thực bộ nhớ đệm của web.

updateTime

string (Timestamp format)

Chỉ có đầu ra. Chỉ được điền bằng person.metadata.sources.

Dấu thời gian của lần cập nhật gần đây nhất của nguồn này.

Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, với độ phân giải nano giây và tối đa 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z".

Trường hợp metadata. Chỉ được điền bằng person.metadata.sources.

Siêu dữ liệu về nguồn. metadata chỉ có thể là một trong những trạng thái sau:

profileMetadata

object (ProfileMetadata)

Chỉ có đầu ra. Chỉ được điền bằng person.metadata.sources.

Siêu dữ liệu về nguồn thuộc loại PROFILE.

SourceType

Loại của nguồn.

Enum
SOURCE_TYPE_UNSPECIFIED Không xác định.
ACCOUNT Tài khoản Google.
PROFILE Hồ sơ trên Google. Bạn có thể xem hồ sơ tại https://profiles.google.com/{id}, trong đó {id} là mã nguồn.
DOMAIN_PROFILE Hồ sơ miền Google Workspace.
CONTACT Thông tin liên hệ của Google. Bạn có thể xem người liên hệ tại https://contact.google.com/{id}, trong đó {id} là mã nguồn.
OTHER_CONTACT Google "Liên hệ khác".
DOMAIN_CONTACT Thông tin liên hệ được chia sẻ của miền Google Workspace.

ProfileMetadata

Siêu dữ liệu về một hồ sơ.

Biểu diễn dưới dạng JSON
{
  "objectType": enum (ObjectType),
  "userTypes": [
    enum (UserType)
  ]
}
Trường
objectType

enum (ObjectType)

Chỉ có đầu ra. Loại đối tượng hồ sơ.

userTypes[]

enum (UserType)

Chỉ có đầu ra. Người dùng nhập dữ liệu.

ObjectType

Loại đối tượng người.

Enum
OBJECT_TYPE_UNSPECIFIED Không xác định.
PERSON Người.
PAGE Trang Currents.

UserType

Loại người dùng.

Enum
USER_TYPE_UNKNOWN Loại người dùng không xác định.
GOOGLE_USER Người dùng là người dùng Google.
GPLUS_USER Người dùng là người dùng Currents.
GOOGLE_APPS_USER Người dùng là một người dùng Google Workspace.

Address (Địa chỉ)

Địa chỉ thực tế của một người. Có thể là hộp thư bưu điện hoặc địa chỉ đường phố. Tất cả các trường đều không bắt buộc.

Biểu diễn dưới dạng 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
}
Trường
metadata

object (FieldMetadata)

Siêu dữ liệu về địa chỉ.

formattedValue

string

Giá trị không có cấu trúc của địa chỉ. Nếu người dùng không đặt thuộc tính này, giá trị sẽ được tạo tự động từ các giá trị có cấu trúc.

type

string

Loại địa chỉ. Loại này có thể là tuỳ chỉnh hoặc một trong các giá trị được xác định trước sau:

  • home
  • work
  • other
formattedType

string

Chỉ có đầu ra. Loại địa chỉ được dịch và định dạng bằng ngôn ngữ trong tài khoản của người xem hoặc ngôn ngữ tiêu đề HTTP Accept-Language.

poBox

string

Hộp thư bưu điện của địa chỉ.

streetAddress

string

Địa chỉ đường phố.

extendedAddress

string

Địa chỉ mở rộng của địa chỉ (ví dụ: số căn hộ).

city

string

Thành phố của địa chỉ.

region

string

Khu vực của địa chỉ; ví dụ: tiểu bang hoặc tỉnh.

postalCode

string

Mã bưu điện của địa chỉ.

country

string

Quốc gia của địa chỉ.

countryCode

string

Mã quốc gia theo ISO 3166-1 alpha-2 của địa chỉ.

FieldMetadata

Siêu dữ liệu về một trường.

Biểu diễn dưới dạng JSON
{
  "primary": boolean,
  "sourcePrimary": boolean,
  "verified": boolean,
  "source": {
    object (Source)
  }
}
Trường
primary

boolean

Chỉ có đầu ra. Đúng nếu trường này là trường chính cho tất cả các nguồn trong người đó. Mỗi người sẽ có tối đa một trường có primary được đặt thành true.

sourcePrimary

boolean

Đúng nếu trường này là trường chính của source. Mỗi nguồn phải có tối đa một trường có sourcePrimary được đặt thành true.

verified

boolean

Chỉ có đầu ra. "True" nếu trường được xác minh; "false" nếu trường chưa được xác minh. Trường đã xác minh thường là tên, địa chỉ email, số điện thoại hoặc trang web đã được xác nhận là do người đó sở hữu.

source

object (Source)

Nguồn của trường.

AgeRange

KHÔNG DÙNG NỮA (Vui lòng sử dụng person.ageRanges để thay thế)

Độ tuổi của một người.

Enum
AGE_RANGE_UNSPECIFIED Không xác định.
LESS_THAN_EIGHTEEN Nhỏ hơn 18 tuổi.
EIGHTEEN_TO_TWENTY Từ 18 đến 20.
TWENTY_ONE_OR_OLDER 21 tuổi trở lên.

AgeRangeType

Độ tuổi của một người.

Biểu diễn dưới dạng JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "ageRange": enum (AgeRange)
}
Trường
metadata

object (FieldMetadata)

Siêu dữ liệu về độ tuổi.

ageRange

enum (AgeRange)

Độ tuổi.

Tiểu sử

Tiểu sử ngắn của một người.

Biểu diễn dưới dạng JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "contentType": enum (ContentType)
}
Trường
metadata

object (FieldMetadata)

Siêu dữ liệu về tiểu sử.

value

string

Tiểu sử ngắn.

contentType

enum (ContentType)

Loại nội dung của tiểu sử.

ContentType

Loại nội dung.

Enum
CONTENT_TYPE_UNSPECIFIED Không xác định.
TEXT_PLAIN Văn bản thuần tuý.
TEXT_HTML Văn bản HTML.

Sinh nhật

Sinh nhật của một người. Bạn đã chỉ định ít nhất một trong các trường datetext. Các trường datetext thường đại diện cho cùng một ngày nhưng chúng tôi không đảm bảo sẽ đại diện cho cùng một ngày. Ứng dụng phải luôn đặt trường date khi thay đổi ngày sinh nhật.

Biểu diễn dưới dạng JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "date": {
    object (Date)
  },
  "text": string
}
Trường
metadata

object (FieldMetadata)

Siêu dữ liệu về ngày sinh nhật.

date

object (Date)

Ngày sinh nhật theo cấu trúc.

text
(deprecated)

string

Ưu tiên sử dụng trường date nếu bạn đặt giá trị.

Một chuỗi dạng tự do đại diện cho ngày sinh của người dùng. Giá trị này không được xác thực.

Ngày

Đại diện cho toàn bộ hoặc một phần ngày theo lịch, chẳng hạn như sinh nhật. Thời gian trong ngày và múi giờ được chỉ định ở nơi khác hoặc không đáng kể. Ngày này có liên quan đến Dương lịch. Điều này có thể đại diện cho một trong những điều sau:

  • Một ngày đầy đủ, với các giá trị năm, tháng và ngày khác 0.
  • Tháng và ngày, có năm bằng 0 (ví dụ: ngày kỷ niệm).
  • Chỉ có năm, có tháng 0 và ngày không.
  • Năm và tháng, không có ngày (ví dụ: ngày hết hạn thẻ tín dụng).

Các loại liên quan:

Biểu diễn dưới dạng JSON
{
  "year": integer,
  "month": integer,
  "day": integer
}
Trường
year

integer

Năm của ngày tháng. Giá trị phải từ 1 đến 9999 hoặc từ 0 để chỉ định ngày không có năm.

month

integer

Tháng trong năm. Giá trị phải từ 1 đến 12 hoặc từ 0 để chỉ định năm không có tháng và ngày.

day

integer

Ngày trong tháng. Giá trị phải từ 1 đến 31 và có giá trị cho năm và tháng, hoặc 0 để chỉ định riêng một năm hoặc một năm và tháng mà ngày đó không quan trọng.

BraggingRights

KHÔNG DÙNG NỮA: Sẽ không có dữ liệu nào được trả lại quyền khoe khoang của một người.

Biểu diễn dưới dạng JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
Trường
metadata

object (FieldMetadata)

Siêu dữ liệu về thành tích.

value

string

Thành tích; ví dụ: climbed mount everest.

CalendarUrl

URL lịch của một người.

Biểu diễn dưới dạng JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "url": string,
  "type": string,
  "formattedType": string
}
Trường
metadata

object (FieldMetadata)

Siêu dữ liệu về URL của lịch.

url

string

URL lịch.

type

string

Loại URL của lịch. Loại này có thể là tuỳ chỉnh hoặc một trong các giá trị được xác định trước sau:

  • home
  • freeBusy
  • work
formattedType

string

Chỉ có đầu ra. Loại URL của lịch được dịch và định dạng bằng ngôn ngữ tài khoản của người xem hoặc ngôn ngữ tiêu đề HTTP Accept-Language.

ClientData

Dữ liệu khách hàng tuỳ ý do khách hàng điền sẵn. Cho phép khóa và giá trị trùng lặp.

Biểu diễn dưới dạng JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "key": string,
  "value": string
}
Trường
metadata

object (FieldMetadata)

Siêu dữ liệu về dữ liệu ứng dụng.

key

string

Khoá của dữ liệu ứng dụng do ứng dụng chỉ định.

value

string

Giá trị ứng dụng được chỉ định của dữ liệu ứng dụng.

CoverPhoto

Ảnh bìa của một người. Hình ảnh lớn hiển thị trên trang hồ sơ của người đó thể hiện họ là ai hoặc họ quan tâm đến điều gì.

Biểu diễn dưới dạng JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "url": string,
  "default": boolean
}
Trường
metadata

object (FieldMetadata)

Siêu dữ liệu về ảnh bìa.

url

string

URL của ảnh bìa.

default

boolean

True nếu ảnh bìa là ảnh bìa mặc định; false nếu ảnh bìa là ảnh bìa do người dùng cung cấp.

EmailAddress

Địa chỉ email của một người.

Biểu diễn dưới dạng JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": string,
  "formattedType": string,
  "displayName": string
}
Trường
metadata

object (FieldMetadata)

Siêu dữ liệu về địa chỉ email.

value

string

Địa chỉ email.

type

string

Loại địa chỉ email. Loại này có thể là tuỳ chỉnh hoặc một trong các giá trị được xác định trước sau:

  • home
  • work
  • other
formattedType

string

Chỉ có đầu ra. Loại địa chỉ email được dịch và định dạng bằng ngôn ngữ tài khoản của người xem hoặc ngôn ngữ tiêu đề HTTP Accept-Language.

displayName

string

Tên hiển thị của email.

Sự kiện

Một sự kiện liên quan đến người đó.

Biểu diễn dưới dạng JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "date": {
    object (Date)
  },
  "type": string,
  "formattedType": string
}
Trường
metadata

object (FieldMetadata)

Siêu dữ liệu về sự kiện.

date

object (Date)

Ngày diễn ra sự kiện.

type

string

Loại sự kiện. Loại này có thể là tuỳ chỉnh hoặc một trong các giá trị được xác định trước sau:

  • anniversary
  • other
formattedType

string

Chỉ có đầu ra. Loại sự kiện được dịch và định dạng bằng ngôn ngữ trong tài khoản của người xem hoặc ngôn ngữ tiêu đề HTTP Accept-Language.

ExternalId

Giá trị nhận dạng của một thực thể bên ngoài liên quan đến người đó.

Biểu diễn dưới dạng JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": string,
  "formattedType": string
}
Trường
metadata

object (FieldMetadata)

Siêu dữ liệu về mã nhận dạng bên ngoài.

value

string

Giá trị của mã nhận dạng bên ngoài.

type

string

Loại mã nhận dạng bên ngoài. Loại này có thể là tuỳ chỉnh hoặc một trong các giá trị được xác định trước sau:

  • account
  • customer
  • loginId
  • network
  • organization
formattedType

string

Chỉ có đầu ra. Loại sự kiện được dịch và định dạng bằng ngôn ngữ trong tài khoản của người xem hoặc ngôn ngữ tiêu đề HTTP Accept-Language.

FileAs

Tên nên được sử dụng để sắp xếp người dùng trong danh sách.

Biểu diễn dưới dạng JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
Trường
metadata

object (FieldMetadata)

Siêu dữ liệu về tệp dưới dạng.

value

string

Tệp dưới dạng giá trị

Giới tính

Giới tính của một người.

Biểu diễn dưới dạng JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "formattedValue": string,
  "addressMeAs": string
}
Trường
metadata

object (FieldMetadata)

Siêu dữ liệu về giới tính.

value

string

Giới tính của người đó. Giới tính có thể là giới tính tuỳ chỉnh hoặc một trong các giá trị được xác định trước sau:

  • male
  • female
  • unspecified
formattedValue

string

Chỉ có đầu ra. Giá trị của giới tính được dịch và định dạng bằng ngôn ngữ trong tài khoản của người xem hoặc ngôn ngữ tiêu đề HTTP Accept-Language. Giá trị chưa được chỉ định hoặc tuỳ chỉnh sẽ không được bản địa hoá.

addressMeAs

string

Trường văn bản dạng tự do cho đại từ nhân xưng nên dùng để xưng hô với người đó. Các giá trị phổ biến là:

  • he/him
  • she/her
  • they/them

ImClient

Ứng dụng nhắn tin nhanh của một người.

Biểu diễn dưới dạng JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "username": string,
  "type": string,
  "formattedType": string,
  "protocol": string,
  "formattedProtocol": string
}
Trường
metadata

object (FieldMetadata)

Siêu dữ liệu về ứng dụng nhắn tin nhanh.

username

string

Tên người dùng được sử dụng trong ứng dụng nhắn tin nhanh.

type

string

Loại ứng dụng nhắn tin nhanh. Loại này có thể là tuỳ chỉnh hoặc một trong các giá trị được xác định trước sau:

  • home
  • work
  • other
formattedType

string

Chỉ có đầu ra. Loại ứng dụng nhắn tin nhanh được dịch và định dạng bằng ngôn ngữ tài khoản của người xem hoặc ngôn ngữ tiêu đề HTTP Accept-Language.

protocol

string

Giao thức của ứng dụng nhắn tin nhanh. Giao thức có thể là giao thức tuỳ chỉnh hoặc là một trong các giá trị được xác định trước sau:

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

string

Chỉ có đầu ra. Giao thức của ứng dụng nhắn tin nhanh được định dạng theo ngôn ngữ tài khoản của người xem hoặc ngôn ngữ tiêu đề HTTP Accept-Language.

Quan tâm

Một trong những mối quan tâm của người đó.

Biểu diễn dưới dạng JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
Trường
metadata

object (FieldMetadata)

Siêu dữ liệu về mối quan tâm.

value

string

Mối quan tâm; ví dụ: stargazing.

Ngôn ngữ

Lựa chọn ưu tiên về ngôn ngữ của người dùng.

Biểu diễn dưới dạng JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
Trường
metadata

object (FieldMetadata)

Siêu dữ liệu về ngôn ngữ.

value

string

Thẻ ngôn ngữ IETF BCP 47 được định dạng đúng cách, đại diện cho ngôn ngữ.

Vị trí

Vị trí của một người.

Biểu diễn dưới dạng JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": string,
  "current": boolean,
  "buildingId": string,
  "floor": string,
  "floorSection": string,
  "deskCode": string
}
Trường
metadata

object (FieldMetadata)

Siêu dữ liệu về vị trí đó.

value

string

Giá trị dạng tự do của vị trí.

type

string

Loại vị trí. Loại này có thể là tuỳ chỉnh hoặc một trong các giá trị được xác định trước sau:

  • desk
  • grewUp
current

boolean

Liệu vị trí có phải là vị trí hiện tại hay không.

buildingId

string

Mã nhận dạng toà nhà.

floor

string

Tên hoặc số tầng.

floorSection

string

Phần sàn trong floor_name.

deskCode

string

Vị trí không gian làm việc riêng.

Gói thành viên

Tư cách thành viên của một người trong nhóm. Chỉ có thể sửa đổi tư cách thành viên của nhóm liên hệ.

Biểu diễn dưới dạng 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.
}
Trường
metadata

object (FieldMetadata)

Siêu dữ liệu về gói thành viên.

Trường hợp membership. Gói thành viên. membership chỉ có thể là một trong những trạng thái sau:
contactGroupMembership

object (ContactGroupMembership)

Thành viên trong nhóm người liên hệ.

domainMembership

object (DomainMembership)

Chỉ có đầu ra. Thành viên miền.

ContactGroupMembership

Một thành viên trong nhóm liên hệ Google.

Biểu diễn dưới dạng JSON
{
  "contactGroupId": string,
  "contactGroupResourceName": string
}
Trường
contactGroupId
(deprecated)

string

Chỉ có đầu ra. Mã nhóm người liên hệ để thành viên trong nhóm liên hệ.

contactGroupResourceName

string

Tên tài nguyên cho nhóm người liên hệ do máy chủ chỉ định. Một chuỗi ASCII, dưới dạng contactGroups/{contactGroupId}. Chỉ có thể dùng contactGroupResourceName để sửa đổi thành viên. Bạn có thể xoá mọi tư cách thành viên trong nhóm người liên hệ, nhưng chỉ có thể thêm thành viên trong nhóm người dùng, nhóm người dùng "Danh bạ của tôi" hoặc nhóm hệ thống "có gắn dấu sao". Một người liên hệ phải luôn có ít nhất một thành viên trong nhóm người liên hệ.

DomainMembership

Một gói thành viên của miền Google Workspace.

Biểu diễn dưới dạng JSON
{
  "inViewerDomain": boolean
}
Trường
inViewerDomain

boolean

Đúng nếu người đó thuộc miền Google Workspace của người xem.

MiscKeyword

Từ khóa khác của một người.

Biểu diễn dưới dạng JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": enum (KeywordType),
  "formattedType": string
}
Trường
metadata

object (FieldMetadata)

Siêu dữ liệu về từ khoá khác.

value

string

Giá trị của từ khoá khác.

type

enum (KeywordType)

Loại từ khóa khác.

formattedType

string

Chỉ có đầu ra. Loại từ khoá khác được dịch và định dạng bằng ngôn ngữ trong tài khoản của người xem hoặc ngôn ngữ tiêu đề HTTP Accept-Language.

KeywordType

Loại từ khóa khác.

Enum
TYPE_UNSPECIFIED Không xác định.
OUTLOOK_BILLING_INFORMATION Trường Outlook dành cho thông tin thanh toán.
OUTLOOK_DIRECTORY_SERVER Trường Outlook cho máy chủ thư mục.
OUTLOOK_KEYWORD Trường Outlook cho từ khoá.
OUTLOOK_MILEAGE Trường Outlook cho quãng đường đã đi.
OUTLOOK_PRIORITY Trường Outlook để ưu tiên.
OUTLOOK_SENSITIVITY Trường Outlook về tính nhạy cảm.
OUTLOOK_SUBJECT Trường Outlook cho tiêu đề.
OUTLOOK_USER Trường Outlook cho người dùng.
HOME Trang chủ.
WORK Nơi làm việc.
OTHER Khác.

Tên

Tên của một người. Nếu tên là tên duy nhất thì họ sẽ trống.

Biểu diễn dưới dạng 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
}
Trường
metadata

object (FieldMetadata)

Siêu dữ liệu về tên.

displayName

string

Chỉ có đầu ra. Tên hiển thị được định dạng theo ngôn ngữ do tài khoản của người xem hoặc tiêu đề HTTP Accept-Language chỉ định.

displayNameLastFirst

string

Chỉ có đầu ra. Tên hiển thị có họ được định dạng đầu theo ngôn ngữ do tài khoản của người xem hoặc tiêu đề HTTP Accept-Language chỉ định.

unstructuredName

string

Giá trị tên biểu mẫu tuỳ ý.

familyName

string

Họ.

givenName

string

Tên đặt.

middleName

string

Tên đệm.

honorificPrefix

string

Tiền tố kính ngữ, chẳng hạn như Mrs. hoặc Dr.

honorificSuffix

string

Hậu tố kính ngữ, chẳng hạn như Jr.

phoneticFullName

string

Tên đầy đủ được đánh vần như tên.

phoneticFamilyName

string

Tên gia đình đánh vần như đúng.

phoneticGivenName

string

Tên đã đặt đánh vần đúng như tên gọi.

phoneticMiddleName

string

(Các) tên đệm đánh vần như cách đọc.

phoneticHonorificPrefix

string

Tiền tố kính ngữ được đánh vần theo đúng cách phát âm.

phoneticHonorificSuffix

string

Hậu tố kính ngữ được đánh vần đúng như cách đọc.

Biệt hiệu

Biệt hiệu của một người.

Biểu diễn dưới dạng JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": enum (NicknameType)
}
Trường
metadata

object (FieldMetadata)

Siêu dữ liệu về biệt hiệu.

value

string

Biệt hiệu.

type

enum (NicknameType)

Loại biệt hiệu.

NicknameType

Loại biệt hiệu.

Enum
DEFAULT Biệt hiệu chung chung.
MAIDEN_NAME

Tên thời con gái hoặc họ khai sinh. Được dùng khi họ của người đó thay đổi do kết quả hôn nhân.

INITIALS

Tên họ viết tắt.

GPLUS

Biệt hiệu của hồ sơ trên Google+.

OTHER_NAME

Mối liên kết nghề nghiệp hoặc tên khác; ví dụ: Dr. Smith.

ALTERNATE_NAME Tên thay thế của người.
SHORT_NAME

Tên ngắn hơn của người đó.

Nghề nghiệp

Nghề nghiệp của người dùng.

Biểu diễn dưới dạng JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
Trường
metadata

object (FieldMetadata)

Siêu dữ liệu về nghề nghiệp.

value

string

Nghề nghiệp; ví dụ: carpenter.

Tổ chức

Tổ chức trước đây hoặc hiện tại của một người. Phạm vi ngày trùng lặp được phép.

Biểu diễn dưới dạng 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
}
Trường
metadata

object (FieldMetadata)

Siêu dữ liệu về tổ chức.

type

string

Loại tổ chức. Loại này có thể là tuỳ chỉnh hoặc một trong các giá trị được xác định trước sau:

  • work
  • school
formattedType

string

Chỉ có đầu ra. Loại tổ chức được dịch và định dạng theo ngôn ngữ tài khoản của người xem hoặc ngôn ngữ tiêu đề HTTP Accept-Language.

startDate

object (Date)

Ngày bắt đầu khi người đó tham gia tổ chức.

endDate

object (Date)

Ngày kết thúc khi người đó rời khỏi tổ chức.

current

boolean

Đúng nếu tổ chức là tổ chức hiện tại của người đó; sai nếu tổ chức là tổ chức cũ.

name

string

Tên của tổ chức.

phoneticName

string

Tên theo phiên âm của tổ chức.

department

string

Bộ phận của người đó trong tổ chức.

title

string

Chức danh của người này trong tổ chức.

jobDescription

string

Nội dung mô tả công việc của người này tại tổ chức.

symbol

string

Ký hiệu liên quan đến tổ chức; ví dụ: mã chứng khoán, chữ viết tắt hoặc từ viết tắt.

domain

string

Tên miền liên kết với tổ chức; ví dụ: google.com.

location

string

Địa điểm của văn phòng của tổ chức mà người đó làm việc.

costCenter

string

Là trung tâm chi phí của người đó trong tổ chức.

fullTimeEquivalentMillipercent

integer

Tỷ lệ phần trăm toàn thời gian tương đương của người đó trong tổ chức (100.000 = 100%).

PhoneNumber

Số điện thoại của một người.

Biểu diễn dưới dạng JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "canonicalForm": string,
  "type": string,
  "formattedType": string
}
Trường
metadata

object (FieldMetadata)

Siêu dữ liệu về số điện thoại.

value

string

Số điện thoại.

canonicalForm

string

Chỉ có đầu ra. Dạng chuẩn hoá ITU-T E.164 của số điện thoại.

type

string

Loại số điện thoại. Loại này có thể là tuỳ chỉnh hoặc một trong các giá trị được xác định trước sau:

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

string

Chỉ có đầu ra. Loại số điện thoại được dịch và định dạng theo ngôn ngữ trong tài khoản của người xem hoặc ngôn ngữ tiêu đề HTTP Accept-Language.

Ảnh

Ảnh của một người. Hình ảnh hiển thị bên cạnh tên của người đó để giúp người khác nhận ra người đó.

Biểu diễn dưới dạng JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "url": string,
  "default": boolean
}
Trường
metadata

object (FieldMetadata)

Siêu dữ liệu về ảnh.

url

string

URL của ảnh. Bạn có thể thay đổi kích thước mong muốn bằng cách thêm tham số truy vấn sz={size} ở cuối URL, trong đó {size} là kích thước tính bằng pixel. Ví dụ: https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50

default

boolean

"True" nếu ảnh này là ảnh mặc định; "false" nếu ảnh là ảnh do người dùng cung cấp.

Mối quan hệ

Mối quan hệ của một người với một người khác.

Biểu diễn dưới dạng JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "person": string,
  "type": string,
  "formattedType": string
}
Trường
metadata

object (FieldMetadata)

Siêu dữ liệu về mối quan hệ.

person

string

Tên của người khác mà mối liên hệ này đề cập.

type

string

Mối quan hệ của người này với người kia. Loại này có thể là tuỳ chỉnh hoặc một trong các giá trị được xác định trước sau:

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

string

Chỉ có đầu ra. Loại mối quan hệ được dịch và định dạng bằng ngôn ngữ tài khoản của người xem hoặc ngôn ngữ được chỉ định trong tiêu đề HTTP Accept-Language.

RelationshipInterest

KHÔNG DÙNG NỮA: Hệ thống sẽ không trả về dữ liệu nào Mối quan hệ của một người .

Biểu diễn dưới dạng JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "formattedValue": string
}
Trường
metadata

object (FieldMetadata)

Siêu dữ liệu về mối quan hệ.

value

string

Loại mối quan hệ mà người đó đang tìm kiếm. Giá trị này có thể là giá trị tuỳ chỉnh hoặc là một trong các giá trị được xác định trước sau:

  • friend
  • date
  • relationship
  • networking
formattedValue

string

Chỉ có đầu ra. Giá trị của mối quan tâm được dịch và định dạng bằng ngôn ngữ tài khoản của người xem hoặc ngôn ngữ được chỉ định trong tiêu đề HTTP Accept-Language.

RelationshipStatus

KHÔNG DÙNG NỮA: Hệ thống sẽ không trả về dữ liệu nào về tình trạng quan hệ của một người.

Biểu diễn dưới dạng JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "formattedValue": string
}
Trường
metadata

object (FieldMetadata)

Siêu dữ liệu về tình trạng quan hệ.

value

string

Tình trạng của mối quan hệ. Giá trị này có thể là giá trị tuỳ chỉnh hoặc là một trong các giá trị được xác định trước sau:

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

string

Chỉ có đầu ra. Giá trị của trạng thái mối quan hệ được dịch và định dạng bằng ngôn ngữ tài khoản của người xem hoặc ngôn ngữ tiêu đề HTTP Accept-Language.

Nhà riêng

KHÔNG DÙNG NỮA: Vui lòng sử dụng person.locations. Nơi ở trong quá khứ hoặc hiện tại của người nào đó.

Biểu diễn dưới dạng JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "current": boolean
}
Trường
metadata

object (FieldMetadata)

Siêu dữ liệu về nơi cư trú.

value

string

Địa chỉ của nơi cư trú.

current

boolean

"True" nếu nơi cư trú này là nơi ở hiện tại của người đó; "false" nếu đây là nơi cư trú trước đây.

SipAddress

Địa chỉ SIP của một người. Địa chỉ Giao thức ban đầu của phiên được dùng cho hoạt động giao tiếp VoIP để thực hiện cuộc gọi thoại hoặc cuộc gọi video qua Internet.

Biểu diễn dưới dạng JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": string,
  "formattedType": string
}
Trường
metadata

object (FieldMetadata)

Siêu dữ liệu về địa chỉ SIP.

value

string

Địa chỉ SIP ở định dạng URI SIP RFC 3261 19.1.

type

string

Loại địa chỉ SIP. Loại này có thể là giá trị tuỳ chỉnh hoặc có thể là một trong các giá trị được xác định trước sau:

  • home
  • work
  • mobile
  • other
formattedType

string

Chỉ có đầu ra. Loại địa chỉ SIP được dịch và định dạng bằng ngôn ngữ tài khoản của người xem hoặc ngôn ngữ tiêu đề HTTP Accept-Language.

Kỹ năng

Một kỹ năng mà người đó có.

Biểu diễn dưới dạng JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
Trường
metadata

object (FieldMetadata)

Siêu dữ liệu về kỹ năng.

value

string

Kỹ năng; ví dụ: underwater basket weaving.

Dòng giới thiệu

KHÔNG DÙNG NỮA: Hệ thống sẽ không trả về dữ liệu nào. Thông tin mô tả ngắn gọn một dòng về người đó sẽ không được trả về.

Biểu diễn dưới dạng JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
Trường
metadata

object (FieldMetadata)

Siêu dữ liệu về dòng giới thiệu.

value

string

Dòng giới thiệu.

URL

URL được liên kết của một người.

Biểu diễn dưới dạng JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": string,
  "formattedType": string
}
Trường
metadata

object (FieldMetadata)

Siêu dữ liệu về URL.

value

string

URL.

type

string

Loại URL. Loại này có thể là tuỳ chỉnh hoặc một trong các giá trị được xác định trước sau:

  • home
  • work
  • blog
  • profile
  • homePage
  • ftp
  • reservations
  • appInstallPage: trang web để đăng ký Currents.
  • other
formattedType

string

Chỉ có đầu ra. Loại URL được dịch và định dạng bằng ngôn ngữ trong tài khoản của người xem hoặc ngôn ngữ tiêu đề HTTP Accept-Language.

UserDefined

Dữ liệu người dùng tuỳ ý do người dùng cuối điền.

Biểu diễn dưới dạng JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "key": string,
  "value": string
}
Trường
metadata

object (FieldMetadata)

Siêu dữ liệu về dữ liệu do người dùng xác định.

key

string

Khoá do người dùng cuối chỉ định trong dữ liệu do người dùng xác định.

value

string

Giá trị do người dùng cuối chỉ định của dữ liệu do người dùng xác định.

Phương thức

batchCreateContacts

Tạo một loạt địa chỉ liên hệ mới và trả về PersonResponse cho

Bạn phải gửi yêu cầu thay đổi cho cùng một người dùng theo tuần tự để tránh tăng độ trễ và lỗi.

batchDeleteContacts

Xoá một loạt địa chỉ liên hệ.

batchUpdateContacts

Cập nhật một loạt mục liên hệ và trả về bản đồ tên tài nguyên cho PersonResponse cho các mục liên hệ đã cập nhật.

createContact

Tạo một liên hệ mới và trả về tài nguyên người cho liên hệ đó.

deleteContact

Xoá người liên hệ.

deleteContactPhoto

Xoá ảnh của một người liên hệ.

get

Cung cấp thông tin về một người bằng cách chỉ định tên tài nguyên.

getBatchGet

Cung cấp thông tin về danh sách những người cụ thể bằng cách chỉ định danh sách tên tài nguyên được yêu cầu.

listDirectoryPeople

Cung cấp danh sách các hồ sơ trên miền và danh bạ miền trong thư mục miền của người dùng đã xác thực.

searchContacts

Cung cấp danh sách địa chỉ liên hệ trong danh bạ được nhóm của người dùng đã xác thực phù hợp với truy vấn tìm kiếm.

searchDirectoryPeople

Cung cấp danh sách các hồ sơ trên miền và địa chỉ liên hệ trên miền trong thư mục miền của người dùng đã xác thực khớp với truy vấn tìm kiếm.

updateContact

Cập nhật dữ liệu liên hệ cho một người liên hệ hiện có.

updateContactPhoto

Cập nhật ảnh của một người liên hệ.