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グループへの参加を禁止されているユーザー。グループへの参加を試みることはできません。