Class Group

Grupa

Obiekt grupy, którego członkowie i role tych członków w grupie można wykonywać.

Oto przykład, który przedstawia członków grupy. Zanim uruchomisz grupę, zastąp jej adres e-mail adresem w Twojej domenie.

function listGroupMembers() {
  var group = GroupsApp.getGroupByEmail("[e-mail]");
  console.log(group.getEmail() + ':');
  var users = group.getUsers();
  for (var i = 0; i < users.length; i++) {
    var user = users[i];
    console.log(user.getEmail());
  }
}

Metody

Metoda	Zwracany typ	Krótki opis
getEmail()	String	Pobiera adres e-mail tej grupy.
getGroups()	Group[]	Pobiera bezpośrednie grupy podrzędne grupy.
getRole(email)	Role	Pobiera rolę użytkownika w kontekście grupy.
getRole(user)	Role	Pobiera rolę użytkownika w kontekście grupy.
getRoles(users)	Role[]	Pobiera role użytkowników w kontekście grupy.
getUsers()	User[]	Pobiera bezpośrednich członków grupy, którzy mają znane odpowiednie konto Google.
hasGroup(group)	Boolean	Sprawdza, czy grupa jest jej bezpośrednim członkiem.
hasGroup(email)	Boolean	Sprawdza, czy grupa jest jej bezpośrednim członkiem.
hasUser(email)	Boolean	Sprawdza, czy użytkownik jest bezpośrednim członkiem grupy.
hasUser(user)	Boolean	Sprawdza, czy użytkownik jest bezpośrednim członkiem grupy.

Szczegółowa dokumentacja

getEmail()

Pobiera adres e-mail tej grupy.

W tym przykładzie podano adresy e-mail wszystkich grup, do których należy użytkownik.

function listMyGroupEmails() {
  var groups = GroupsApp.getGroups();
  for (var i = 0; i < groups.length; i++) {
    console.log(groups[i].getEmail());
  }
}

Powroty

String – adres e-mail grupy.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

---

getGroups()

Pobiera bezpośrednie grupy podrzędne grupy. Zgłasza wyjątek, jeśli nie masz uprawnień do wyświetlania listy członków grupy.

Oprócz tej metody do pobierania członków grupy w domenie możesz też użyć zaawansowanej usługi Admin SDK Directory.

function listGroupMembers() {
  var GROUP_EMAIL = "[e-mail]";
  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());
  }
}

Powroty

Group[] – wszystkie bezpośrednie grupy podrzędne w danej grupie.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

---

getRole(email)

Pobiera rolę użytkownika w kontekście grupy. Użytkownik, który jest bezpośrednim członkiem grupy, ma w niej dokładnie jedną rolę. Zgłasza wyjątek, jeśli użytkownik nie jest członkiem grupy lub nie masz uprawnień do wyświetlania listy członków grupy.

Ten przykład zawiera listę właścicieli grupy:

var group = GroupsApp.getGroupByEmail("[e-mail]");
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());
  }
}

Parametry

Nazwa	Typ	Opis
email	String	Adres e-mail użytkownika.

Powroty

Role – rola użytkownika w grupie,

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

---

getRole(user)

Pobiera rolę użytkownika w kontekście grupy. Użytkownik, który jest bezpośrednim członkiem grupy, ma w niej dokładnie jedną rolę. Zgłasza wyjątek, jeśli użytkownik nie jest członkiem grupy lub nie masz uprawnień do wyświetlania listy członków grupy.

Ten przykład zawiera listę właścicieli grupy:

var group = GroupsApp.getGroupByEmail("[e-mail]");
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());
  }
}

Parametry

Nazwa	Typ	Opis
user	User	Użytkownik, którego rolę chcesz pobrać.

Powroty

Role – rola użytkownika w grupie,

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

Zobacz też

• getRole(email)

---

getRoles(users)

Pobiera role użytkowników w kontekście grupy. Użytkownik, który jest bezpośrednim członkiem grupy, ma w niej dokładnie jedną rolę. Zgłasza wyjątek, jeśli żaden użytkownik nie jest członkiem grupy lub nie masz uprawnień do wyświetlania listy członków grupy.

Ten przykład zawiera listę właścicieli grupy:

var group = GroupsApp.getGroupByEmail("[e-mail]");
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());
  }
}

Parametry

Nazwa	Typ	Opis
users	User[]	Użytkownicy, których role są wymagane.

Powroty

Role[] – role użytkowników w grupie.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

---

getUsers()

Pobiera bezpośrednich członków grupy, którzy mają znane odpowiednie konto Google. Zwraca wyjątek, jeśli nie masz uprawnień do wyświetlania listy członków grupy lub adresów e-mail członków.

Uwaga: jeśli jesteś członkiem grupy B, która jest członkiem innej grupy A, to pośrednio subskrybujesz grupę A. Mimo że otrzymujesz kopie wysyłanych do niej wiadomości, nie subskrybujesz grupy nadrzędnej A.

Oto przykład, który przedstawia członków grupy. Zanim uruchomisz grupę, zastąp jej adres e-mail adresem w Twojej domenie.

function listGroupMembers() {
  var GROUP_EMAIL = "[e-mail]";
  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());
  }
}

Oprócz tej metody możesz też użyć zaawansowanej usługi Admin SDK Directory, by pobrać członków grup w domenie.

Powroty

User[] – wszyscy bezpośredni członkowie grupy.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

---

hasGroup(group)

Sprawdza, czy grupa jest jej bezpośrednim członkiem. Metoda nie zwraca wartości true, jeśli testowana grupa jest zagnieżdżona więcej niż 1 poziom poniżej tej grupy. Zgłasza wyjątek, jeśli nie masz uprawnień do wyświetlania listy członków grupy.

var group = GroupsApp.getGroupByEmail("[e-mail]");
var childGroup = GroupsApp.getGroupByEmail("[e-mail]");
if (group.hasGroup(childGroup)) {
  console.log("[e-mail] is a child group");
}

Parametry

Nazwa	Typ	Opis
group	Group	Grupa, której członkostwo ma zostać przetestowane.

Powroty

Boolean – true, jeśli ta grupa jest grupą podrzędną tej grupy; w przeciwnym razie false.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

---

hasGroup(email)

Sprawdza, czy grupa jest jej bezpośrednim członkiem. Metoda nie zwraca wartości true, jeśli testowana grupa jest zagnieżdżona więcej niż 1 poziom poniżej tej grupy. Zgłasza wyjątek, jeśli nie masz uprawnień do wyświetlania listy członków grupy.

var group = GroupsApp.getGroupByEmail("[e-mail]");
if (group.hasGroup("[e-mail]")) {
  console.log("[e-mail] is a child group");
}

Parametry

Nazwa	Typ	Opis
email	String	Adres e-mail grupy.

Powroty

Boolean – true, jeśli ta grupa jest grupą podrzędną tej grupy; w przeciwnym razie false.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

---

hasUser(email)

Sprawdza, czy użytkownik jest bezpośrednim członkiem grupy. Zgłasza wyjątek, jeśli nie masz uprawnień do wyświetlania listy członków grupy.

Oto przykład, który pozwala sprawdzić, czy bieżący użytkownik jest członkiem grupy:

var group = GroupsApp.getGroupByEmail("[e-mail]");
var currentUser = Session.getActiveUser();
if (group.hasUser(currentUser.getEmail())) {
  console.log("You are a member");
}

Parametry

Nazwa	Typ	Opis
email	String	Adres e-mail użytkownika.

Powroty

Boolean – true, jeśli ten użytkownik jest członkiem grupy. W przeciwnym razie false.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

---

hasUser(user)

Sprawdza, czy użytkownik jest bezpośrednim członkiem grupy. Zgłasza wyjątek, jeśli nie masz uprawnień do wyświetlania listy członków grupy.

Oto przykład, który pozwala sprawdzić, czy bieżący użytkownik jest członkiem grupy:

var group = GroupsApp.getGroupByEmail("[e-mail]");
var currentUser = Session.getActiveUser();
if (group.hasUser(currentUser)) {
  console.log("You are a member");
}

Parametry

Nazwa	Typ	Opis
user	User	Użytkownik, którego członkostwo ma zostać przetestowane.

Powroty

Boolean – true, jeśli ten użytkownik jest członkiem grupy. W przeciwnym razie false.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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