Google의 CardDAV 프로토콜을 사용하여 연락처를 보고 관리할 수 있습니다.
연락처는 사용자의 Google 계정에 저장되며 대부분의 Google 서비스에서 연락처 목록에 액세스할 수 있습니다. 클라이언트 애플리케이션은 CardDAV API를 사용하여 새 연락처를 만들고, 기존 연락처를 수정 또는 삭제하고, 특정 기준과 일치하는 연락처를 쿼리할 수 있습니다.
사양
전체 사양은 구현되지 않았지만 Apple iOSTM 연락처 및 macOS와 같은 많은 클라이언트가 올바르게 상호 운용됩니다.
각 관련 사양에 대해 Google의 CardDAV 지원은 다음과 같습니다.
- rfc2518: 분산 작성을 위한 HTTP 확장 프로그램 (WebDAV)
- HTTP 메서드
GET
,PUT
,DELETE
,OPTIONS
,PROPFIND
를 지원합니다. - HTTP 메서드
LOCK
,UNLOCK
,COPY
,MOVE
또는MKCOL
는 지원하지 않습니다. - 임의 (사용자 정의) WebDAV 속성은 지원하지 않습니다.
- WebDAV 액세스 제어 (rfc3744)는 지원하지 않습니다.
- HTTP 메서드
- rfc5995: POST를 사용하여 WebDAV 컬렉션에 구성원 추가
- ID를 지정하지 않고 새 연락처를 만들 수 있습니다.
- rfc6352: CardDAV: vCard 확장 프로그램(웹 분산 작성 및 버전 관리)(WebDAV)
- HTTP 메서드
REPORT
를 지원하지만 정의된 모든 보고서가 구현되지는 않습니다. - 주 구성원 컬렉션과 연락처 컬렉션 제공을 지원합니다.
- HTTP 메서드
- rfc6578: WebDAV의 컬렉션 동기화
- 클라이언트 애플리케이션은 초기 동기화 후 이 작업 모드로 전환해야 합니다.
- rfc6749: OAuth 2.0 승인 프레임워크 및 rfc6750: OAuth 2.0 승인 프레임워크: Bearer 토큰 사용
- OAuth 2.0 HTTP 인증을 사용한 CardDAV 클라이언트 프로그램 인증을 지원합니다. Google에서는 다른 인증 방법을 지원하지 않습니다. 연락처 데이터 보안을 위해 CardDAV 연결에 HTTPS가 사용되어야 합니다.
- rfc6764: WebDAV로의 캘린더 확장 프로그램 (CalDAV) 및 WebDAV에 대한 vCard 확장 프로그램 (CardDAV)을 위한 서비스 찾기
- CardDAV URL의 부트스트랩은 rfc6764의 섹션 6에 따라 수행해야 합니다.
- CardDAV와 CalDAV 사양 간에 공유되는 caldav-ctag-02: CalDAV의 캘린더 컬렉션 항목 태그 (CTag)를 지원합니다. 연락처
ctag
는 리소스ETag
와 유사하며 연락처 주소록의 내용이 변경되면 변경됩니다. 이렇게 하면 클라이언트 프로그램이 변경된 연락처를 동기화할 필요가 없다는 것을 빠르게 판단할 수 있습니다. - Google은 연락처 인코딩 형식으로 VCard 3.0을 사용합니다. rfc6350: VCard 3.0을 참조하세요.
Google의 CardDAV를 사용하려면 OAuth 2.0이 필요합니다.
Google의 CardDAV 인터페이스에는 OAuth 2.0이 필요합니다. OAuth 2.0을 사용하여 Google API에 액세스하는 방법은 아래에 링크된 문서를 참조하세요.
Google의 CardDAV 서버에 연결
CardDAV 프로토콜을 사용하면 주소록과 연락처 리소스 URI를 검색할 수 있습니다. URI는 언제든지 변경될 수 있으므로 하드코딩해서는 안 됩니다.
클라이언트 애플리케이션은 HTTPS를 사용해야 하고 사용자의 Google 계정에 OAuth 2.0
인증을 제공해야 합니다. CardDAV 서버는 요청이 Google 계정의 OAuth 2.0 인증을 통해 HTTPS를 통해 도착하고 애플리케이션이 DevConsole에 등록되어 있지 않으면 요청을 인증하지 않습니다. 기본 인증 또는 Google 계정과 일치하지 않는 이메일/비밀번호로 HTTP를 통해 연결하려고 하면 HTTP 401 Unauthorized
응답 코드가 반환됩니다.
CardDAV를 사용하려면 먼저 클라이언트 프로그램이 다음에서 HTTP PROPFIND
을 수행하여 표준 검색 경로에 연결해야 합니다.
https://www.googleapis.com/.well-known/carddav
주소록 리소스로 리디렉션되면 (HTTP 301
) 클라이언트 프로그램은 리소스에 대해 PROPFIND
를 수행하여 DAV:current-user-principal
, DAV:principal-URL
, addressbook-home-set
속성을 검색할 수 있습니다. 그러면 클라이언트 프로그램은 addressbook-home-set
에서 PROPFIND
를 수행하고 addressbook
및 collection
리소스를 찾아 주 구성원 주소록을 검색할 수 있습니다. 이 프로세스에 대한 자세한 설명은 이 문서에서 다루지 않습니다. 자세한 내용은 rfc6352를 참고하세요.
rfc6764에 따라 잘 알려진 URI의 PROPFIND
를 통해 HTTP 301
응답에서 반환된 리디렉션 경로는 영구적으로 캐시되면 안 됩니다. 기기는 잘 알려진 URI 검색을 주기적으로 재시도하여 캐시된 경로가 여전히 최신 상태인지 확인하고 경로가 변경되면 다시 동기화해야 합니다. Google에서는 2~4주 간격으로 구독하는 것을 권장합니다.
자료
CardDAV는 REST 개념을 사용합니다. 클라이언트 애플리케이션은 URI로 지정된 리소스에서 작동합니다. 개발자가 다음 섹션에서 개념을 이해하는 데 도움이 되도록 현재 URI 구조가 여기에 지정되어 있습니다. 구조는 변경될 수 있으며 하드코딩해서는 안 됩니다. RFC에 따라 리소스를 검색해야 합니다.
- 주 구성원
- https://www.googleapis.com/carddav/v1/principals/
userEmail
- https://www.googleapis.com/carddav/v1/principals/
- 홈 세트
- https://www.googleapis.com/carddav/v1/principals/
userEmail
/lists
- https://www.googleapis.com/carddav/v1/principals/
- 주소록
- https://www.googleapis.com/carddav/v1/principals/
userEmail
/lists/default
- https://www.googleapis.com/carddav/v1/principals/
- 문의
- https://www.googleapis.com/carddav/v1/principals/
userEmail
/lists/default/contactId
- https://www.googleapis.com/carddav/v1/principals/
주소록 동기화
다음은 지원되는 연산에 대한 일반적인 설명입니다. 개발자는 관련 RFC에서 세부정보를 찾아야 합니다. 요청과 응답은 대부분 XML로 인코딩됩니다. 다음은 클라이언트 애플리케이션에서 동기화를 위해 사용하는 기본 작업입니다.
- CTag 사용
- 클라이언트 프로그램은 주소록 리소스의
getctag
PROPFIND
요청을 사용하여 서버에서 연락처가 변경되었는지, 따라서 동기화가 필요한지 확인합니다. 이 속성의 값은 연락처가 변경되면 반드시 변경됩니다. 클라이언트 애플리케이션은 이 값을 저장하여 초기 동기화 시에만 그리고sync-token
가 무효화될 때의 대체 수단으로 사용해야 합니다. 주기적으로getctag
속성을 폴링하면 제한됩니다.
- 클라이언트 프로그램은 주소록 리소스의
- sync-token 사용
- 클라이언트 프로그램은 주소록의
sync-token
PROPFIND
요청을 사용하여 현재 상태를 나타내는sync-token
를 가져옵니다. 클라이언트 애플리케이션은 이 값을 저장하고 주기적인sync-collection
REPORT
요청을 실행하여 마지막으로 발행된sync-token
이후의 변경사항을 확인해야 합니다. 발급된 토큰은 29일 동안 유효하며REPORT
응답에 새sync-token
가 포함됩니다.
- 클라이언트 프로그램은 주소록의
- ETag 사용
- 클라이언트 애플리케이션은 주소록 리소스에
getetag
PROPFIND
요청을 실행합니다 (DEPTH
헤더는DEPTH_1
임). 각 연락처의ETag
값을 유지하면 클라이언트 프로그램은ETag
가 변경된 연락처 값을 요청할 수 있습니다.
- 클라이언트 애플리케이션은 주소록 리소스에
- 연락처 검색
- 클라이언트 애플리케이션은
addressbook-multiget
REPORT
요청을 실행하여 연락처를 검색합니다. 연락처 URI 목록이 있으면 보고서는 요청된 모든 연락처를 VCard 3.0 값으로 반환합니다. 각 항목에는 연락처의ETag
가 포함됩니다.
- 클라이언트 애플리케이션은
- 연락처 삽입
- 클라이언트 애플리케이션은 VCard 3.0 형식의 새 연락처에
POST
요청을 보냅니다. 응답에는 새 연락처의 ID가 포함됩니다.
- 클라이언트 애플리케이션은 VCard 3.0 형식의 새 연락처에
- 연락처 업데이트
- 클라이언트 애플리케이션은 VCard 3.0 형식으로 업데이트된 연락처로
PUT
요청을 보냅니다. 연락처가 이미 주소록에 있으면 업데이트됩니다. - 클라이언트 애플리케이션에는 현재 알려진 연락처의
ETag
가 포함된If-Match
헤더가 포함되어야 합니다. 그런 다음 서버의 현재ETag
가 클라이언트 프로그램에서 전송한ETag
와 다른 경우 서버는PUT
요청 (HTTP 412
사용)을 거부합니다. 이를 통해 업데이트의 낙관적 직렬화가 가능합니다.
- 클라이언트 애플리케이션은 VCard 3.0 형식으로 업데이트된 연락처로
- 연락처 삭제
- 클라이언트 애플리케이션은 연락처 URI에 대해
DELETE
요청을 실행하여 연락처를 삭제합니다.
- 클라이언트 애플리케이션은 연락처 URI에 대해