Method: people.batchUpdateContacts

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

Bạn nên gửi các 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

POST https://people.googleapis.com/v1/people:batchUpdateContacts

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

Nội dung yêu cầu

Nội dung yêu cầu chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "contacts": {
    string: {
      object (Person)
    },
    ...
  },
  "updateMask": string,
  "readMask": string,
  "sources": [
    enum (ReadSourceType)
  ]
}
Trường
contacts

map (key: string, value: object (Person))

Bắt buộc. Liên kết tên tài nguyên với dữ liệu về người dùng sẽ được cập nhật. Cho phép tối đa 200 địa chỉ liên hệ trong một yêu cầu.

Một đối tượng chứa danh sách các cặp "key": value. Ví dụ: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
updateMask

string (FieldMask format)

Bắt buộc. Mặt nạ trường để hạn chế các 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 chỉ định sẽ bị thay thế hoặc xóa nếu để trống cho từng người. Các giá trị hợp lệ là:

  • địa chỉ
  • tiểu sử
  • ngày sinh
  • calendarUrls
  • clientData
  • emailAddresses
  • sự kiện
  • externalIds
  • giới tính
  • imClients
  • sở thích
  • ngôn ngữ
  • vị trí
  • của kênh
  • miscKeywords
  • tên
  • biệt hiệu
  • nghề nghiệp
  • tổ chức
  • phoneNumbers
  • quan hệ
  • sipAddresses
  • url
  • userDefined
readMask

string (FieldMask format)

Bắt buộc. Mặt nạ trường để hạn chế các trường mà mỗi người dùng đượ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. Nếu mặt nạ đọc bị để trống, thì post-mutate-get sẽ bị bỏ qua và không có dữ liệu nào được trả về trong phản hồi. Các giá trị hợp lệ là:

  • địa chỉ
  • ageRanges
  • tiểu sử
  • ngày sinh
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • sự kiện
  • externalIds
  • giới tính
  • imClients
  • sở thích
  • ngôn ngữ
  • vị trí
  • của kênh
  • siêu dữ liệu
  • miscKeywords
  • tên
  • biệt hiệu
  • nghề nghiệp
  • tổ chức
  • phoneNumbers
  • ảnh
  • quan hệ
  • sipAddresses
  • kỹ năng
  • url
  • 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_CONTACT và READ_SOURCE_TYPE_PROFILE nếu không được đặt.

Nội dung phản hồi

Nếu không thành công, hàm sẽ trả về BatchUpdateContactsErrorDetails, một danh sách lỗi tương ứng với mỗi địa chỉ liên hệ.

Phản hồi cho yêu cầu cập nhật một loạt địa chỉ liên hệ.

Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:

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

map (key: string, value: object (PersonResponse))

Ánh xạ tên tài nguyên đến danh bạ đã được cập nhật, trừ phi yêu cầu readMask bị trống.

Một đối tượng chứa danh sách các cặp "key": value. Ví dụ: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

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 Hướng dẫn uỷ quyền.