Method: people.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.

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

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. Bản đồ tên tài nguyên đến dữ liệu người sẽ được cập nhật. Cho phép tối đa 200 người liên hệ trong một yêu cầu duy nhấ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ạ 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 chỉ định sẽ được thay thế hoặc bị xóa nếu để trống cho từng người. 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
readMask

string (FieldMask format)

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. Nếu để trống mặt nạ đọc, thì hàm sau biến đổi 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à:

  • 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_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ãy trả về BatchUpdateContactsErrorDetails kèm theo một danh sách lỗi tương ứng với từng địa chỉ liên hệ.

Phản hồi cho yêu cầu cập nhật một loạt danh bạ.

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

Sơ đồ liên kết tên tài nguyên đến các địa chỉ liên hệ đã được cập nhật, trừ khi yêu cầu readMask trống.

Đố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 bài viết Hướng dẫn uỷ quyền.