이 가이드에서는 Postmaster Tools API의 v1과 v2의 차이점과 v1 애플리케이션을 v2로 이전하는 방법을 설명합니다.
개요
버전 2의 Postmaster Tools API에는 여러 새로운 기능이 도입되었으며 이메일 통계를 가져오기 위한 기존 기능이 통합되었습니다. 이제 v2를 사용하면 다음 작업을 할 수 있습니다.
- 일별이 아닌 기간별 통계를 가져옵니다.
- 발신자 정책 프레임워크 (SPF), 도메인키 인증 이메일 (DKIM), 도메인 기반 메일 인증, 보고 및 확인 (DMARC)의 규정 준수 상태를 쿼리합니다.
- 단일 API 호출로 여러 도메인의 통계를 가져옵니다.
주요 변경사항은 다음과 같습니다.
trafficStats리소스가domainStats으로 대체되었습니다.domains.trafficStats.get및domains.trafficStats.list메서드가 단일domains.domainStats.query메서드로 대체되었습니다.- 지정된 도메인의 SPF, DKIM, DMARC에 대한 규정 준수 상태를 가져오는 데 사용할 수 있는 새로운
domains.getComplianceStatus메서드가 제공됩니다. - 한 번의 호출로 여러 도메인의 통계를 가져올 수 있는 새로운
domainStats.batchQuery메서드가 제공됩니다. - v1에서 사용된 '측정항목'이라는 용어가 '통계'로 바뀌었습니다.
v2로 업데이트
v1에서 v2로 이전하려면 클라이언트 라이브러리를 최신 버전으로 업데이트하고 v2 리소스와 메서드를 사용하도록 코드를 수정해야 합니다.
- Postmaster Tools API 클라이언트 라이브러리를 버전 2 이상으로 업데이트합니다.
trafficStats리소스에서domainStats리소스로의 모든 호출을 변경합니다.domains.trafficStats.get또는domains.trafficStats.list에 대한 호출을domains.domainStats.query로 대체하고startDate및endDate매개변수를 제공하여 쿼리의 날짜 범위를 지정합니다.
이메일 통계 가져오기
v1에서는 하루의 경우 domains.trafficStats.get, 여러 날의 경우 domains.trafficStats.list를 사용하여 이메일 측정항목을 가져왔습니다. v2에서는 domains.domainStats.query를 사용하여 이메일 통계를 가져옵니다.
domains.domainStats.query 메서드를 사용하면 startDate 및 endDate를 지정하여 기간별 통계를 검색할 수 있습니다.
v1: domains.trafficStats.get
자바
String query = String.format("domains/%s/trafficStats/%s", domainName, date);
TrafficStats trafficStats = service.domains().trafficStats().get(query).execute();
Python
query = 'domains/%s/trafficStats/%s' %(domain_name,date)
traffic_stats = service.domains().trafficStats().get(name=query).execute();
v2: 1일 동안 domains.domainStats.query
v2에서 특정 날짜의 통계를 가져오려면 동일한 startDate 및 endDate로 domains.domainStats.query를 호출합니다.
자바
Date date = new Date().setYear(2024).setMonth(1).setDay(1);
QueryDomainStatsResponse statsResponse = service.domains().domainStats()
.query("domains/" + domainName)
.setStartDate(date)
.setEndDate(date)
.execute();
Python
date = {'year': 2024, 'month': 1, 'day': 1}
stats = service.domains().domainStats().query(
parent='domains/' + domain_name,
startDate=date,
endDate=date).execute()
v1: domains.trafficStats.list
자바
ListTrafficStatsResponse listTrafficStatsResponse = service.domains().trafficStats().list("domains/" + domainName)
.execute();
Python
query = 'domains/' + domain_name
list_traffic_stats_response = service.domains().trafficStats().list(parent=query).execute();
v2: 기간의 domains.domainStats.query
v2에서 기간의 통계를 검색하려면 startDate 및 endDate와 함께 domains.domainStats.query를 호출합니다.
자바
Date startDate = new Date().setYear(2024).setMonth(1).setDay(1);
Date endDate = new Date().setYear(2024).setMonth(1).setDay(7);
QueryDomainStatsResponse statsResponse = service.domains().domainStats()
.query("domains/" + domainName)
.setStartDate(startDate)
.setEndDate(endDate)
.execute();
Python
stats = service.domains().domainStats().query(
parent='domains/' + domain_name,
startDate={'year': 2024, 'month': 1, 'day': 1},
endDate={'year': 2024, 'month': 1, 'day': 7}).execute()
새로운 v2 기능
v2에서는 get 및 list 트래픽 통계를 query로 통합하는 것 외에 다음 기능이 도입되었습니다.
규정 준수 상태 가져오기
domains.getComplianceStatus를 사용하여 도메인의 SPF (Sender Policy Framework), DKIM (DomainKeys Identified Mail), DMARC (Domain-based Message Authentication, Reporting, and Conformance)의 규정 준수 상태를 가져올 수 있습니다.
샘플 코드는 이메일 통계 가져오기를 참고하세요.
도메인 통계 일괄 쿼리
domainStats.batchQuery을 사용하여 단일 호출로 여러 도메인의 통계를 가져올 수 있습니다.