Class Group

Group

A group object whose members and those members' roles within the group can be queried.

Here's an example which shows the members of a group. Before running it, replace the email address of the group with that of one on your domain.

function listGroupMembers() {
  var group = GroupsApp.getGroupByEmail("example@googlegroups.com");
  var str = group.getEmail() + ': ';
  var users = group.getUsers();
  for (var i = 0; i < users.length; i++) {
    var user = users[i];
    str = str + user.getEmail() + ", ";
  }
  Logger.log(str);
}

Methods

MethodReturn typeBrief description
getEmail()StringGets this group's email address.
getGroups()Group[]Retrieves the direct child groups of the group.
getRole(email)RoleRetrieves a user's role in the context of the group.
getRole(user)RoleRetrieves a user's role in the context of the group.
getUsers()User[]Retrieves the direct members of the group that have a known corresponding Google account.
hasGroup(group)BooleanTests if a group is a direct member of this group.
hasGroup(email)BooleanTests if a group is a direct member of this group.
hasUser(email)BooleanTests if a user is a direct member of the group.
hasUser(user)BooleanTests if a user is a direct member of the group.

Detailed documentation

getEmail()

Gets this group's email address.

This example lists the email address of all the groups the user belongs to.

function listMyGroupEmails() {
  var groups = GroupsApp.getGroups();
  for (var i = 0; i < groups.length; i++) {
    Logger.log(groups[i].getEmail());
  }
}

Return

String — The group's email address.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

getGroups()

Retrieves the direct child groups of the group. Throws an exception if you do not have permission to view the group's member list.

In addition to this method, you can use the Admin SDK Directory advanced service to retrieve group members in a domain.


  function listGroupMembers() {
    var GROUP_EMAIL = "example@googlegroups.com";
    var group = GroupsApp.getGroupByEmail(GROUP_EMAIL);
    var childGroups = group.getGroups();
    var str = "Group " + GROUP_EMAIL + " has " + childGroup.length +
    " groups: ";
    for (var i = 0; i < childGroups.length; i++) {
      var childGroup = childGroups[i];
      str = str + childGroup.getEmail() + ", ";
    }
    Logger.log(str);
  }

Return

Group[] — All the direct child groups of the group.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

getRole(email)

Retrieves a user's role in the context of the group. A user who is a direct member of a group has exactly one role within that group. Throws an exception if the user is not a member of the group or if you do not have permission to view the group's member list.

This example lists the owners of a group:

var group = GroupsApp.getGroupByEmail("example@googlegroups.com");
var users = group.getUsers();
Logger.log('These are the group owners:');
for (var i = 0; i < users.length; i++) {
  var user = users[i];
  if (group.getRole(user.getEmail()) == GroupsApp.Role.OWNER) {
    Logger.log(user.getEmail());
  }
}

Parameters

NameTypeDescription
emailStringA user's email address.

Return

Role — That user's role within the group.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

getRole(user)

Retrieves a user's role in the context of the group. A user who is a direct member of a group has exactly one role within that group. Throws an exception if the user is not a member of the group or if you do not have permission to view the group's member list.

This example lists the owners of a group:

var group = GroupsApp.getGroupByEmail("example@googlegroups.com");
var users = group.getUsers();
Logger.log('These are the group owners:');
for (var i = 0; i < users.length; i++) {
  var user = users[i];
  if (group.getRole(user) == GroupsApp.Role.OWNER) {
    Logger.log(user.getEmail());
  }
}

Parameters

NameTypeDescription
userUserThe user whose role to retrieve.

Return

Role — That user's role within the group.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

See also


getUsers()

Retrieves the direct members of the group that have a known corresponding Google account. Throws an exception if you do not have permission to view the group's member list.

Note: if you are a member of a group B which is itself a member of another group A then you are indirectly subscribed to group A. Although you receive copies of messages sent to it, you are not actually subscribed to the parent group A.

Here's an example which shows the members of a group. Before running it, replace the email address of the group with that of one on your domain.

function listGroupMembers() {
  var GROUP_EMAIL = "example@googlegroups.com";
  var group = GroupsApp.getGroupByEmail(GROUP_EMAIL);
  var users = group.getUsers();
  var str = "Group " + GROUP_EMAIL + " has " + users.length +
  " members: ";
  for (var i = 0; i < users.length; i++) {
    var user = users[i];
    str = str + user.getEmail() + ", ";
  }
  Logger.log(str);
}
In addition to this method, you can use the Admin SDK Directory advanced service to retrieve group members in a domain.

Return

User[] — All the direct members of the group.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

hasGroup(group)

Tests if a group is a direct member of this group. The method does not return true if the tested group is nested more than one level below this group. Throws an exception if you do not have permission to view the group's member list.

var group = GroupsApp.getGroupByEmail("example@googlegroups.com");
var childGroup = GroupsApp.getGroupByEmail("childgroup@googlegroups.com");
if (group.hasGroup(childGroup)) {
  Logger.log("childgroup@googlegroups.com is a child group");
}

Parameters

NameTypeDescription
groupGroupThe group whose membership to test.

Return

Booleantrue if that group is a child group of this group; false otherwise.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

hasGroup(email)

Tests if a group is a direct member of this group. The method does not return true if the tested group is nested more than one level below this group. Throws an exception if you do not have permission to view the group's member list.

var group = GroupsApp.getGroupByEmail("example@googlegroups.com");
if (group.hasGroup("childgroup@googlegroups.com")) {
  Logger.log("childgroup@googlegroups.com is a child group");
}

Parameters

NameTypeDescription
emailStringA group's email address.

Return

Booleantrue if that group is a child group of this group; false otherwise.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

hasUser(email)

Tests if a user is a direct member of the group. Throws an exception if you do not have permission to view the group's member list.

Here's an example which checks if the current user is a member of a group:

var group = GroupsApp.getGroupByEmail("example@googlegroups.com");
var currentUser = Session.getActiveUser();
if (group.hasUser(currentUser.getEmail())) {
  Logger.log("You are a member");
}

Parameters

NameTypeDescription
emailStringA user's email address.

Return

Booleantrue if that user is a member of the group; false otherwise.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

hasUser(user)

Tests if a user is a direct member of the group. Throws an exception if you do not have permission to view the group's member list.

Here's an example which checks if the current user is a member of a group:

var group = GroupsApp.getGroupByEmail("example@googlegroups.com");
var currentUser = Session.getActiveUser();
if (group.hasUser(currentUser)) {
  Logger.log("You are a member");
}

Parameters

NameTypeDescription
userUserThe user whose membership to test.

Return

Booleantrue if that user is a member of the group; false otherwise.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

Send feedback about...

Apps Script
Apps Script
Need help? Visit our support page.