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 顧客のアカウントのグループ設定を取得します。すべての get オペレーション は、 認証済みの ユーザーによって承認される必要があります。 グループ URI の GET
update 顧客のアカウントのグループ設定を更新します。すべての 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