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
  • 전기
  • 생일
  • 캘린더 URL
  • 고객 데이터
  • 이메일 주소
  • 이벤트
  • 외부 ID
  • 성별
  • imClient
  • 관심분야
  • locales
  • 위치
  • 멤버십
  • 기타 키워드
  • names
  • 닉네임
  • 직업
  • organizations
  • 전화번호
  • 관계
  • SIP주소
  • URL
  • 사용자 정의됨
readMask

string (FieldMask format)

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

  • addresses
  • 연령대
  • 전기
  • 생일
  • 캘린더 URL
  • 고객 데이터
  • 표지사진
  • 이메일 주소
  • 이벤트
  • 외부 ID
  • 성별
  • imClient
  • 관심분야
  • locales
  • 위치
  • 멤버십
  • metadata
  • 기타 키워드
  • names
  • 닉네임
  • 직업
  • organizations
  • 전화번호
  • 포토
  • 관계
  • SIP주소
  • 기술
  • URL
  • 사용자 정의됨
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

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