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

 透過已分頁的方式擷取網域的所有群組或使用者的所有群組 (已分頁)。

patch

 更新群組屬性。

update

 更新群組屬性。