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

 更新群組的屬性。