Class Group

Grupa

Obiekt grupy, którego członków i ich role w grupie można wyszukiwać.

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

function listGroupMembers() {
  const group = GroupsApp.getGroupByEmail('example@googlegroups.com');
  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

MetodaZwracany typKrótki opis
getEmail()StringPobiera adres e-mail tej grupy.
getGroups()Group[]Pobiera bezpośrednie grupy podrzędne grupy.
getRole(email)RolePobiera rolę użytkownika w kontekście grupy.
getRole(user)RolePobiera rolę użytkownika w kontekście grupy.
getRoles(users)Role[]Pobiera role użytkowników w kontekście grupy.
getUsers()User[]Pobiera bezpośrednich i zablokowanych członków grupy, którzy mają znane powiązane konto Google.
hasGroup(group)BooleanSprawdza, czy grupa jest bezpośrednim członkiem tej grupy.
hasGroup(email)BooleanSprawdza, czy grupa jest bezpośrednim członkiem tej grupy.
hasUser(email)BooleanSprawdza, czy użytkownik jest bezpośrednim członkiem grupy.
hasUser(user)BooleanSprawdza, 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() {
  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 korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego 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 możesz użyć usługi zaawansowanej Admin SDK Directory, aby pobrać członków grupy w domenie. 

function listGroupMembers() {
  const GROUP_EMAIL = 'example@googlegroups.com';
  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 bezpośrednie grupy podrzędne grupy.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego 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 tej grupie dokładnie 1 rolę. Zgłasza wyjątek, jeśli użytkownik nie jest członkiem grupy lub jeśli nie masz uprawnień do wyświetlania listy członków grupy.

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

const group = GroupsApp.getGroupByEmail('example@googlegroups.com');
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

NazwaTypOpis
emailStringAdres e-mail użytkownika.

Powrót

Role – rola użytkownika w grupie.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego 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 tej grupie dokładnie 1 rolę. Zgłasza wyjątek, jeśli użytkownik nie jest członkiem grupy lub jeśli nie masz uprawnień do wyświetlania listy członków grupy.

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

const group = GroupsApp.getGroupByEmail('example@googlegroups.com');
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

NazwaTypOpis
userUserUżytkownik, którego rolę chcesz pobrać.

Powrót

Role – rola użytkownika w grupie.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

Zobacz też

getRoles(users)

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

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

const group = GroupsApp.getGroupByEmail('example@googlegroups.com');
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

NazwaTypOpis
usersUser[]Użytkownicy, których role są wymagane.

Powrót

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

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

getUsers()

Pobiera bezpośrednich i zablokowanych członków grupy, którzy mają znane powiązane 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 sama jest członkiem innej grupy A, to jesteś pośrednio subskrybentem grupy A. Chociaż otrzymujesz kopie wiadomości wysłanych na ten adres, nie subskrybujesz grupy nadrzędnej A.

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

function listGroupMembers() {
  const GROUP_EMAIL = 'example@googlegroups.com';
  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 użyć usługi zaawansowanej Directory w pakiecie Admin SDK, aby pobrać członków grupy w domenie.

Powrót

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

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

hasGroup(group)

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

const group = GroupsApp.getGroupByEmail('example@googlegroups.com');
const childGroup = GroupsApp.getGroupByEmail('childgroup@googlegroups.com');
if (group.hasGroup(childGroup)) {
  console.log('childgroup@googlegroups.com is a child group');
}

Parametry

NazwaTypOpis
groupGroupGrupa, której członkostwo ma zostać przetestowane.

Powrót

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

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

hasGroup(email)

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

const group = GroupsApp.getGroupByEmail('example@googlegroups.com');
if (group.hasGroup('childgroup@googlegroups.com')) {
  console.log('childgroup@googlegroups.com is a child group');
}

Parametry

NazwaTypOpis
emailStringadres e-mail grupy;

Powrót

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

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego 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 sprawdzania, czy bieżący użytkownik jest członkiem grupy: 

const group = GroupsApp.getGroupByEmail('example@googlegroups.com');
const currentUser = Session.getActiveUser();
if (group.hasUser(currentUser.getEmail())) {
  console.log('You are a member');
}

Parametry

NazwaTypOpis
emailStringAdres e-mail użytkownika.

Powrót

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

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego 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 sprawdzania, czy bieżący użytkownik jest członkiem grupy: 

const group = GroupsApp.getGroupByEmail('example@googlegroups.com');
const currentUser = Session.getActiveUser();
if (group.hasUser(currentUser)) {
  console.log('You are a member');
}

Parametry

NazwaTypOpis
userUserUżytkownik, którego subskrypcję chcesz przetestować.

Powrót

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

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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