Bạn có thể truy vấn một đối tượng nhóm có 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() { 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ức | Kiểu 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[] | Chọn 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 là thành viên.
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 cần đượ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 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 cần đượ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. Người dùng là thành viên trực tiếp của 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ụ 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()); } }
Các tham số
Tên | Loại | Nội dung 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
Tập lệnh sử dụng phương thức này cần đượ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. Người dùng là thành viên trực tiếp của 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ụ 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()); } }
Các tham số
Tên | Loại | Nội dung 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
Tập lệnh sử dụng phương thức này cần đượ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
getRoles(users)
Truy xuất vai trò của người dùng trong ngữ cảnh của nhóm. Người dùng là thành viên trực tiếp của nhóm chỉ 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()); } }
Các tham số
Tên | Loại | Nội dung mô tả |
---|---|---|
users | User[] | 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 cần được uỷ quyền với một hoặc nhiều phạm vi sau:
-
https://www.googleapis.com/auth/groups
getUsers()
Chọn 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. 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 thành viên.
Lưu ý: nếu là thành viên của nhóm B và chính là thành viên của một nhóm A khác, thì bạn sẽ gián tiếp đăng ký vào nhóm A. Mặc dù bạn nhận được bản sao của các tin nhắn gửi đến nhóm đó, nhưng thực ra bạn chưa đăng ký vào 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() { 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 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 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 cần đượ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 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 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"); }
Các tham số
Tên | Loại | Nội dung mô tả |
---|---|---|
group | Group | Nhóm có tư cách thành viên để thử nghiệm. |
Cầu thủ trả bóng
Boolean
– true
nếu nhóm đó là nhóm con của nhóm này; nếu không thì false
.
Ủy quyền
Tập lệnh sử dụng phương thức này cần đượ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 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 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"); }
Các tham số
Tên | Loại | Nội dung mô tả |
---|---|---|
email | String | Địa chỉ email của một nhóm. |
Cầu thủ trả bóng
Boolean
– true
nếu nhóm đó là nhóm con của nhóm này; nếu không thì false
.
Ủy quyền
Tập lệnh sử dụng phương thức này cần đượ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.
Dưới đây là ví dụ 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"); }
Các tham số
Tên | Loại | Nội dung 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; nếu không thì là false
.
Ủy quyền
Tập lệnh sử dụng phương thức này cần đượ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.
Dưới đây là ví dụ 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"); }
Các tham số
Tên | Loại | Nội dung mô tả |
---|---|---|
user | User | Người dùng có tư cách thành viên để thử nghiệm. |
Cầu thủ trả bóng
Boolean
– true
nếu người dùng đó là thành viên của nhóm; nếu không thì là false
.
Ủy quyền
Tập lệnh sử dụng phương thức này cần được uỷ quyền với một hoặc nhiều phạm vi sau:
-
https://www.googleapis.com/auth/groups