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)
    }
  ]
}
Các trường
resourceName

string

Tên tài nguyên cho nhóm liên hệ, do máy chủ chỉ định. Một chuỗi ASCII, dưới 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 trên web.
metadata

object (ContactGroupMetadata)

Chỉ đầu ra. Siêu dữ liệu về nhóm liên hệ.
groupType

enum (GroupType)

Chỉ đầu ra. Loại nhóm 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 đối với 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ỉ đầu ra. Tên được dịch và định dạng bằng ngôn ngữ của tài khoản người xem hoặc ngôn ngữ tiêu đề HTTP Accept-Language của 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ỉ đầ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 liên hệ. Trường này chỉ được điền cho các yêu cầu GET và sẽ chỉ trả về tối đa số thành viên là maxMembers trong yêu cầu nhận.
memberCount

integer

Chỉ đầ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 liên hệ.

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

string (Timestamp format)

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

Dấu thời gian ở định dạng "RFC" RFC3339 UTC, với độ phân giải nano giây và tối đa chín chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z" và "2014-10-02T15:01:23.045123456Z".
deleted

boolean

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

Loại nhóm

Loại nhóm 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.

Dữ liệu khách hàng nhóm

Dữ liệu khách hàng tuỳ ý được điền sẵn bởi khách hàng. Cho phép khóa và giá trị trùng lặp.

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

string

Máy khách đã chỉ định khóa của dữ liệu khách hàng.
value

string

Ứng dụng khách đã chỉ định giá trị của dữ liệu khách hàng.

Phương pháp

batchGet

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

create

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

delete

 Xoá nhóm 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 liên hệ đó.

get

 Lấy một nhóm 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 liên hệ đó.

list

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

update

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