REST Resource: contactGroups

Tài nguyên: ContactGroup

Một nhóm người liên hệ.

Biểu diễn dưới dạng JSON
{
  "resourceName": string,
  "etag": string,
  "metadata": {
    object (ContactGroupMetadata)
  },
  "groupType": enum (GroupType),
  "name": string,
  "formattedName": string,
  "memberResourceNames": [
    string
  ],
  "memberCount": integer,
  "clientData": [
    {
      object (GroupClientData)
    }
  ]
}
Trường
resourceName

string

Tên tài nguyên cho nhóm địa chỉ liên hệ, do máy chủ chỉ định. Chuỗi ASCII, ở dạng contactGroups/{contactGroupId}.

etag

string

Thẻ thực thể HTTP của tài nguyên. Dùng để xác thực bộ nhớ đệm web.

metadata

object (ContactGroupMetadata)

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

groupType

enum (GroupType)

Chỉ có đầu ra. Loại nhóm người liên hệ.

name

string

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

Đối với contactGroups.create hoặc contactGroups.update, tên phải là duy nhất cho 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.

formattedName

string

Chỉ có đầu ra. Tên được dịch và định dạng trong ngôn ngữ tài khoản của người xem hoặc ngôn ngữ tiêu đề HTTP Accept-Language cho tên nhóm hệ thống. Tên nhóm do chủ sở hữu đặt giống với tên.

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 sẵ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.

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.

clientData[]

object (GroupClientData)

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

ContactGroupMetadata

Siêu dữ liệu về một nhóm người liên hệ.

Biểu diễn dưới dạng JSON
{
  "updateTime": string,
  "deleted": boolean
}
Trường
updateTime

string (Timestamp format)

Chỉ có đầu ra. Thời gian nhóm được cập nhật lần gần đây nhất.

Dấu thời gian theo múi giờ "Zulu" RFC3339 (giờ UTC) với độ phân giải nano giây và lên đến 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z".

deleted

boolean

Chỉ có đầu ra. Đúng nếu tài nguyên nhóm địa chỉ liên hệ đã bị xoá. Chỉ được điền sẵn cho các yêu cầu contactGroups.list có chứa mã thông báo đồng bộ hoá.

GroupType

Loại nhóm người liên hệ.

Enum
GROUP_TYPE_UNSPECIFIED Không xác định.
USER_CONTACT_GROUP Nhóm liên hệ do người dùng xác định.
SYSTEM_CONTACT_GROUP Nhóm liên hệ do hệ thống xác định.

GroupClientData

Dữ liệu khách hàng tuỳ ý do khách hàng điền sẵn. Các khoá và giá trị trùng lặp được cho phép.

Biểu diễn dưới dạng JSON
{
  "key": string,
  "value": string
}
Trường
key

string

Khoá do ứng dụng chỉ định cho dữ liệu ứng dụng.

value

string

Giá trị do khách hàng chỉ định cho dữ liệu ứng dụng.

Phương thức

batchGet

Lấy danh sách các nhóm địa chỉ liên hệ do người dùng đã xác thực sở hữu bằng cách chỉ định danh sách tên tài nguyên nhóm địa chỉ liên hệ.

create

Tạo một nhóm liên hệ mới do người dùng đã xác thực sở hữu.

delete

Xoá nhóm địa chỉ liên hệ hiện có do người dùng đã xác thực sở hữu bằng cách chỉ định tên tài nguyên của nhóm địa chỉ liên hệ.

get

Lấy một nhóm địa chỉ liên hệ cụ thể do người dùng đã xác thực sở hữu bằng cách chỉ định tên tài nguyên của nhóm địa chỉ liên hệ.

list

Liệt kê tất cả các nhóm liên hệ do người dùng đã xác thực sở hữu.

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.