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 |
|---|---|
| `https://developers.google.com/apps-script/reference/groups/group` | A group object whose members and those members' roles within the group can be queried. |
| `https://developers.google.com/apps-script/reference/groups/groups-app` | This class provides access to Google Groups information. |
| `https://developers.google.com/apps-script/reference/groups/role` | Possible roles of a user within a group, such as owner or ordinary member. |

## `https://developers.google.com/apps-script/reference/groups/group`

### Methods

| Method | Return type | Brief description |
|---|---|---|
| `https://developers.google.com/apps-script/reference/groups/group#getEmail()` | `String` | Gets this group's email address. |
| `https://developers.google.com/apps-script/reference/groups/group#getGroups()` | `https://developers.google.com/apps-script/reference/groups/group` | Retrieves the direct child groups of the group. |
| `https://developers.google.com/apps-script/reference/groups/group#getRole(String)` | `https://developers.google.com/apps-script/reference/groups/role` | Retrieves a user's role in the context of the group. |
| `https://developers.google.com/apps-script/reference/groups/group#getRole(User)` | `https://developers.google.com/apps-script/reference/groups/role` | Retrieves a user's role in the context of the group. |
| `https://developers.google.com/apps-script/reference/groups/group#getRoles(User)` | `https://developers.google.com/apps-script/reference/groups/role` | Retrieves users' roles in the context of the group. |
| `https://developers.google.com/apps-script/reference/groups/group#getUsers()` | `https://developers.google.com/apps-script/base/user.html` | Gets the direct members and banned members of the group that have a known corresponding Google account. |
| `https://developers.google.com/apps-script/reference/groups/group#hasGroup(Group)` | `Boolean` | Tests if a group is a direct member of this group. |
| `https://developers.google.com/apps-script/reference/groups/group#hasGroup(String)` | `Boolean` | Tests if a group is a direct member of this group. |
| `https://developers.google.com/apps-script/reference/groups/group#hasUser(String)` | `Boolean` | Tests if a user is a direct member of the group. |
| `https://developers.google.com/apps-script/reference/groups/group#hasUser(User)` | `Boolean` | Tests if a user is a direct member of the group. |

## `https://developers.google.com/apps-script/reference/groups/groups-app`

### Properties

| Property | Type | Description |
|---|---|---|
| `Role` | `https://developers.google.com/apps-script/reference/groups/role` |   |

### Methods

| Method | Return type | Brief description |
|---|---|---|
| `https://developers.google.com/apps-script/reference/groups/groups-app#getGroupByEmail(String)` | `https://developers.google.com/apps-script/reference/groups/group` | Retrieves the group having the specified email address. |
| `https://developers.google.com/apps-script/reference/groups/groups-app#getGroups()` | `https://developers.google.com/apps-script/reference/groups/group` | Retrieves all the groups of which you are a direct member (or a pending member). |

## `https://developers.google.com/apps-script/reference/groups/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. |
| `BANNED` | `Enum` | A user who has been banned from a group and cannot attempt to join it. |