REST Resource: groups

資源：群組

Google 網路論壇可讓使用者使用群組的電子郵件地址，傳送訊息給一群使用者。如要進一步瞭解常見工作，請參閱《開發人員指南》。

如要瞭解其他類型的群組，請參閱 Cloud Identity Groups API 說明文件。

注意：呼叫 API 的使用者 (或由服務帳戶冒用身分的使用者) 必須具有已指派的角色，其中包含 Admin API 群組權限，例如超級管理員或群組管理員。

JSON 表示法 
{
  "id": string,
  "email": string,
  "name": string,
  "description": string,
  "adminCreated": boolean,
  "directMembersCount": string,
  "kind": string,
  "etag": string,
  "aliases": [
    string
  ],
  "nonEditableAliases": [
    string
  ]
}
欄位
id

string

這個唯讀設定檔群組的專屬 ID。群組 id 可用於群組要求 URI 的 groupKey。
email

string

群組的電子郵件地址。如果帳戶有多個網域，請選取適當的網域做為電子郵件地址。email 不得重複。建立群組時，必須使用這個屬性。群組電子郵件地址的字元使用規則與使用者名稱相同，詳情請參閱說明中心。
name

string

群組的顯示名稱。
description

string

擴充說明，協助使用者瞭解群組用途。舉例來說，您可以說明群組適合哪些使用者加入、適合接收哪些類型的訊息，或是提供群組的常見問題連結，或其他相關群組等資訊。長度上限為 4,096 個字元。
adminCreated

boolean

這個唯讀設定檔如果群組是由管理員而非使用者建立，這個值會是 true。
directMembersCount

string (int64 format)

群組的直接成員人數。如果某個群組是這個群組 (上層群組) 的成員 (子項)，則子項群組的成員不會計入上層群組的 directMembersCount 屬性。
kind

string

API 資源的類型。對於群組資源，這個值為 admin#directory#group。
etag

string

資源的 ETag。
aliases[]

string

這個唯讀設定檔群組的別名電子郵件地址清單。如要新增、更新或移除群組別名，請使用 groups.aliases 方法。如果在群組的 POST 或 PUT 要求中進行編輯，系統會忽略該項編輯。
nonEditableAliases[]

string

這個唯讀設定檔群組的別名電子郵件地址清單 (無法編輯)，這些地址不在帳戶的主網域或子網域中。這些是群組使用的有效電子郵件地址。這是 API 回應中針對群組傳回的唯讀屬性。如果在群組的 POST 或 PUT 要求中進行編輯，系統會忽略該項編輯。

方法

delete

 刪除群組。

get

 擷取群組的屬性。

insert

 建立群組。

list

 在指定 userKey 的情況下，擷取網域或使用者的所有群組 (分頁)。

patch

 更新群組的屬性。

update

 更新群組的屬性。