Method: people.batchUpdateContacts

연락처를 일괄적으로 업데이트하고 업데이트된 연락처에 대한 리소스 이름 맵을 PersonResponses에 반환합니다.

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

HTTP 요청

POST https://people.googleapis.com/v1/people:batchUpdateContacts

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

요청 본문

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

JSON 표현
{
  "contacts": {
    string: {
      object (Person)
    },
    ...
  },
  "updateMask": string,
  "readMask": string,
  "sources": [
    enum (ReadSourceType)
  ]
}
필드
contacts

map (key: string, value: object (Person))

필수 항목입니다. 업데이트할 개인 데이터에 대한 리소스 이름의 맵입니다. 단일 요청으로 최대 200개의 연락처를 허용합니다.

"key": value 쌍 목록을 포함하는 객체입니다. 예: { "name": "wrench", "mass": "1.3kg", "count": "3" }

updateMask

string (FieldMask format)

필수 항목입니다. 업데이트되는 사람의 필드를 제한하는 필드 마스크입니다. 여러 필드는 쉼표로 구분하여 지정할 수 있습니다. 각 사용자에 대해 지정된 모든 입력란이 대체되거나 비어 있는 경우 지워집니다. 유효한 값은 다음과 같습니다.

  • addresses
  • 전기
  • 생일
  • calendarUrls
  • clientData
  • emailAddresses
  • 이벤트
  • externalIds
  • 성별
  • imClients
  • 관심분야
  • locales
  • 위치
  • 멤버십
  • miscKeywords
  • 이름
  • 닉네임
  • 직업
  • organizations
  • phoneNumbers
  • 관계
  • sipAddresses
  • URL
  • userDefined
readMask

string (FieldMask format)

필수 항목입니다. 각 사용자의 어떤 필드가 반환되는지를 제한하는 필드 마스크입니다. 여러 필드는 쉼표로 구분하여 지정할 수 있습니다. 읽기 마스크가 비어 있으면 post-Variant-get을 건너뛰고 응답에 데이터가 반환되지 않습니다. 유효한 값은 다음과 같습니다.

  • addresses
  • ageRanges
  • 전기
  • 생일
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • 이벤트
  • externalIds
  • 성별
  • imClients
  • 관심분야
  • locales
  • 위치
  • 멤버십
  • 메타데이터
  • miscKeywords
  • 이름
  • 닉네임
  • 직업
  • organizations
  • phoneNumbers
  • 사진
  • 관계
  • sipAddresses
  • 기술
  • URL
  • userDefined
sources[]

enum (ReadSourceType)

선택사항입니다. 반환할 소스 유형의 마스크입니다. 설정하지 않으면 기본값은 READ_SOURCE_TYPE_CONTACTREAD_SOURCE_TYPE_PROFILE입니다.

응답 본문

실패하면 각 연락처에 해당하는 오류 목록인 BatchUpdateContactsErrorDetails를 반환합니다.

연락처 일괄 업데이트 요청에 대한 응답입니다.

성공할 경우 응답 본문에 다음 구조의 데이터가 포함됩니다.

JSON 표현
{
  "updateResult": {
    string: {
      object (PersonResponse)
    },
    ...
  }
}
필드
updateResult

map (key: string, value: object (PersonResponse))

readMask 요청이 비어 있지 않은 경우 업데이트된 연락처에 대한 리소스 이름 맵입니다.

"key": value 쌍 목록을 포함하는 객체입니다. 예: { "name": "wrench", "mass": "1.3kg", "count": "3" }

승인 범위

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

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

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