REST Resource: groups

リソース: Group

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

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

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

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 リソースのタイプ。グループ リソースの場合、値は admin#directory#group です。

etag

string

リソースの ETag。

aliases[]

string

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

nonEditableAliases[]

string

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

メソッド

delete

グループを削除します。

get

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

insert

グループを作成します。

list

userKey を指定して、ドメインまたはユーザーのすべてのグループを取得します(ページ分けされます)。

patch

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

update

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