REST Resource: groups

リソース: Group

Google グループを使用すると、ユーザーはグループのメールアドレスを使用してグループにメッセージを送信できます。一般的なタスクの詳細については、デベロッパー ガイドをご覧ください。

他のタイプのグループについては、Cloud Identity Groups API のドキュメントをご覧ください。

注: API を呼び出すユーザー（またはサービス アカウントによって権限を委任されているユーザー）には、Admin API Groups の権限（特権管理者やグループ管理者など）を含むロールが割り当てられている必要があります。

JSON 表現 
{
  "id": string,
  "email": string,
  "name": string,
  "description": string,
  "adminCreated": boolean,
  "directMembersCount": string,
  "kind": string,
  "etag": string,
  "aliases": [
    string
  ],
  "nonEditableAliases": [
    string
  ]
}
フィールド
id

string

読み取り専用。グループの一意の ID。グループ id は、グループ リクエスト URI の groupKey として使用できます。
email

string

グループのメールアドレス。アカウントに複数のドメインがある場合は、メールアドレスに適切なドメインを選択します。email は一意である必要があります。このプロパティは、グループを作成する際に必須です。グループ メールアドレスには、ユーザー名と同じ文字使用ルールが適用されます。詳しくは、ヘルプセンターをご覧ください。
name

string

グループの表示名。
description

string

ユーザーがグループの目的を判断できるようにするための詳細な説明。たとえば、グループへの参加を推奨するユーザー、グループ宛てに送信すべきメッセージの種類、グループに関するよくある質問へのリンク、関連するグループなど、さまざまな情報を追加することができます。最大長は 4,096 文字です。
adminCreated

boolean

読み取り専用。このグループがユーザーではなく管理者によって作成された場合、値は true です。
directMembersCount

string (int64 format)

グループの直接メンバーであるユーザーの数。グループがこのグループ（親）のメンバー（子）である場合、子グループのメンバーは親グループの directMembersCount プロパティにカウントされません。
kind

string

API リソースのタイプ。Groups リソースの場合、値は admin#directory#group です。
etag

string

リソースの ETag。
aliases[]

string

読み取り専用。グループのエイリアス メールアドレスのリスト。グループのエイリアスを追加、更新、削除するには、groups.aliases メソッドを使用します。グループの POST リクエストまたは PUT リクエストで編集した場合、編集は無視されます。
nonEditableAliases[]

string

読み取り専用。アカウントのプライマリ ドメインまたはサブドメイン外の、グループの編集不可のエイリアス メールアドレスのリスト。これらは、グループで使用されている有効なメールアドレスです。これは、グループの API レスポンスで返される読み取り専用のプロパティです。グループの POST リクエストまたは PUT リクエストで編集した場合、編集は無視されます。

メソッド

delete

 グループを削除する

get

 グループのプロパティを取得します。

insert

 グループを作成します。

list

 ドメインまたはユーザーキーを指定して、そのドメインまたはユーザーのすべてのグループを取得します（ページネーションあり）。

patch

 グループのプロパティを更新します。

update

 グループのプロパティを更新します。