Groups Service

Groups

This service allows scripts to access Google Groups. It can be used to query information such as a group's email address, or the list of groups in which the user is a direct member. Here's an example that shows how many groups the current user is a member of:

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

Classes

NameBrief description
GroupA group object whose members and those members' roles within the group can be queried.
GroupsAppThis class provides access to Google Groups information.
RolePossible roles of a user within a group, such as owner or ordinary member.

Group

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.
getRoles(users)Role[]Retrieves users' roles in the context of the group.
getUsers()User[]Gets the direct members and banned 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.

GroupsApp

Properties

PropertyTypeDescription
RoleRole

Methods

MethodReturn typeBrief description
getGroupByEmail(email)GroupRetrieves the group having the specified email address.
getGroups()Group[]Retrieves all the groups of which you are a direct member (or a pending member).

Role

Properties

PropertyTypeDescription
OWNEREnumThe owner of a group.
MANAGEREnumThe manager of a group.
MEMBEREnumA user who is a member of this group but is neither an owner nor a manager.
INVITEDEnumA user who has been invited to join a group by an owner or manager of the group but who has not yet accepted the invitation.
PENDINGEnumA user who has requested to join a group but who has not yet been approved by an owner or manager.
BANNEDEnumA user who has been banned from a group and cannot attempt to join it.