Method: people.updateContact

Cập nhật dữ liệu liên hệ cho một người liên hệ hiện có. Mọi dữ liệu không liên hệ sẽ không được sửa đổi. Mọi dữ liệu không liên hệ của người mà bạn cập nhật sẽ bị bỏ qua. Tất cả các trường được chỉ định trong updateMask đều sẽ được thay thế.

Máy chủ trả về lỗi 400 nếu person.metadata.sources không được chỉ định để cập nhật địa chỉ liên hệ hoặc nếu không có nguồn liên hệ.

Máy chủ trả về lỗi 400 với lý do "failedPrecondition" nếu person.metadata.sources.etag khác với etag của địa chỉ liên hệ, cho biết địa chỉ liên hệ đã thay đổi kể từ khi dữ liệu được đọc. Khách hàng phải có được người mới nhất và hợp nhất các nội dung cập nhật của họ thành người mới nhất.

Máy chủ trả về lỗi 400 nếu memberships đang được cập nhật và không có thành viên nhóm người liên hệ nào được chỉ định cho người đó.

Máy chủ trả về lỗi 400 nếu nhiều trường được chỉ định trong trường là singleton cho nguồn liên hệ:

  • tiểu sử
  • sinh nhật
  • giới tính
  • names

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.

Yêu cầu HTTP

PATCH https://people.googleapis.com/v1/{person.resourceName=people/*}:updateContact

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

Tham số đường dẫn

Thông số
person.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}.

Tham số truy vấn

Thông số
updatePersonFields

string (FieldMask format)

Bắt buộc. Mặt nạ cho trường (field mask) để hạn chế những trường trên người đó được cập nhật. 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. Tất cả các trường đã cập nhật sẽ được thay thế. Các giá trị hợp lệ là:

  • các địa chỉ
  • tiểu sử
  • sinh nhật
  • calendarUrls
  • clientData
  • emailAddresses
  • sự kiện
  • externalIds
  • giới tính
  • imClients
  • sở thích
  • locales
  • vị trí
  • của kênh
  • miscKeywords
  • names
  • biệt hiệu
  • nghề nghiệp
  • organizations
  • phoneNumbers
  • quan hệ
  • sipAddresses
  • urls
  • userDefined
personFields

string (FieldMask format)

Không bắt buộc. Mặt nạ cho trường (field mask) để hạn chế những trường được trả về cho mỗi người. 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. Giá trị mặc định là tất cả các trường nếu bạn không đặt chính sách này. 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_CONTACTREAD_SOURCE_TYPE_PROFILE nếu không được đặt.

Nội dung yêu cầu

Nội dung yêu cầu chứa một bản sao của Person.

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

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/contacts

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