Class Group

Group

Một đối tượng nhóm có thể truy vấn các thành viên và vai trò của các thành viên đó trong nhóm.

Dưới đây là ví dụ cho thấy các thành viên của một nhóm. Trước khi chạy, hãy thay thế địa chỉ email của nhóm bằng địa chỉ email của một nhóm trên miền của bạn.

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());
  }
}

Phương thức

Phương thức	Loại dữ liệu trả về	Mô tả ngắn
getEmail()	String	Lấy địa chỉ email của nhóm này.
getGroups()	Group[]	Truy xuất các nhóm con trực tiếp của nhóm.
getRole(email)	Role	Truy xuất vai trò của người dùng trong ngữ cảnh của nhóm.
getRole(user)	Role	Truy xuất vai trò của người dùng trong ngữ cảnh của nhóm.
getRoles(users)	Role[]	Truy xuất vai trò của người dùng trong ngữ cảnh của nhóm.
getUsers()	User[]	Lấy các thành viên trực tiếp của nhóm có Tài khoản Google tương ứng đã biết.
hasGroup(group)	Boolean	Kiểm tra xem một nhóm có phải là thành viên trực tiếp của nhóm này hay không.
hasGroup(email)	Boolean	Kiểm tra xem một nhóm có phải là thành viên trực tiếp của nhóm này hay không.
hasUser(email)	Boolean	Kiểm tra xem người dùng có phải là thành viên trực tiếp của nhóm hay không.
hasUser(user)	Boolean	Kiểm tra xem người dùng có phải là thành viên trực tiếp của nhóm hay không.

Tài liệu chi tiết

getEmail()

Lấy địa chỉ email của nhóm này.

Ví dụ này liệt kê địa chỉ email của tất cả các nhóm mà người dùng thuộc về.

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

Cầu thủ trả bóng

String – Địa chỉ email của nhóm.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

---

getGroups()

Truy xuất các nhóm con trực tiếp của nhóm. Gửi một ngoại lệ nếu bạn không có quyền xem danh sách thành viên của nhóm.

Ngoài phương thức này, bạn có thể sử dụng dịch vụ nâng cao Thư mục SDK quản trị để truy xuất thành viên nhóm trong một miền.

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());
  }
}

Cầu thủ trả bóng

Group[] – Tất cả các nhóm con trực tiếp của nhóm.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

---

getRole(email)

Truy xuất vai trò của người dùng trong ngữ cảnh của nhóm. Một người dùng là thành viên trực tiếp của một nhóm sẽ có đúng một vai trò trong nhóm đó. Gửi một ngoại lệ nếu người dùng không phải là thành viên của nhóm hoặc nếu bạn không có quyền xem danh sách thành viên của nhóm.

Ví dụ này liệt kê các chủ sở hữu của một nhóm:

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());
  }
}

Tham số

Tên	Loại	Mô tả
email	String	Địa chỉ email của người dùng.

Cầu thủ trả bóng

Role – Vai trò của người dùng đó trong nhóm.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

---

getRole(user)

Truy xuất vai trò của người dùng trong ngữ cảnh của nhóm. Một người dùng là thành viên trực tiếp của một nhóm chỉ có đúng một vai trò trong nhóm đó. Gửi một ngoại lệ nếu người dùng không phải là thành viên của nhóm hoặc nếu bạn không có quyền xem danh sách thành viên của nhóm.

Ví dụ này liệt kê các chủ sở hữu của một nhóm:

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());
  }
}

Tham số

Tên	Loại	Mô tả
user	User	Người dùng có vai trò cần truy xuất.

Cầu thủ trả bóng

Role – Vai trò của người dùng đó trong nhóm.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

Xem thêm

• getRole(email)

---

getRoles(users)

Truy xuất vai trò của người dùng trong ngữ cảnh của nhóm. Một người dùng là thành viên trực tiếp của một nhóm sẽ có đúng một vai trò trong nhóm đó. Gửi một ngoại lệ nếu có người dùng nào không phải là thành viên của nhóm hoặc nếu bạn không có quyền xem danh sách thành viên của nhóm.

Ví dụ này liệt kê chủ sở hữu của một nhóm:

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());
  }
}

Tham số

Tên	Loại	Mô tả
users	User[]	Những người dùng có vai trò được yêu cầu.

Cầu thủ trả bóng

Role[] – Vai trò của những người dùng đó trong nhóm.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

---

getUsers()

Lấy thành viên trực tiếp và thành viên bị cấm của nhóm có Tài khoản Google tương ứng đã biết. Gửi một ngoại lệ nếu bạn không có quyền xem danh sách thành viên của nhóm hoặc email của thành viên.

Lưu ý: nếu bạn là thành viên của nhóm B và nhóm B là thành viên của một nhóm A khác, thì bạn đang gián tiếp đăng ký theo dõi nhóm A. Mặc dù bạn nhận được bản sao của các thư gửi đến nhóm con, nhưng bạn thực sự không đăng ký theo dõi nhóm mẹ A.

Dưới đây là ví dụ cho thấy các thành viên của một nhóm. Trước khi chạy, hãy thay thế địa chỉ email của nhóm bằng địa chỉ email của một nhóm trên miền của bạn.

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());
  }
}

Ngoài phương thức này, bạn có thể sử dụng dịch vụ nâng cao Thư mục SDK quản trị để truy xuất thành viên nhóm trong một miền.

Cầu thủ trả bóng

User[] – Tất cả thành viên trực tiếp của nhóm.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

---

hasGroup(group)

Kiểm tra xem một nhóm có phải là thành viên trực tiếp của nhóm này hay không. Phương thức này không trả về true nếu nhóm được kiểm thử được lồng nhiều cấp bên dưới nhóm này. Gửi một ngoại lệ nếu bạn không có quyền xem danh sách thành viên của nhóm.

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

Tham số

Tên	Loại	Mô tả
group	Group	Nhóm có tư cách thành viên cần kiểm thử.

Cầu thủ trả bóng

Boolean – true nếu nhóm đó là nhóm con của nhóm này; false nếu không.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

---

hasGroup(email)

Kiểm tra xem một nhóm có phải là thành viên trực tiếp của nhóm này hay không. Phương thức này không trả về true nếu nhóm được kiểm thử được lồng nhiều cấp bên dưới nhóm này. Gửi một ngoại lệ nếu bạn không có quyền xem danh sách thành viên của nhóm.

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

Tham số

Tên	Loại	Mô tả
email	String	Địa chỉ email của nhóm.

Cầu thủ trả bóng

Boolean – true nếu nhóm đó là nhóm con của nhóm này; false nếu không.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

---

hasUser(email)

Kiểm tra xem người dùng có phải là thành viên trực tiếp của nhóm hay không. Gửi một ngoại lệ nếu bạn không có quyền xem danh sách thành viên của nhóm.

Sau đây là ví dụ về cách kiểm tra xem người dùng hiện tại có phải là thành viên của một nhóm hay không:

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

Tham số

Tên	Loại	Mô tả
email	String	Địa chỉ email của người dùng.

Cầu thủ trả bóng

Boolean – true nếu người dùng đó là thành viên của nhóm; false nếu không.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

---

hasUser(user)

Kiểm tra xem người dùng có phải là thành viên trực tiếp của nhóm hay không. Gửi một ngoại lệ nếu bạn không có quyền xem danh sách thành viên của nhóm.

Sau đây là ví dụ về cách kiểm tra xem người dùng hiện tại có phải là thành viên của một nhóm hay không:

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

Tham số

Tên	Loại	Mô tả
user	User	Người dùng có gói thành viên cần kiểm thử.

Cầu thủ trả bóng

Boolean – true nếu người dùng đó là thành viên của nhóm; false nếu không.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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