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#、Java、JavaScript、Perl、Python などの C 言語系のプログラマに馴染みのあるルールを使用しています。
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