Method: contactGroups.update

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

업데이트된 연락처 그룹 이름은 사용자 연락처 그룹별로 고유해야 합니다. 중복된 이름으로 그룹을 만들려고 하면 HTTP 409 오류가 반환됩니다.

지연 시간 및 실패 증가를 방지하려면 동일한 사용자에 대한 변형 요청을 순차적으로 전송해야 합니다.

HTTP 요청

PUT https://people.googleapis.com/v1/{contactGroup.resourceName=contactGroups/*}

URL은 gRPC 트랜스코딩 문법을 사용합니다.

경로 매개변수

매개변수
contactGroup.resourceName

string

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

요청 본문

요청 본문에는 다음과 같은 구조의 데이터가 포함됩니다.

JSON 표현 
{
  "contactGroup": {
    "resourceName": string,
    "etag": string,
    "metadata": {
      "updateTime": string,
      "deleted": boolean
    },
    "groupType": enum (GroupType),
    "name": string,
    "formattedName": string,
    "memberResourceNames": [
      string
    ],
    "memberCount": integer,
    "clientData": [
      {
        "key": string,
        "value": string
      }
    ]
  },
  "updateGroupFields": string,
  "readGroupFields": string
}
필드
contactGroup.etag

string

리소스의 HTTP 항목 태그. 웹 캐시 유효성 검사에 사용됩니다.
contactGroup.metadata

object (ContactGroupMetadata)

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

enum (GroupType)

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

string

그룹 소유자가 설정한 연락처 그룹 이름 또는 시스템 그룹에 대한 시스템 제공 이름입니다.

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

string

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

string

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

integer

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

object (GroupClientData)

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

string (FieldMask format)

선택사항입니다. 그룹에서 업데이트되는 필드를 제한하는 필드 마스크입니다. 여러 필드는 쉼표로 구분하여 지정할 수 있습니다. 설정하지 않거나 비워두면 기본값은 name입니다. 업데이트된 필드가 대체됩니다. 유효한 값은 다음과 같습니다.

  • clientData
  • 이름
readGroupFields

string (FieldMask format)

선택사항입니다. 반환되는 그룹의 필드를 제한하는 필드 마스크입니다. 설정하지 않거나 비워두면 기본값은 metadata, groupType, name입니다. 유효한 필드는 다음과 같습니다.

  • clientData
  • groupType
  • memberCount
  • 메타데이터
  • 이름

응답 본문

성공한 경우 응답 본문에 ContactGroup의 인스턴스가 포함됩니다.

승인 범위

다음 OAuth 범위가 필요합니다.

  • https://www.googleapis.com/auth/contacts

자세한 내용은 승인 가이드를 참조하세요.