Gets this group's email address.

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

functionlistMyGroupEmails(){constgroups=GroupsApp.getGroups();for(leti=0;i <groups.length;i++){console.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 followingscopes:

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

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

In addition to this method, you can use theAdmin SDK Directory advanced service toretrieve group members in a domain.

functionlistGroupMembers(){constGROUP_EMAIL='example@googlegroups.com';constgroup=GroupsApp.getGroupByEmail(GROUP_EMAIL);constchildGroups=group.getGroups();console.log(`Group${GROUP_EMAIL} has${childGroups.length} groups:`);for(leti=0;i <childGroups.length;i++){constchildGroup=childGroups[i];console.log(childGroup.getEmail());}}

Return

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

Authorization

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

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

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

This example lists the owners of a group:

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

Parameters

Return

Role — That user's role within the group.

Authorization

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

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

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

This example lists the owners of a group:

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

Parameters

Return

Role — That user's role within the group.

Authorization

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

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

See also

• getRole(email)

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

This example lists the owners of a group:

constgroup=GroupsApp.getGroupByEmail('example@googlegroups.com');constusers=group.getUsers();constroles=group.getRoles(users);console.log('These are the group owners:');for(leti=0;i <users.length;i++){if(roles[i]===GroupsApp.Role.OWNER){console.log(users[i].getEmail());}}

Parameters

Return

Role[] — The roles of those users within the group.

Authorization

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

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

Gets the direct members and banned members of the group that have a known corresponding Googleaccount. Throws an exception if you don't have permission to view the group's member list orthe member emails.

Note: if you are a member of a group B which is itself a member of another group A then youareindirectly subscribed to group A. Although you receive copies of messages sent toit, 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 emailaddress of the group with that of one on your domain.

functionlistGroupMembers(){constGROUP_EMAIL='example@googlegroups.com';constgroup=GroupsApp.getGroupByEmail(GROUP_EMAIL);constusers=group.getUsers();console.log(`Group${GROUP_EMAIL} has${users.length} members:`);for(leti=0;i <users.length;i++){constuser=users[i];console.log(user.getEmail());}}

Return

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

Authorization

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

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

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

constgroup=GroupsApp.getGroupByEmail('example@googlegroups.com');constchildGroup=GroupsApp.getGroupByEmail('childgroup@googlegroups.com');if(group.hasGroup(childGroup)){console.log('childgroup@googlegroups.com is a child group');}

Parameters

Return

Boolean —true 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 followingscopes:

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

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

constgroup=GroupsApp.getGroupByEmail('example@googlegroups.com');if(group.hasGroup('childgroup@googlegroups.com')){console.log('childgroup@googlegroups.com is a child group');}

Parameters

Return

Boolean —true 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 followingscopes:

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

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

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

constgroup=GroupsApp.getGroupByEmail('example@googlegroups.com');constcurrentUser=Session.getActiveUser();if(group.hasUser(currentUser.getEmail())){console.log('You are a member');}

Parameters

Return

Boolean —true 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 followingscopes:

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

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

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

constgroup=GroupsApp.getGroupByEmail('example@googlegroups.com');constcurrentUser=Session.getActiveUser();if(group.hasUser(currentUser)){console.log('You are a member');}

Parameters

Return

Boolean —true 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 followingscopes:

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