Method: contactGroups.update

Cập nhật tên của một nhóm liên hệ hiện có do người dùng đã xác thực sở hữu.

Tên nhóm liên hệ được cập nhật phải là duy nhất cho các nhóm liên hệ của người dùng. Việc cố gắng tạo một nhóm có tên trùng lặp sẽ trả về lỗi HTTP 409.

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

PUT https://people.googleapis.com/v1/{contactGroup.resourceName=contactGroups/*}

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

Tham số đường dẫn

Thông số
contactGroup.resourceName

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}.

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 
{
  "contactGroup": {
    "resourceName": string,
    "etag": string,
    "metadata": {
      "updateTime": string,
      "deleted": boolean
    },
    "groupType": enum (GroupType),
    "name": string,
    "formattedName": string,
    "memberResourceNames": [
      string
    ],
    "memberCount": integer,
    "clientData": [
      {
        "key": string,
        "value": string
      }
    ]
  },
  "updateGroupFields": string,
  "readGroupFields": string
}
Trường
contactGroup.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.
contactGroup.metadata

object (ContactGroupMetadata)

Chỉ có đầu ra. Siêu dữ liệu về nhóm người liên hệ.
contactGroup.groupType

enum (GroupType)

Chỉ có đầu ra. Loại nhóm địa chỉ liên hệ.
contactGroup.name

string

Tên nhóm người liên hệ do chủ sở hữu nhóm đặt hoặc tên do hệ thống cung cấp cho nhóm hệ thống.

Đối với contactGroups.create hoặc contactGroups.update, tên phải là duy nhất đối với các nhóm liên hệ của người dùng. Việc cố gắng tạo một nhóm có tên trùng lặp sẽ trả về lỗi HTTP 409.
contactGroup.formattedName

string

Chỉ có đầu ra. Tên đượ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 cho tên của nhóm hệ thống. Tên nhóm do chủ sở hữu đặt giống với tên.
contactGroup.memberResourceNames[]

string

Chỉ có đầu ra. Danh sách tên tài nguyên của người liên hệ là thành viên của nhóm người liên hệ. Trường này chỉ được điền cho các yêu cầu GET và sẽ chỉ trả về số lượng thành viên tối đa là maxMembers trong yêu cầu get.
contactGroup.memberCount

integer

Chỉ có đầu ra. Tổng số người liên hệ trong nhóm, bất kể số thành viên tối đa được chỉ định trong yêu cầu.
contactGroup.clientData[]

object (GroupClientData)

Dữ liệu khách hàng của nhóm.
updateGroupFields

string (FieldMask format)

Không bắt buộc. Mặt nạ trường (field mask) để hạn chế các trường trong nhóm này đượ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. Giá trị mặc định là name nếu không được đặt hoặc được đặt thành trống. Các trường cập nhật sẽ được thay thế. Các giá trị hợp lệ là:

  • clientData
  • tên
readGroupFields

string (FieldMask format)

Không bắt buộc. Mặt nạ trường (field mask) để hạn chế những trường trong nhóm được trả về. Giá trị mặc định là metadata, groupType và name nếu không được đặt hoặc được đặt thành trống. Các trường hợp lệ là:

  • clientData
  • groupType
  • memberCount
  • siêu dữ liệu
  • tên

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 ContactGroup.

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.