REST Resource: contactGroups

資源：ContactGroup

聯絡人群組。

JSON 表示法 
{
  "resourceName": string,
  "etag": string,
  "metadata": {
    object (ContactGroupMetadata)
  },
  "groupType": enum (GroupType),
  "name": string,
  "formattedName": string,
  "memberResourceNames": [
    string
  ],
  "memberCount": integer,
  "clientData": [
    {
      object (GroupClientData)
    }
  ]
}
欄位
resourceName

string

伺服器指派的聯絡人群組的資源名稱。ASCII 字串，格式為 contactGroups/{contactGroupId}。
etag

string

資源的 HTTP 實體標記。用於網頁快取驗證。
metadata

object (ContactGroupMetadata)

僅供輸出。聯絡人群組的中繼資料。
groupType

enum (GroupType)

僅供輸出。聯絡人群組類型。
name

string

群組擁有者設定的聯絡人群組名稱，或是系統群組的名稱。

contactGroups.create 或 contactGroups.update 的名稱不得重複。如果嘗試以重複的名稱建立群組，系統將傳回 HTTP 409 錯誤。
formattedName

string

僅供輸出。以檢視者帳戶語言代碼或 Accept-Language HTTP 標頭語言代碼 (系統群組名稱) 的翻譯和格式設定名稱。擁有者設定的群組名稱與名稱相同。
memberResourceNames[]

string

僅供輸出。具備聯絡人群組成員的聯絡人資源名稱清單。這個欄位只會針對 GET 要求填入，且在 get 要求中只會傳回 maxMembers 名成員。
memberCount

integer

僅供輸出。群組中的聯絡人總數 (無論要求中指定的成員人數上限為何)。
clientData[]

object (GroupClientData)

群組的用戶端資料。

ContactGroupMetadata

聯絡人群組的中繼資料。

JSON 表示法 
{
  "updateTime": string,
  "deleted": boolean
}
欄位
updateTime

string (Timestamp format)

僅供輸出。群組上次更新時間。

RFC3339 世界標準時間「Zulu」的時間戳記格式，解析度為奈秒，且最多 9 個小數位數。範例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
deleted

boolean

僅供輸出。如果聯絡人群組資源已刪除，則為「是」。系統只會針對含有同步權杖的 contactGroups.list 要求填入資料。

GroupType

聯絡人群組類型。

列舉
GROUP_TYPE_UNSPECIFIED 未指明
USER_CONTACT_GROUP 使用者定義的聯絡人群組。
SYSTEM_CONTACT_GROUP 系統定義的聯絡人群組。

GroupClientData

用戶端填入的任意客戶資料。可輸入重複的鍵和值，

JSON 表示法 
{
  "key": string,
  "value": string
}
欄位
key

string

用戶端指定的客戶資料金鑰。
value

string

用戶端指定客戶資料的值。

方法

batchGet

 指定聯絡人群組資源名稱清單，取得已驗證使用者擁有的聯絡人群組清單。

create

 建立已驗證使用者擁有的新聯絡人群組。

delete

 指定聯絡人群組資源名稱，即可刪除已驗證使用者擁有的現有聯絡人群組。

get

 請指定聯絡人群組資源名稱，取得已驗證使用者擁有的特定聯絡人群組。

list

 列出已驗證使用者擁有的所有聯絡人群組。

update

 更新已驗證使用者所擁有的現有聯絡人群組名稱。