Bermigrasi ke Postmaster Tools API v2

Panduan ini menjelaskan perbedaan antara Postmaster Tools API v1 dan v2 serta cara memigrasikan aplikasi v1 Anda ke v2.

Ringkasan

Postmaster Tools API versi 2 memperkenalkan beberapa fitur baru dan menggabungkan fungsi yang ada untuk mengambil statistik email. Dengan v2, Anda kini dapat:

  • Mengambil statistik selama rentang tanggal, bukan per hari.
  • Kueri status kepatuhan untuk Sender Policy Framework (SPF), Domainkeys Identified Mail (DKIM), dan Domain-based Message Authentication, Reporting and Conformance (DMARC).
  • Mengambil statistik untuk beberapa domain dengan satu panggilan API.

Perubahan pentingnya antara lain:

  • Sumber daya trafficStats telah diganti dengan domainStats.
  • Metode domains.trafficStats.get dan domains.trafficStats.list telah diganti dengan satu metode domains.domainStats.query.
  • Metode domains.getComplianceStatus baru tersedia untuk mengambil status kepatuhan SPF, DKIM, dan DMARC untuk domain tertentu.
  • Metode domainStats.batchQuery baru tersedia untuk mengambil statistik beberapa domain dalam satu panggilan.
  • Istilah "metrik" yang digunakan di v1 telah diganti namanya menjadi "statistik".

Update ke v2

Untuk bermigrasi dari v1 ke v2, Anda harus mengupdate library klien ke versi terbaru dan mengubah kode untuk menggunakan resource dan metode v2.

  1. Perbarui library klien Postmaster Tools API Anda ke versi 2 atau yang lebih baru.
  2. Ubah semua panggilan dari resource trafficStats ke resource domainStats.
  3. Ganti panggilan ke domains.trafficStats.get atau domains.trafficStats.list dengan domains.domainStats.query, dengan memberikan parameter startDate dan endDate untuk menentukan rentang tanggal kueri.

Mengambil statistik email

Di v1, metrik email diambil menggunakan domains.trafficStats.get untuk satu hari atau domains.trafficStats.list untuk beberapa hari. Di v2, statistik email diambil menggunakan domains.domainStats.query.

Metode domains.domainStats.query memungkinkan Anda mengambil statistik selama rentang tanggal dengan menentukan startDate dan 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 untuk satu hari

Untuk mengambil statistik satu hari di v2, panggil domains.domainStats.query dengan startDate dan endDate yang sama.

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 untuk rentang tanggal

Untuk mengambil statistik rentang tanggal di v2, panggil domains.domainStats.query dengan startDate dan 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()

Fitur v2 baru

Selain menggabungkan statistik traffic get dan list ke dalam query, v2 memperkenalkan fitur berikut.

Mengambil status kepatuhan

Anda dapat mengambil status kepatuhan untuk Sender Policy Framework (SPF), DomainKeys Identified Mail (DKIM), dan Domain-based Message Authentication, Reporting, and Conformance (DMARC) untuk suatu domain menggunakan domains.getComplianceStatus.

Lihat Mengambil statistik email untuk contoh kode.

Mengirim kueri batch statistik domain

Anda dapat mengambil statistik untuk beberapa domain dengan satu panggilan menggunakan domainStats.batchQuery.