このページは Cloud Translation API によって翻訳されました。

Class GroupsApp

このクラスを使用すると、Google グループの情報にアクセスできます。次のような情報を照会するために使用できます。グループのメールアドレス、またはユーザーが直接メンバーになっているグループのリストを指定できます。

次の例は、現在のユーザーがメンバーになっているグループの数を示しています。

var groups = GroupsApp.getGroups();
Logger.log('You belong to ' + groups.length + ' groups.');

プロパティ

プロパティ	タイプ	説明
`Role`	`Role`

メソッド

メソッド	戻り値の型	概要
`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 に間接登録している。メッセージのコピーが「親」に送信されます実際にはそのグループには登録されていません

Group.getRole(email) を使用すると、既存または保留中のものかどうかを判断できます。メンバーです。

戻る

Group[] - ユーザーが直接メンバーであるグループのリスト。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。

https://www.googleapis.com/auth/groups