REST Resource: members

リソース: メンバー

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

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

string

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

email

string

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

role

string

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

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

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

string

リソースの ETag。

type

string

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

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

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

string

メンバーのステータス(不変)

delivery_settings

string

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

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

  • ALL_MAIL: すべてのメールは、受信するとすぐに配信されます。
  • DAILY: 1 日に 1 件以下。
  • DIGEST: 最大 25 件のメッセージを 1 つのメッセージにまとめます。
  • DISABLED: サブスクリプションを削除します。
  • NONE: メッセージはありません。
id

string

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

Methods

delete

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

get

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

hasMember

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

insert

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

list

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

patch

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

update

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