このクラスを使用すると、Google グループの情報にアクセスできます。グループのメールアドレスやユーザーが直接のメンバーであるグループのリストなどの情報をクエリするために使用できます。
次の例は、現在のユーザーがメンバーになっているグループの数を示しています。
var groups = GroupsApp.getGroups(); Logger.log('You belong to ' + groups.length + ' groups.');
Properties
プロパティ | 種類 | 説明 |
---|---|---|
Role | Role |
Methods
方法 | 戻り値の型 | 概要 |
---|---|---|
getGroupByEmail(email) | Group | 指定したメールアドレスを持つグループを取得します。 |
getGroups() | Group[] | 直接的なメンバー(または保留中のメンバー)であるすべてのグループを取得します。 |
詳細なドキュメント
getGroupByEmail(email)
指定したメールアドレスを持つグループを取得します。グループが存在しない場合、またはグループを表示する権限がない場合は、例外をスローします。
次の例では、メールアドレスでグループを取得し、現在のユーザーがメンバーであるかどうかを出力しています。実行する前に、サンプルのメールアドレスを実際のグループのメールアドレスに置き換えてください。
var group = GroupsApp.getGroupByEmail("example@googlegroups.com"); var currentUser = Session.getActiveUser(); if (group.hasUser(currentUser)) { Logger.log("You are a member of this group."); } else { Logger.log("You are not a member of this group."); }
パラメータ
名前 | 型 | 説明 |
---|---|---|
email | String | 取得するグループのメールアドレス。 |
戻る
Group
- 指定したメールアドレスを持つグループ。
認可
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/groups
getGroups()
直接的なメンバー(または保留中のメンバー)であるすべてのグループを取得します。このグループがない場合は、空のリストになります。グループが存在しない場合、またはグループを表示する権限がない場合は、例外をスローします。
以下は、ユーザーが所属するすべてのグループのメールアドレスを出力する方法の例です。
function showMyGroups() { var groups = GroupsApp.getGroups(); var str = 'You are in ' + groups.length + ' groups: '; for (var i = 0; i < groups.length; i++) { var group = groups[i]; str = str + group.getEmail() + ' '; } Logger.log(str); }あるグループ B 自体が別のグループ A のメンバーになっている場合、そのグループ A には間接的にグループ登録が行われます。グループ A に送信されたメッセージのコピーを受け取った場合でも、実際にはそのグループに登録されていません。
Group.getRole(email)
を使用すると、返されたグループの既存のメンバーか、保留中のメンバーかを判断できます。
戻る
Group[]
- ユーザーが直接的なメンバーであるグループのリスト。
認可
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/groups