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

グループ内のメンバーの役割。グループ メンバーシップが循環している場合にもエラーが返されます。たとえば、group1 が group2 のメンバーである場合、group2 を group1 のメンバーにすることはできません。メンバーのロールの詳細については、メンバーにグループロールを割り当てるをご覧ください。

有効な値は次のとおりです。

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

string

リソースの ETag。
type

string

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

有効な値は次のとおりです。

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

string

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

string

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

有効な値は次のとおりです。

  • ALL_MAIL: 届いたメッセージはすべてすぐに配信されます。
  • DAILY: 1 日に 1 通まで。
  • DIGEST: 最大 25 件のメッセージが 1 つのメッセージにまとめられます。
  • DISABLED: 定期購入を削除します。
  • NONE: メッセージなし。
id

string

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

メソッド

delete

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

get

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

hasMember

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

insert

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

list

 グループ内のすべてのメンバーのパージネーション リストを取得します。

patch

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

update

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