Groups Settings API 總覽

Groups Settings API 可更新及擷取現有 Google 群組的設定。透過這項 API,您可以執行下列操作:

  • 修改群組設定,控管內部和外部群組的存取權。
  • 編輯群組的通知。
  • 設定討論內容封存和訊息審核功能。
  • 自訂帳戶的使用者群組。

如要進一步瞭解如何使用 Google 群組或管理其他類型的群組,請參閱 Cloud Identity 說明文件

Groups Settings API 資料模型

Groups Settings API 會對 Groups 資源執行作業,該資源代表帳戶中的使用者如何與其他人的群組通訊及協作。每個群組都以電子郵件地址做為識別依據。

API 資料模型是以帳戶群組的 Groups 集合為基礎。每個群組都有一組專屬的設定。

Groups Settings API 作業

您可以在 Groups Settings API 中呼叫群組設定方法,如下表所述:

作業 說明 REST HTTP 對應
get 取得客戶帳戶的群組設定。所有取得作業都必須由已驗證的使用者授權。 群組 URI 的 GET
update 更新客戶帳戶的群組設定。所有更新作業都必須由經過驗證的使用者授權。 群組 URI 的 PUT

JSON 和 Atom 資料格式

Groups Settings API 預設會以 JSON 格式傳回資料。Atom 標記是替代資料格式。JSON 和 Atom 資料格式都支援完整的讀寫功能。

JSON 是常見的網際網路格式,可代表任意資料結構。根據 json.org 的說明,JSON 是一種與語言完全無關的文字格式,但使用的慣例與 C 系列語言 (包括 C、C++、C#、Java、JavaScript、Perl 和 Python) 的程式設計師所熟悉的慣例相同。

您可以在要求的 URI 中加入 alt 查詢字串,變更 API 的資料格式。例如:

JSON

GET https://www.googleapis.com/groups/v1/groups/salesgroup@example.com?alt=json

Atom

GET https://www.googleapis.com/groups/v1/groups/salesgroup@example.com?alt=atom