그룹 내에서 구성원과 해당 구성원의 역할을 쿼리할 수 있는 그룹 객체입니다.
다음은 그룹의 구성원을 보여주는 예입니다. 실행하기 전에 그룹의 이메일 주소를 도메인의 이메일 주소로 바꿉니다.
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()); } }
방법
메서드 | 반환 유형 | 간략한 설명 |
---|---|---|
getEmail() | String | 그룹의 이메일 주소를 가져옵니다. |
getGroups() | Group[] | 그룹의 직접 하위 그룹을 검색합니다. |
getRole(email) | Role | 그룹의 컨텍스트에서 사용자의 역할을 검색합니다. |
getRole(user) | Role | 그룹의 컨텍스트에서 사용자의 역할을 검색합니다. |
getRoles(users) | Role[] | 그룹의 컨텍스트에서 사용자 역할을 검색합니다. |
getUsers() | User[] | 알려진 해당 Google 계정이 있는 그룹의 직속 회원을 가져옵니다. |
hasGroup(group) | Boolean | 그룹이 이 그룹의 직속 구성원인지 테스트합니다. |
hasGroup(email) | Boolean | 그룹이 이 그룹의 직속 구성원인지 테스트합니다. |
hasUser(email) | Boolean | 사용자가 그룹의 직속 구성원인지 테스트합니다. |
hasUser(user) | Boolean | 사용자가 그룹의 직속 구성원인지 테스트합니다. |
자세한 문서
getEmail()
그룹의 이메일 주소를 가져옵니다.
이 예시는 사용자가 속한 모든 그룹의 이메일 주소를 나열합니다.
function listMyGroupEmails() { var groups = GroupsApp.getGroups(); for (var i = 0; i < groups.length; i++) { console.log(groups[i].getEmail()); } }
리턴
String
- 그룹의 이메일 주소입니다.
승인
이 방법을 사용하는 스크립트는 다음 범위 중 하나 이상을 승인해야 합니다.
-
https://www.googleapis.com/auth/groups
getGroups()
그룹의 직접 하위 그룹을 검색합니다. 그룹의 구성원 목록을 볼 권한이 없으면 예외가 발생합니다.
이 방법 외에도 Admin SDK 디렉터리 고급 서비스를 사용하여 도메인의 그룹 구성원을 검색할 수 있습니다.
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()); } }
리턴
Group[]
- 그룹의 모든 직접 하위 그룹입니다.
승인
이 방법을 사용하는 스크립트는 다음 범위 중 하나 이상을 승인해야 합니다.
-
https://www.googleapis.com/auth/groups
getRole(email)
그룹의 컨텍스트에서 사용자의 역할을 검색합니다. 그룹의 직속 구성원인 사용자는 해당 그룹 내에서 정확히 하나의 역할을 갖습니다. 사용자가 그룹의 구성원이 아니거나 그룹의 구성원 목록을 볼 권한이 없는 경우 예외가 발생합니다.
다음 예에서는 그룹 소유자를 나열합니다.
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()); } }
매개변수
이름 | 유형 | 설명 |
---|---|---|
email | String | 사용자의 이메일 주소입니다. |
리턴
Role
: 그룹 내 사용자의 역할입니다.
승인
이 방법을 사용하는 스크립트는 다음 범위 중 하나 이상을 승인해야 합니다.
-
https://www.googleapis.com/auth/groups
getRole(user)
그룹의 컨텍스트에서 사용자의 역할을 검색합니다. 그룹의 직속 구성원인 사용자는 해당 그룹 내에서 정확히 하나의 역할을 갖습니다. 사용자가 그룹의 구성원이 아니거나 그룹의 구성원 목록을 볼 권한이 없는 경우 예외가 발생합니다.
다음 예에서는 그룹 소유자를 나열합니다.
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()); } }
매개변수
이름 | 유형 | 설명 |
---|---|---|
user | User | 역할을 검색할 사용자입니다. |
리턴
Role
: 그룹 내 사용자의 역할입니다.
승인
이 방법을 사용하는 스크립트는 다음 범위 중 하나 이상을 승인해야 합니다.
-
https://www.googleapis.com/auth/groups
참고 항목
getRoles(users)
그룹의 컨텍스트에서 사용자 역할을 검색합니다. 그룹의 직속 구성원인 사용자는 해당 그룹 내에서 정확히 하나의 역할을 갖습니다. 그룹의 구성원이 아니거나 그룹의 구성원 목록을 볼 권한이 없는 사용자가 있으면 예외가 발생합니다.
다음 예에서는 그룹 소유자를 나열합니다.
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()); } }
매개변수
이름 | 유형 | 설명 |
---|---|---|
users | User[] | 역할이 요청된 사용자입니다. |
리턴
Role[]
- 그룹 내 해당 사용자의 역할
승인
이 방법을 사용하는 스크립트는 다음 범위 중 하나 이상을 승인해야 합니다.
-
https://www.googleapis.com/auth/groups
getUsers()
알려진 해당 Google 계정이 있는 그룹의 직속 회원을 가져옵니다. 그룹의 구성원 목록 또는 구성원 이메일을 볼 권한이 없는 경우 예외가 발생합니다.
참고: 그 자체가 다른 그룹 A의 구성원인 그룹 B의 구성원인 경우 그룹 A에 간접적으로 가입된 것입니다. 자신에게 전송된 메시지의 사본을 수신하더라도 실제로 상위 그룹 A를 구독하고 있는 것은 아닙니다.
다음은 그룹의 구성원을 보여주는 예입니다. 실행하기 전에 그룹의 이메일 주소를 도메인의 이메일 주소로 바꿉니다.
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()); } }이 방법 외에도 Admin SDK 디렉터리 고급 서비스를 사용하여 도메인의 그룹 구성원을 검색할 수 있습니다.
리턴
User[]
: 그룹의 모든 직속 회원입니다.
승인
이 방법을 사용하는 스크립트는 다음 범위 중 하나 이상을 승인해야 합니다.
-
https://www.googleapis.com/auth/groups
hasGroup(group)
그룹이 이 그룹의 직속 구성원인지 테스트합니다. 테스트된 그룹이 이 그룹보다 한 수준 이상 중첩된 경우 이 메서드는 true
를 반환하지 않습니다. 그룹의 구성원 목록을 볼 권한이 없으면 예외가 발생합니다.
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"); }
매개변수
이름 | 유형 | 설명 |
---|---|---|
group | Group | 멤버십을 테스트할 그룹입니다. |
리턴
Boolean
- 해당 그룹이 이 그룹의 하위 그룹이면 true
, 그렇지 않으면 false
입니다.
승인
이 방법을 사용하는 스크립트는 다음 범위 중 하나 이상을 승인해야 합니다.
-
https://www.googleapis.com/auth/groups
hasGroup(email)
그룹이 이 그룹의 직속 구성원인지 테스트합니다. 테스트된 그룹이 이 그룹보다 한 수준 이상 중첩된 경우 이 메서드는 true
를 반환하지 않습니다. 그룹의 구성원 목록을 볼 권한이 없으면 예외가 발생합니다.
var group = GroupsApp.getGroupByEmail("example@googlegroups.com"); if (group.hasGroup("childgroup@googlegroups.com")) { console.log("childgroup@googlegroups.com is a child group"); }
매개변수
이름 | 유형 | 설명 |
---|---|---|
email | String | 그룹의 이메일 주소입니다. |
리턴
Boolean
- 해당 그룹이 이 그룹의 하위 그룹이면 true
, 그렇지 않으면 false
입니다.
승인
이 방법을 사용하는 스크립트는 다음 범위 중 하나 이상을 승인해야 합니다.
-
https://www.googleapis.com/auth/groups
hasUser(email)
사용자가 그룹의 직속 구성원인지 테스트합니다. 그룹의 구성원 목록을 볼 권한이 없으면 예외가 발생합니다.
다음은 현재 사용자가 그룹의 회원인지 확인하는 예입니다.
var group = GroupsApp.getGroupByEmail("example@googlegroups.com"); var currentUser = Session.getActiveUser(); if (group.hasUser(currentUser.getEmail())) { console.log("You are a member"); }
매개변수
이름 | 유형 | 설명 |
---|---|---|
email | String | 사용자의 이메일 주소입니다. |
리턴
Boolean
- 사용자가 그룹의 회원이면 true
, 그렇지 않으면 false
입니다.
승인
이 방법을 사용하는 스크립트는 다음 범위 중 하나 이상을 승인해야 합니다.
-
https://www.googleapis.com/auth/groups
hasUser(user)
사용자가 그룹의 직속 구성원인지 테스트합니다. 그룹의 구성원 목록을 볼 권한이 없으면 예외가 발생합니다.
다음은 현재 사용자가 그룹의 회원인지 확인하는 예입니다.
var group = GroupsApp.getGroupByEmail("example@googlegroups.com"); var currentUser = Session.getActiveUser(); if (group.hasUser(currentUser)) { console.log("You are a member"); }
매개변수
이름 | 유형 | 설명 |
---|---|---|
user | User | 멤버십을 테스트할 사용자입니다. |
리턴
Boolean
- 사용자가 그룹의 회원이면 true
, 그렇지 않으면 false
입니다.
승인
이 방법을 사용하는 스크립트는 다음 범위 중 하나 이상을 승인해야 합니다.
-
https://www.googleapis.com/auth/groups