REST Resource: members

リソース: Member

Google グループのメンバーは、ユーザーまたは別のグループです。このメンバーは、アカウントのドメイン内外のメンバーのどちらでも構いません。グループ メンバーの一般的なタスクについて詳しくは、デベロッパー ガイドをご覧ください。

JSON 表現 
{
  "kind": string,
  "email": string,
  "role": string,
  "etag": string,
  "type": string,
  "status": string,
  "delivery_settings": string,
  "id": string
}
フィールド
kind

string

API リソースのタイプ。Members リソースの場合、値は admin#directory#member です。
email

string

メンバーのメールアドレス。メンバーは、ユーザーまたは別のグループです。このプロパティは、メンバーをグループに追加する場合は必須です。email は一意である必要があり、別のグループのエイリアスにはできません。メールアドレスが変更されると、API に自動的にメールアドレスの変更が反映されます。
role

string

グループ内のメンバーのロール。グループ メンバーシップのサイクルに対して、API からエラーが返されます。たとえば、group1 が group2 のメンバーの場合、group2 を group1 のメンバーにすることはできません。メンバーのロールについて詳しくは、グループのロールをメンバーに割り当てるをご覧ください。

指定できる値は次のとおりです。

  • MANAGER: このロールは、管理コンソールを使用してビジネス向け Google グループが有効になっている場合にのみ使用できます。ビジネス向け Google グループを有効または無効にするをご覧ください。MANAGER ロールでは、メンバーを OWNER にすることと、グループを削除することを除き、OWNER ロールによって行われるすべてのことを実行できます。グループには複数の MANAGER メンバーを含めることができます。
  • MEMBER: このロールは、グループへの登録、ディスカッション アーカイブの閲覧、グループのメンバー リストの表示を行えます。メンバーのロールについて詳しくは、グループのロールをメンバーに割り当てるをご覧ください。
  • OWNER: このロールは、グループへのメッセージの送信、メンバーの追加と削除、メンバーのロールの変更、グループの設定の変更、グループの削除を行うことができます。OWNER はグループのメンバーである必要があります。1 つのグループに複数の OWNER を設定できます。
etag

string

リソースの ETag。
type

string

グループ メンバーのタイプ。

指定できる値は次のとおりです。

  • CUSTOMER: メンバーはドメイン内のすべてのユーザーを表します。メールアドレスは返されず、お客様 ID が返されます。
  • EXTERNAL: メンバーはドメイン外のユーザーまたはグループです。（現在は使用されていません）
  • GROUP: メンバーは別のグループです。
  • USER: メンバーはユーザー。
status

string

メンバーのステータス（不変）
delivery_settings

string

メンバーのメール配信設定を定義します。このフィールドは、insert、update、get メソッドでのみサポートされています。

指定できる値は次のとおりです。

  • ALL_MAIL: すべてのメールが届き次第配信されます。
  • DAILY: 1 日に 1 件以下のメッセージ。
  • DIGEST: 1 つのメッセージにバンドルされた最大 25 件のメッセージ。
  • DISABLED: サブスクリプションを削除します。
  • NONE: メッセージはありません。
id

string

グループ メンバーの一意の ID。メンバー id は、メンバー リクエスト URI の memberKey として使用できます。

メソッド

delete

 グループからメンバーを削除します。

get

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

hasMember

 指定したユーザーがグループのメンバーかどうかを確認します。

insert

 指定したグループにユーザーを追加します。

list

 グループ内のすべてのメンバーについて、ページ分けされたリストを取得します。

patch

 指定されたグループ内のユーザーのメンバーシップ プロパティを更新します。

update

 指定したグループ内のユーザーのメンバーシップを更新します。