Class Group

Grupa

Obiekt grupy, którego członkowie i ich role w grupie mogą być przedmiotem zapytań.

Oto przykład, który pokazuje członków grupy. Zanim go uruchomisz, zastąp adres e-mail grupy adresem e-mail z Twojej domeny.

function listGroupMembers() {
  const group = GroupsApp.getGroupByEmail('[e-mail]');
  console.log(`${group.getEmail()}:`);
  const users = group.getUsers();
  for (let i = 0; i < users.length; i++) {
    const 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 odpowiadające konto Google.
hasGroup(group)	Boolean	Sprawdza, czy grupa jest bezpośrednio powiązana z tą grupą.
hasGroup(email)	Boolean	Sprawdza, czy grupa jest bezpośrednio powiązana z tą grupą.
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 podany jest adres e-mail wszystkich grup, do których należy użytkownik.

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

Powrót

String – adres e-mail grupy.

Autoryzacja

Skrypty, które korzystają 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. Wyjątek jest zgłaszany, jeśli nie masz uprawnień do wyświetlania listy członków grupy.

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

function listGroupMembers() {
  const GROUP_EMAIL = '[e-mail]';
  const group = GroupsApp.getGroupByEmail(GROUP_EMAIL);
  const childGroups = group.getGroups();
  console.log(`Group ${GROUP_EMAIL} has ${childGroups.length} groups:`);
  for (let i = 0; i < childGroups.length; i++) {
    const childGroup = childGroups[i];
    console.log(childGroup.getEmail());
  }
}

Powrót

Group[] – wszystkie grupy podrzędne grupy.

Autoryzacja

Skrypty, które korzystają 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ę. Wyjątek jest rzucany, jeśli użytkownik nie jest członkiem grupy lub jeśli nie masz uprawnień do wyświetlania listy członków grupy.

W tym przykładzie podano właścicieli grupy:

const group = GroupsApp.getGroupByEmail('[e-mail]');
const users = group.getUsers();
console.log('These are the group owners:');
for (let i = 0; i < users.length; i++) {
  const 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.

Powrót

Role – rola użytkownika w grupie.

Autoryzacja

Skrypty, które korzystają 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ę. Wyjątek jest rzucany, jeśli użytkownik nie jest członkiem grupy lub jeśli nie masz uprawnień do wyświetlania listy członków grupy.

W tym przykładzie podano właścicieli grupy:

const group = GroupsApp.getGroupByEmail('[e-mail]');
const users = group.getUsers();
console.log('These are the group owners:');
for (let i = 0; i < users.length; i++) {
  const 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ć.

Powrót

Role – rola użytkownika w grupie.

Autoryzacja

Skrypty, które korzystają 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ę. Wyjątek jest rzucany, jeśli któryś z użytkowników nie jest członkiem grupy lub jeśli nie masz uprawnień do wyświetlania listy członków grupy.

W tym przykładzie podano właścicieli grupy:

const group = GroupsApp.getGroupByEmail('[e-mail]');
const users = group.getUsers();
const roles = group.getRoles(users);
console.log('These are the group owners:');
for (let 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.

Powrót

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

Autoryzacja

Skrypty, które korzystają 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 i wykluczonych członków grupy, którzy mają znane odpowiadające im konto Google. Wyjątek jest zgłaszany, jeśli nie masz uprawnień do wyświetlania listy członków grupy lub ich adresów e-mail.

Uwaga: jeśli jesteś członkiem grupy B, która jest członkiem innej grupy A, to masz pośrednio subskrypcję grupy A. Członkowie grupy podrzędnej otrzymują kopie wiadomości wysłanych do tej grupy, ale nie są subskrybentami grupy nadrzędnej A.

Oto przykład, który pokazuje członków grupy. Zanim go uruchomisz, zastąp adres e-mail grupy adresem e-mail z Twojej domeny.

function listGroupMembers() {
  const GROUP_EMAIL = '[e-mail]';
  const group = GroupsApp.getGroupByEmail(GROUP_EMAIL);
  const users = group.getUsers();
  console.log(`Group ${GROUP_EMAIL} has ${users.length} members:`);
  for (let i = 0; i < users.length; i++) {
    const user = users[i];
    console.log(user.getEmail());
  }
}

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

Powrót

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

Autoryzacja

Skrypty, które korzystają 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 bezpośrednio powiązana z tą grupą. Metoda nie zwraca wartości true, jeśli testowana grupa jest zagnieżdżona na więcej niż 1 poziomie poniżej tej grupy. Wyjątek jest zgłaszany, jeśli nie masz uprawnień do wyświetlania listy członków grupy.

const group = GroupsApp.getGroupByEmail('[e-mail]');
const 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 być testowane.

Powrót

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

Autoryzacja

Skrypty, które korzystają 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 bezpośrednio powiązana z tą grupą. Metoda nie zwraca wartości true, jeśli testowana grupa jest zagnieżdżona na więcej niż 1 poziomie poniżej tej grupy. Wyjątek jest zgłaszany, jeśli nie masz uprawnień do wyświetlania listy członków grupy.

const 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.

Powrót

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

Autoryzacja

Skrypty, które korzystają 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. Wyjątek jest zgłaszany, jeśli nie masz uprawnień do wyświetlania listy członków grupy.

Oto przykład sprawdzania, czy bieżący użytkownik jest członkiem grupy:

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

Powrót

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

Autoryzacja

Skrypty, które korzystają 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. Wyjątek jest zgłaszany, jeśli nie masz uprawnień do wyświetlania listy członków grupy.

Oto przykład sprawdzania, czy bieżący użytkownik jest członkiem grupy:

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

Parametry

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

Powrót

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

Autoryzacja

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

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