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#、Java、JavaScript、Perl、Python など、C ファミリーのプログラマーになじみのある規則が使用されています。

API のデータ形式を変更するには、リクエストの URI に alt クエリ文字列を含めます。次に例を示します。

JSON

GET https://www.googleapis.com/groups/v1/groups/[e-mail]?alt=json

Atom

GET https://www.googleapis.com/groups/v1/groups/[e-mail]?alt=atom