ย้ายข้อมูลไปยัง Postmaster Tools API v2

คู่มือนี้อธิบายความแตกต่างระหว่าง Postmaster Tools API เวอร์ชัน 1 กับเวอร์ชัน 2 และวิธีย้ายข้อมูลแอปพลิเคชันเวอร์ชัน 1 ไปยังเวอร์ชัน 2

ภาพรวม

Postmaster Tools API เวอร์ชัน 2 มีฟีเจอร์ใหม่หลายอย่างและรวมฟังก์ชันการทำงานที่มีอยู่สำหรับการดึงสถิติอีเมล ตอนนี้คุณทำสิ่งต่อไปนี้ได้แล้วด้วย v2

  • ดึงข้อมูลสถิติตามช่วงวันที่แทนที่จะเป็นต่อวัน
  • สอบถามสถานะการปฏิบัติตามข้อกำหนดสำหรับ Sender Policy Framework (SPF), Domainkeys Identified Mail (DKIM) และ Domain-based Message Authentication, Reporting and Conformance (DMARC)
  • เรียกข้อมูลสถิติของหลายโดเมนด้วยการเรียก API ครั้งเดียว

การเปลี่ยนแปลงที่สำคัญมีดังนี้

  • ระบบได้แทนที่แหล่งข้อมูล trafficStats ด้วย domainStats แล้ว
  • เราได้แทนที่เมธอด domains.trafficStats.get และ domains.trafficStats.list ด้วยเมธอด domains.domainStats.query เพียงเมธอดเดียว
  • ตอนนี้มีdomains.getComplianceStatusวิธีใหม่ในการดึงสถานะการปฏิบัติตามข้อกำหนดสำหรับ SPF, DKIM และ DMARC ของโดเมนที่ต้องการแล้ว
  • มีdomainStats.batchQueryเมธอดใหม่ที่พร้อมใช้งานเพื่อดึงสถิติของหลายโดเมนในการเรียกครั้งเดียว
  • เราได้เปลี่ยนชื่อคำว่า "เมตริก" ที่ใช้ใน v1 เป็น "สถิติ" แล้ว

อัปเดตเป็นเวอร์ชัน 2

หากต้องการย้ายข้อมูลจาก v1 ไปยัง v2 คุณต้องอัปเดตไลบรารีของไคลเอ็นต์เป็นเวอร์ชันล่าสุดและแก้ไขโค้ดเพื่อใช้ทรัพยากรและเมธอด v2

  1. อัปเดตไลบรารีของไคลเอ็นต์ Postmaster Tools API เป็นเวอร์ชัน 2 ขึ้นไป
  2. เปลี่ยนการเรียกทั้งหมดจากทรัพยากร trafficStats เป็นทรัพยากร domainStats
  3. แทนที่การเรียกใช้ 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

Java

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: domains.domainStats.query เป็นเวลา 1 วัน

หากต้องการดึงข้อมูลสถิติของวันเดียวใน v2 ให้เรียกใช้ domains.domainStats.query โดยใช้ startDate และ endDate เดียวกัน

Java

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

Java

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 ให้เรียกใช้ domains.domainStats.query โดยมี startDate และ endDate

Java

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

นอกจากจะรวมสถิติจำนวนการเข้าชม get และ list ไว้ใน query แล้ว v2 ยังเปิดตัวฟีเจอร์ต่อไปนี้ด้วย

เรียกดูสถานะการปฏิบัติตามข้อกำหนด

คุณสามารถดึงสถานะการปฏิบัติตามข้อกำหนดสำหรับ Sender Policy Framework (SPF), DomainKeys Identified Mail (DKIM) และ Domain-based Message Authentication, Reporting, and Conformance (DMARC) สำหรับโดเมนได้โดยใช้ domains.getComplianceStatus

ดูโค้ดตัวอย่างได้ที่ดึงข้อมูลสถิติอีเมล

ค้นหาสถิติโดเมนเป็นกลุ่ม

คุณสามารถดึงสถิติของหลายโดเมนด้วยการเรียกเพียงครั้งเดียวโดยใช้ domainStats.batchQuery