REST Resource: contactGroups

리소스: ContactGroup

연락처 그룹

JSON 표현
{
  "resourceName": string,
  "etag": string,
  "metadata": {
    object (ContactGroupMetadata)
  },
  "groupType": enum (GroupType),
  "name": string,
  "formattedName": string,
  "memberResourceNames": [
    string
  ],
  "memberCount": integer,
  "clientData": [
    {
      object (GroupClientData)
    }
  ]
}
필드
resourceName

string

연락처 그룹의 리소스 이름으로, 서버에서 할당합니다. ASCII 문자열로, contactGroups/{contactGroupId} 형식입니다.

etag

string

리소스의 HTTP 항목 태그입니다. 웹 캐시 검증에 사용됩니다.

metadata

object (ContactGroupMetadata)

출력 전용. 연락처 그룹에 관한 메타데이터입니다.

groupType

enum (GroupType)

출력 전용. 연락처 그룹 유형입니다.

name

string

그룹 소유자가 설정한 연락처 그룹 이름 또는 시스템 그룹의 시스템 이름

contactGroups.create 또는 contactGroups.update의 경우 사용자 연락처 그룹에서 고유해야 합니다. 중복 이름으로 그룹을 만들려고 하면 HTTP 409 오류가 반환됩니다.

formattedName

string

출력 전용. 뷰어의 계정 언어 또는 시스템 그룹 이름의 Accept-Language HTTP 헤더 언어로 번역되고 형식이 지정된 이름입니다. 소유자가 설정한 그룹 이름이 이름과 동일합니다.

memberResourceNames[]

string

출력 전용. 연락처 그룹의 구성원인 담당자 리소스 이름의 목록입니다. 이 필드는 GET 요청에만 채워지며 get 요청의 maxMembers와 같은 구성원만 반환합니다.

memberCount

integer

출력 전용. 요청에 지정된 최대 회원 수와 관계없이 그룹의 총 연락처 수입니다.

clientData[]

object (GroupClientData)

그룹의 클라이언트 데이터입니다.

연락처 그룹 메타데이터

연락처 그룹에 대한 메타데이터입니다.

JSON 표현
{
  "updateTime": string,
  "deleted": boolean
}
필드
updateTime

string (Timestamp format)

출력 전용. 그룹이 마지막으로 업데이트된 시간입니다.

RFC3339 UTC 'Zulu' 형식의 타임스탬프(나노초 해상도 및 최대 9자리 소수) 예: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z".

deleted

boolean

출력 전용. 연락처 그룹 리소스가 삭제된 경우 true입니다. 동기화 토큰이 포함된 contactGroups.list 요청에만 채워집니다.

그룹 유형

연락처 그룹 유형입니다.

열거형
GROUP_TYPE_UNSPECIFIED 지정되지 않았습니다.
USER_CONTACT_GROUP 사용자가 정의한 연락처 그룹입니다.
SYSTEM_CONTACT_GROUP 시스템에서 정의한 연락처 그룹입니다.

그룹 클라이언트 데이터

클라이언트에 의해 채워진 임의의 클라이언트 데이터입니다. 중복 키 및 값은 허용됩니다.

JSON 표현
{
  "key": string,
  "value": string
}
필드
key

string

클라이언트가 지정한 고객 데이터 키입니다.

value

string

클라이언트에서 지정한 클라이언트 데이터 값입니다.

방법

batchGet

연락처 그룹 리소스 이름 목록을 지정하여 인증된 사용자가 소유한 연락처 그룹 목록을 가져옵니다.

create

인증된 사용자가 소유한 새 연락처 그룹을 만듭니다.

delete

연락처 그룹 리소스 이름을 지정하여 인증된 사용자가 소유한 기존 연락처 그룹을 삭제합니다.

get

연락처 그룹 리소스 이름을 지정하여 인증된 사용자가 소유한 특정 연락처 그룹을 가져옵니다.

list

인증된 사용자가 소유한 모든 연락처 그룹을 나열합니다.

update

인증된 사용자가 소유한 기존 연락처 그룹의 이름을 업데이트합니다.