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 |
顧客のグループの設定を取得します。すべての 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 など）を使用しています。
API のデータ形式を変更するには、リクエストの URI に alt クエリ文字列を追加します。次に例を示します。
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