Directory API의 groups.list
메서드를 사용하여 특정 속성과 일치하는 그룹을 검색할 수 있습니다. 이 메서드는 하나 이상의 검색 절을 결합한 검색어인 query
매개변수를 허용합니다. 각 검색 절은 다음 세 부분으로 구성됩니다.
- 필드
- 검색되는 그룹 속성입니다. 예를 들면 다음과 같습니다.
name
- 운영자
- 일치를 제공하기 위해 데이터에 수행되는 테스트입니다. 예를 들어
=
연산자는 텍스트 속성이 값과 일치하는지 테스트합니다. - 값
- 테스트되는 속성의 내용입니다. 예를 들면 다음과 같습니다.
groupName
여러 절은 공백으로 구분되며 AND
연산자에 의해 암시적으로 조인됩니다.
입력란
필드 | 값 유형 | 연산자 | 설명 |
---|---|---|---|
email |
문자열 | = , :{PREFIX}* |
그룹의 이메일 주소입니다. 참고: 동일한 쿼리에서 memberKey 매개변수와 함께 사용할 수 없습니다. |
name |
문자열 | = , :{PREFIX}* |
그룹의 표시 이름입니다. 참고: 동일한 쿼리에서 memberKey 매개변수와 함께 사용할 수 없습니다. |
memberKey |
문자열 | = , |
memberKey 쿼리 매개변수는 사용자 또는 그룹이 멤버십을 보유한 모든 그룹을 반환합니다. 이 값은 사용자의 기본 또는 별칭 이메일 주소, 그룹의 기본 또는 별칭 이메일 주소, 사용자의 고유 ID 중 하나일 수 있습니다. 참고: 동일한 쿼리에서 email 또는 name 매개변수와 함께 사용할 수 없습니다. |
값 유형
값 유형 | Notes |
---|---|
문자열 | 쿼리에 공백이 포함된 경우 ' 작은따옴표로 묶습니다. \' 를 사용하여 쿼리에서 작은따옴표를 이스케이프 처리합니다(예: 'Valentine\'s Day' ). |
연산자
운영자 | 지원되는 값 유형 | Notes |
---|---|---|
= |
string, boolean, number, date | 필드와 값이 정확히 일치합니다. 예를 들어 name=contact 는 name 속성이 "contact" 인 모든 그룹과 일치하지만 "contactgroup" 과는 일치하지 않습니다. 대부분의 문자열 필드에서 지원됩니다 (위 참조). |
:{PREFIX}* |
문자열 | 이 필드는 값으로 시작합니다. 예를 들어 email:support* 가 있는 쿼리는 email 값이 "supportgroup@" 이고 "support@" 이 있는 그룹과 일치하지만 "contactsupport" 가 있는 그룹과는 일치하지 않습니다. 제한된 문자열 필드 집합에서만 지원됩니다 (위 참조). |
예
모든 쿼리는 다음과 유사한 HTTP 요청이 있는 groups.list
메서드를 사용합니다 (가독성을 위해 줄바꿈 포함됨).
GET https://admin.googleapis.com/admin/directory/v1/groups ?domain=primary domain &query=query parameters
query
매개변수는 URL로 인코딩되어야 합니다. 예를 들어 query=email:support*
쿼리는 query=email%3Asupport*
로 URL 인코딩됩니다.
이 페이지의 모든 예시에는 인코딩되지 않은 query
매개변수가 표시됩니다.
클라이언트 라이브러리는 이 URL 인코딩을 자동으로 처리합니다.
표시 이름으로 그룹 검색
name='contact'
이메일 프리픽스와 일치하는 그룹 검색
email:admin*
모든 사용자 그룹 검색
memberKey=user@company.com
이름으로 시작하는 이름과 이메일 주소로 그룹을 검색합니다.
name:contact* email:contact*