Um objeto de grupo cujos membros e as funções desses membros dentro do grupo podem ser consultados.
Este é um exemplo que mostra os membros de um grupo. Antes de executá-lo, substitua o endereço de e-mail do grupo por um de seu domínio.
function listGroupMembers() { var group = GroupsApp.getGroupByEmail("example@googlegroups.com"); console.log(group.getEmail() + ':'); var users = group.getUsers(); for (var i = 0; i < users.length; i++) { var user = users[i]; console.log(user.getEmail()); } }
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
getEmail() | String | Extrai o endereço de e-mail do grupo. |
getGroups() | Group[] | Recupera os grupos filhos diretos do grupo. |
getRole(email) | Role | Recupera a função de um usuário no contexto do grupo. |
getRole(user) | Role | Recupera a função de um usuário no contexto do grupo. |
getRoles(users) | Role[] | Recupera os papéis dos usuários no contexto do grupo. |
getUsers() | User[] | Acessa os membros diretos do grupo que têm uma Conta do Google correspondente conhecida. |
hasGroup(group) | Boolean | Testa se um grupo é um membro direto deste grupo. |
hasGroup(email) | Boolean | Testa se um grupo é um membro direto deste grupo. |
hasUser(email) | Boolean | Testa se um usuário é um membro direto do grupo. |
hasUser(user) | Boolean | Testa se um usuário é um membro direto do grupo. |
Documentação detalhada
getEmail()
Extrai o endereço de e-mail do grupo.
Neste exemplo, listamos o endereço de e-mail de todos os grupos a que o usuário pertence.
function listMyGroupEmails() { var groups = GroupsApp.getGroups(); for (var i = 0; i < groups.length; i++) { console.log(groups[i].getEmail()); } }
Retorno
String
: o endereço de e-mail do grupo.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/groups
getGroups()
Recupera os grupos filhos diretos do grupo. Lança uma exceção se você não tiver permissão para visualizar a lista de membros do grupo.
Além desse método, é possível usar o serviço avançado do Diretório do SDK Admin para recuperar membros de grupo em um domínio.
function listGroupMembers() { var GROUP_EMAIL = "example@googlegroups.com"; var group = GroupsApp.getGroupByEmail(GROUP_EMAIL); var childGroups = group.getGroups(); console.log("Group " + GROUP_EMAIL + " has " + childGroups.length + " groups:"); for (var i = 0; i < childGroups.length; i++) { var childGroup = childGroups[i]; console.log(childGroup.getEmail()); } }
Retorno
Group[]
: todos os grupos filhos diretos do grupo.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/groups
getRole(email)
Recupera a função de um usuário no contexto do grupo. Um usuário que é um membro direto de um grupo tem exatamente um papel nesse grupo. Lança uma exceção se o usuário não for membro do grupo ou se você não tiver permissão para visualizar a lista de membros do grupo.
Este exemplo lista os proprietários de um grupo:
var group = GroupsApp.getGroupByEmail("example@googlegroups.com"); var users = group.getUsers(); console.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) { console.log(user.getEmail()); } }
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
email | String | É o endereço de e-mail do usuário. |
Retorno
Role
: a função desse usuário no grupo.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/groups
getRole(user)
Recupera a função de um usuário no contexto do grupo. Um usuário que é um membro direto de um grupo tem exatamente um papel nesse grupo. Lança uma exceção se o usuário não for membro do grupo ou se você não tiver permissão para visualizar a lista de membros do grupo.
Este exemplo lista os proprietários de um grupo:
var group = GroupsApp.getGroupByEmail("example@googlegroups.com"); var users = group.getUsers(); console.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) { console.log(user.getEmail()); } }
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
user | User | O usuário cujo papel será recuperado. |
Retorno
Role
: a função desse usuário no grupo.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/groups
Veja também
getRoles(users)
Recupera os papéis dos usuários no contexto do grupo. Um usuário que é um membro direto de um grupo tem exatamente um papel nesse grupo. Lança uma exceção se qualquer usuário não for membro do grupo ou se você não tiver permissão para visualizar a lista de membros do grupo.
Este exemplo lista os proprietários de um grupo:
var group = GroupsApp.getGroupByEmail("example@googlegroups.com"); var users = group.getUsers(); var roles = group.getRoles(users); console.log('These are the group owners:'); for (var i = 0; i < users.length; i++) { if (roles[i] == GroupsApp.Role.OWNER) { console.log(users[i].getEmail()); } }
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
users | User[] | Os usuários para quem os papéis são solicitados. |
Retorno
Role[]
: as funções desses usuários no grupo.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/groups
getUsers()
Acessa os membros diretos do grupo que têm uma Conta do Google correspondente conhecida. Lança uma exceção se você não tiver permissão para visualizar a lista de membros do grupo ou os e-mails dos membros.
Observação: se você for membro de um Grupo B, que é membro de outro grupo A, você está inscrito indiretamente nele. Embora receba cópias de mensagens enviadas, você não está inscrito no grupo pai A.
Este é um exemplo que mostra os membros de um grupo. Antes de executá-lo, substitua o endereço de e-mail do grupo por um de seu domínio.
function listGroupMembers() { var GROUP_EMAIL = "example@googlegroups.com"; var group = GroupsApp.getGroupByEmail(GROUP_EMAIL); var users = group.getUsers(); console.log("Group " + GROUP_EMAIL + " has " + users.length + " members:"); for (var i = 0; i < users.length; i++) { var user = users[i]; console.log(user.getEmail()); } }Além desse método, é possível usar o serviço avançado do Diretório do SDK Admin para recuperar membros de grupo em um domínio.
Retorno
User[]
: todos os membros diretos do grupo.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/groups
hasGroup(group)
Testa se um grupo é um membro direto deste grupo. O método não vai retornar true
se
o grupo testado estiver aninhado mais de um nível abaixo desse grupo. Lança uma exceção se você não tiver permissão para visualizar a lista de membros do grupo.
var group = GroupsApp.getGroupByEmail("example@googlegroups.com"); var childGroup = GroupsApp.getGroupByEmail("childgroup@googlegroups.com"); if (group.hasGroup(childGroup)) { console.log("childgroup@googlegroups.com is a child group"); }
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
group | Group | O grupo cuja associação a ser testada. |
Retorno
Boolean
: true
se esse grupo for um grupo filho. Caso contrário, false
.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/groups
hasGroup(email)
Testa se um grupo é um membro direto deste grupo. O método não vai retornar true
se
o grupo testado estiver aninhado mais de um nível abaixo desse grupo. Lança uma exceção se você não tiver permissão para visualizar a lista de membros do grupo.
var group = GroupsApp.getGroupByEmail("example@googlegroups.com"); if (group.hasGroup("childgroup@googlegroups.com")) { console.log("childgroup@googlegroups.com is a child group"); }
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
email | String | O endereço de e-mail do grupo. |
Retorno
Boolean
: true
se esse grupo for um grupo filho. Caso contrário, false
.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/groups
hasUser(email)
Testa se um usuário é um membro direto do grupo. Lança uma exceção se você não tiver permissão para visualizar a lista de membros do grupo.
Confira um exemplo que verifica se o usuário atual é membro de um grupo:
var group = GroupsApp.getGroupByEmail("example@googlegroups.com"); var currentUser = Session.getActiveUser(); if (group.hasUser(currentUser.getEmail())) { console.log("You are a member"); }
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
email | String | É o endereço de e-mail do usuário. |
Retorno
Boolean
: true
se esse usuário for membro do grupo. Caso contrário, false
.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/groups
hasUser(user)
Testa se um usuário é um membro direto do grupo. Lança uma exceção se você não tiver permissão para visualizar a lista de membros do grupo.
Confira um exemplo que verifica se o usuário atual é membro de um grupo:
var group = GroupsApp.getGroupByEmail("example@googlegroups.com"); var currentUser = Session.getActiveUser(); if (group.hasUser(currentUser)) { console.log("You are a member"); }
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
user | User | O usuário cuja assinatura será testada. |
Retorno
Boolean
: true
se esse usuário for membro do grupo. Caso contrário, false
.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/groups