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

Name	Brief description
`Group`	A group object whose members and those members' roles within the group can be queried.
`GroupsApp`	This class provides access to Google Groups information.
`Role`	Possible roles of a user within a group, such as owner or ordinary member.

`Group`

Methods

Method	Return type	Brief description
`getEmail()`	`String`	Gets this group's email address.
`getGroups()`	`Group[]`	Retrieves the direct child groups of the group.
`getRole(email)`	`Role`	Retrieves a user's role in the context of the group.
`getRole(user)`	`Role`	Retrieves 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 of the group that have a known corresponding Google account.
`hasGroup(group)`	`Boolean`	Tests if a group is a direct member of this group.
`hasGroup(email)`	`Boolean`	Tests if a group is a direct member of this group.
`hasUser(email)`	`Boolean`	Tests if a user is a direct member of the group.
`hasUser(user)`	`Boolean`	Tests if a user is a direct member of the group.

`GroupsApp`

Properties

Property	Type	Description
`Role`	`Role`

Methods

Method	Return type	Brief description
`getGroupByEmail(email)`	`Group`	Retrieves 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

Property	Type	Description
`OWNER`	`Enum`	The owner of a group.
`MANAGER`	`Enum`	The manager of a group.
`MEMBER`	`Enum`	A user who is a member of this group but is neither an owner nor a manager.
`INVITED`	`Enum`	A 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.
`PENDING`	`Enum`	A user who has requested to join a group but who has not yet been approved by an owner or manager.