Groups Service

グループ

このサービスを使用すると、スクリプトから Google グループにアクセスできます。グループのメールアドレスや、ユーザーが直接メンバーであるグループのリストなどの情報をクエリできます。現在のユーザーがメンバーであるグループの数を示す例を次に示します。

var groups = GroupsApp.getGroups();
Logger.log('You are a member of %s Google Groups.', groups.length);

クラス

名前概要
Groupメンバーとグループ内のそれらのメンバーのロールに対してクエリを実行できるグループ オブジェクト。
GroupsAppこのクラスは、Google グループの情報にアクセスします。
Roleグループ内のユーザーのロール(オーナー、一般メンバーなど)。

Group

メソッド

メソッド戻り値の型概要
getEmail()Stringこのグループのメールアドレスを取得します。
getGroups()Group[]グループの直接の子グループを取得します。
getRole(email)Roleグループのコンテキストでユーザーのロールを取得します。
getRole(user)Roleグループのコンテキストでユーザーのロールを取得します。
getRoles(users)Role[]グループのコンテキストでユーザーのロールを取得します。
getUsers()User[]対応する Google アカウントが既知のグループの直接メンバーと禁止メンバーを取得します。
hasGroup(group)Booleanグループがこのグループの直接メンバーかどうかをテストします。
hasGroup(email)Booleanグループがこのグループの直接メンバーかどうかをテストします。
hasUser(email)Booleanユーザーがグループの直接メンバーかどうかをテストします。
hasUser(user)Booleanユーザーがグループの直接メンバーかどうかをテストします。

GroupsApp

プロパティ

プロパティタイプ説明
RoleRole

メソッド

メソッド戻り値の型概要
getGroupByEmail(email)Group指定されたメールアドレスを持つグループを取得します。
getGroups()Group[]自分が直接メンバー(または保留中のメンバ)であるすべてのグループを取得します。

Role

プロパティ

プロパティタイプ説明
OWNEREnumグループのオーナー。
MANAGEREnumグループのマネージャー。
MEMBEREnumこのグループのメンバーであるが、オーナーでもマネージャーでもないユーザー。
INVITEDEnumグループのオーナーまたは管理者からグループへの参加を招待されたものの、まだ招待を承諾していないユーザー。
PENDINGEnumグループへの参加をリクエストしたものの、オーナーまたはマネージャーによってまだ承認されていないユーザー。
BANNEDEnumグループへの参加を禁止されているユーザーは、グループへの参加を試行できません。