Class Group

Group

Đối tượng nhóm có các thành viên và các thành viên đó vai trò trong nhóm.

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

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

Phương thức

Phương thứcLoại dữ liệu trả vềMô tả ngắn
getEmail()StringLấ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)RoleTruy xuất vai trò của người dùng trong bối cảnh của nhóm.
getRole(user)RoleTruy xuất vai trò của người dùng trong bối cảnh của nhóm.
getRoles(users)Role[]Truy xuất dữ liệu của người dùng vai trò trong bối 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 và đã biết.
hasGroup(group)BooleanKiể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)BooleanKiể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)BooleanKiể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)BooleanKiể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 có người dùng. 

function listMyGroupEmails() {
  var groups = GroupsApp.getGroups();
  for (var 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

Tập lệnh sử dụng phương thức này yêu cầu ủy 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 pháp này, bạn có thể sử dụng dịch vụ nâng cao Thư mục SDK dành cho quản trị viên để truy xuất thành viên nhóm trong miền. 

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

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

Tập lệnh sử dụng phương thức này yêu cầu ủy 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 bối cảnh của nhóm. Người dùng là thành viên trực tiếp của một nhóm 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ụ sau liệt kê các chủ sở hữu của một nhóm: 

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

Tham số

TênLoạiMô tả
emailStringĐị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

Tập lệnh sử dụng phương thức này yêu cầu ủy 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 bối cảnh của nhóm. Người dùng là thành viên trực tiếp của một nhóm 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ụ sau liệt kê các chủ sở hữu của một nhóm: 

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

Tham số

TênLoạiMô tả
userUserNgườ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

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

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

Xem thêm

getRoles(users)

Truy xuất dữ liệu của người dùng vai trò trong bối cảnh của nhóm. Người dùng là thành viên trực tiếp của một nhóm có đúng một vai trò trong nhóm đó. Gửi ngoại lệ nếu có bất kỳ 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ụ sau liệt kê các chủ sở hữu của một nhóm: 

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

Tham số

TênLoạiMô tả
usersUser[]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

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

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

getUsers()

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 và đã biết. Gửi một là 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 các thành viên.

Lưu ý: Nếu bạn là thành viên của một nhóm B và nhóm B cũng là thành viên của một nhóm khác A thì bạn được đăng ký gián tiếp vào nhóm A. Mặc dù bạn nhận được bản sao của thư được gửi tới mà thực ra bạn chưa đăng ký vào nhóm mẹ A.

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

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());
  }
}
 Ngoài phương pháp này, bạn có thể sử dụng dịch vụ nâng cao Thư mục SDK dành cho quản trị viên để truy xuất thành viên nhóm trong 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

Tập lệnh sử dụng phương thức này yêu cầu ủy 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 thử nghiệm được lồng nhiều hơn một cấp bên dưới nhóm này. Gửi một ngoại lệ nếu bạn chọn không có quyền xem danh sách thành viên của nhóm. 

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

Tham số

TênLoạiMô tả
groupGroupNhóm có tư cách thành viên để kiểm tra.

Cầu thủ trả bóng

Boolean — true nếu nhóm đó là một nhóm con của nhóm này; false.

Ủy quyền

Tập lệnh sử dụng phương thức này yêu cầu ủy 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 thử nghiệm được lồng nhiều hơn một cấp bên dưới nhóm này. Gửi một ngoại lệ nếu bạn chọn không có quyền xem danh sách thành viên của nhóm. 

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

Tham số

TênLoạiMô tả
emailStringĐịa chỉ email của một nhóm.

Cầu thủ trả bóng

Boolean — true nếu nhóm đó là một nhóm con của nhóm này; false.

Ủy quyền

Tập lệnh sử dụng phương thức này yêu cầu ủy 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ụ giúp 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: 

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

Tham số

TênLoạiMô tả
emailStringĐị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.

Ủy quyền

Tập lệnh sử dụng phương thức này yêu cầu ủy 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ụ giúp 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: 

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

Tham số

TênLoạiMô tả
userUserNgười dùng có tư cách thành viên để kiểm tra.

Cầu thủ trả bóng

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

Ủy quyền

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

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