Method: people.get

Cung cấp thông tin về một người bằng cách chỉ định tên tài nguyên. Sử dụng people/me để cho biết người dùng đã xác thực.

Yêu cầu này trả về lỗi 400 nếu không chỉ định "personFields".

Yêu cầu HTTP

GET https://people.googleapis.com/v1/{resourceName=people/*}

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số đường dẫn

Thông số
resourceName

string

Bắt buộc. Tên tài nguyên của người cần cung cấp thông tin.

  • Để nhận thông tin về người dùng đã xác thực, hãy chỉ định people/me.
  • Để nhận thông tin về một Tài khoản Google, hãy chỉ định people/{account_id}.
  • Để lấy thông tin về một mục liên hệ, hãy chỉ định tên tài nguyên giúp xác định mục liên hệ đó do people.connections.list trả về.

Tham số truy vấn

Thông số
requestMask
(deprecated)

object (RequestMask)

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

Một mặt nạ để giới hạn kết quả trong một nhóm nhỏ các trường chứa người dùng.
personFields

string (FieldMask format)

Bắt buộc. Mặt nạ trường (field mask) để hạn chế những trường trên người được trả về. Bạn có thể chỉ định nhiều trường bằng cách dùng dấu phẩy phân tách các trường. Các giá trị hợp lệ là:

  • các địa chỉ
  • ageRanges
  • tiểu sử
  • sinh nhật
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • sự kiện
  • externalIds
  • giới tính
  • imClients
  • sở thích
  • locales
  • vị trí
  • của kênh
  • siêu dữ liệu
  • miscKeywords
  • names
  • biệt hiệu
  • nghề nghiệp
  • organizations
  • phoneNumbers
  • ảnh
  • quan hệ
  • sipAddresses
  • kỹ năng
  • urls
  • userDefined
sources[]

enum (ReadSourceType)

Không bắt buộc. Mặt nạ cho biết các loại nguồn cần trả về. Giá trị mặc định là READ_SOURCE_TYPE_PROFILE và READ_SOURCE_TYPE_CONTACT nếu không được đặt.

Nội dung yêu cầu

Nội dung yêu cầu phải trống.

Nội dung phản hồi

Nếu thành công, nội dung phản hồi sẽ chứa một phiên bản của Person.

Phạm vi uỷ quyền

Bạn không cần phải cho phép truy cập vào dữ liệu công khai. Đối với dữ liệu riêng tư, cần phải sử dụng một trong các phạm vi OAuth sau đây:

  • https://www.googleapis.com/auth/contacts
  • https://www.googleapis.com/auth/contacts.readonly
  • https://www.googleapis.com/auth/contacts.other.readonly
  • https://www.googleapis.com/auth/directory.readonly
  • https://www.googleapis.com/auth/profile.agerange.read
  • https://www.googleapis.com/auth/profile.emails.read
  • https://www.googleapis.com/auth/profile.language.read
  • https://www.googleapis.com/auth/user.addresses.read
  • https://www.googleapis.com/auth/user.birthday.read
  • https://www.googleapis.com/auth/user.emails.read
  • https://www.googleapis.com/auth/user.gender.read
  • https://www.googleapis.com/auth/user.organization.read
  • https://www.googleapis.com/auth/user.phonenumbers.read
  • https://www.googleapis.com/auth/userinfo.email
  • https://www.googleapis.com/auth/userinfo.profile

Để biết thêm thông tin, hãy xem bài viết Hướng dẫn uỷ quyền.