リソース: Group
Google グループでは、グループのメールアドレスを使用して特定のグループにメッセージを送信できます。一般的なタスクの詳細については、デベロッパー ガイドをご覧ください。
他の種類のグループについては、Cloud Identity Groups API のドキュメントをご覧ください。
注: API を呼び出すユーザー(またはサービス アカウントによる権限借用を受けている)には、特権管理者やグループ管理者などの管理 API グループ権限を含むロールを割り当てる必要があります。
JSON 表現 |
---|
{ "id": string, "email": string, "name": string, "description": string, "adminCreated": boolean, "directMembersCount": string, "kind": string, "etag": string, "aliases": [ string ], "nonEditableAliases": [ string ] } |
フィールド | |
---|---|
id |
読み取り専用。グループの一意の ID。グループ |
email |
グループのメールアドレス。アカウントに複数のドメインがある場合は、メールアドレスに適切なドメインを選択します。 |
name |
グループの表示名。 |
description |
ユーザーがグループの目的を判断する際に役立つ詳細な説明。たとえば、グループに参加する必要があるユーザー、グループに送信するメッセージの種類、グループに関するよくある質問へのリンク、関連グループに関する情報を含めることができます。最大長は |
adminCreated |
読み取り専用。このグループがユーザーではなく管理者によって作成された場合、値は |
directMembersCount |
グループの直接メンバーであるユーザーの数。グループがこのグループのメンバー(親)である場合、子グループのメンバーは親グループの |
kind |
API リソースのタイプ。グループ リソースの場合、値は |
etag |
リソースの ETag。 |
aliases[] |
読み取り専用。グループのエイリアス メールアドレスのリスト。グループのエイリアスを追加、更新、削除するには、 |
nonEditableAliases[] |
読み取り専用。アカウントのプライマリ ドメインまたはサブドメインに含まれない、グループの編集不可のエイリアス メールアドレスのリスト。グループで使用されている有効なメールアドレスです。これは、グループに対する API のレスポンスで返される読み取り専用のプロパティです。グループの POST または PUT リクエスト内で編集された場合、編集は無視されます。 |
Methods |
|
---|---|
|
グループを削除します。 |
|
グループのプロパティを取得します。 |
|
グループを作成する。 |
|
ドメインのグループ、または userKey で指定されたユーザーのすべてのグループを取得します(ページ分けされます)。 |
|
グループのプロパティを更新します。 |
|
グループのプロパティを更新します。 |