REST Resource: groups

리소스: 그룹

Google 그룹스를 사용하면 사용자가 그룹의 이메일 주소를 사용하여 사용자 그룹에 메시지를 보낼 수 있습니다. 일반적인 작업에 관한 자세한 내용은 개발자 가이드를 참고하세요.

다른 유형의 그룹에 대한 자세한 내용은 Cloud ID 그룹스 API 문서를 참고하세요.

참고: API를 호출하는 사용자 (또는 서비스 계정으로 명의 도용된 사용자)에게 최고 관리자 또는 그룹 관리자와 같은 관리자 API 그룹 권한이 포함된 할당된 역할이 있어야 합니다.

JSON 표현 
{
  "id": string,
  "email": string,
  "name": string,
  "description": string,
  "adminCreated": boolean,
  "directMembersCount": string,
  "kind": string,
  "etag": string,
  "aliases": [
    string
  ],
  "nonEditableAliases": [
    string
  ]
}
필드
id

string

읽기 전용입니다. 그룹의 고유 ID입니다. 그룹 id는 그룹 요청 URI의 groupKey로 사용할 수 있습니다.
email

string

그룹의 이메일 주소입니다. 계정에 여러 도메인이 있는 경우 이메일 주소에 적절한 도메인을 선택합니다. email은 고유해야 합니다. 이 속성은 그룹을 만들 때 필요합니다. 그룹 이메일 주소에는 사용자 이름과 동일한 문자 사용 규칙이 적용됩니다. 자세한 내용은 고객센터를 참고하세요.
name

string

그룹의 표시 이름입니다.
description

string

사용자가 그룹의 목적을 파악하는 데 도움이 되는 확장된 설명입니다. 예를 들어 그룹에 참여해야 하는 사람, 그룹에 보낼 메시지 유형, 그룹 관련 FAQ 링크, 관련 그룹 등에 대한 정보를 포함할 수 있습니다. 최대 길이는 4,096자(영문 기준)입니다.
adminCreated

boolean

읽기 전용입니다. 이 그룹이 사용자 대신 관리자가 만든 경우 값은 true입니다.
directMembersCount

string (int64 format)

그룹의 직속 회원 수입니다. 그룹이 이 그룹 (상위)의 회원 (하위)인 경우 하위 그룹의 회원은 상위 그룹의 directMembersCount 속성에 포함되지 않습니다.
kind

string

API 리소스의 유형입니다. 그룹 리소스의 경우 값은 admin#directory#group입니다.
etag

string

리소스의 ETag입니다.
aliases[]

string

읽기 전용입니다. 그룹의 별칭 이메일 주소 목록입니다. 그룹의 별칭을 추가, 업데이트 또는 삭제하려면 groups.aliases 메서드를 사용하세요. 그룹의 POST 또는 PUT 요청에서 수정하면 수정사항이 무시됩니다.
nonEditableAliases[]

string

읽기 전용입니다. 계정의 기본 도메인 또는 하위 도메인 외부에 있는 수정할 수 없는 그룹의 별칭 이메일 주소 목록입니다. 그룹에서 사용하는 이메일 주소입니다. 그룹의 API 응답에서 반환되는 읽기 전용 속성입니다. 그룹의 POST 또는 PUT 요청에서 수정하면 수정사항이 무시됩니다.

메서드

delete

 그룹을 삭제합니다.

get

 그룹의 속성을 검색합니다.

insert

 그룹을 만듭니다.

list

 userKey가 주어진 도메인 또는 사용자의 모든 그룹을 검색합니다 (페이징됨).

patch

 그룹의 속성을 업데이트합니다.

update

 그룹의 속성을 업데이트합니다.