Di chuyển sang Postmaster Tools API phiên bản 2

Hướng dẫn này mô tả sự khác biệt giữa phiên bản 1 và phiên bản 2 của Postmaster Tools API, cũng như cách di chuyển ứng dụng phiên bản 1 sang phiên bản 2.

Tổng quan

Postmaster Tools API phiên bản 2 giới thiệu một số tính năng mới và hợp nhất chức năng hiện có để truy xuất số liệu thống kê về email. Với phiên bản 2, giờ đây, bạn có thể:

  • Truy xuất số liệu thống kê trong phạm vi ngày thay vì theo ngày.
  • Truy vấn trạng thái tuân thủ cho Khung chính sách người gửi (SPF), Thư được xác định theo khoá miền (DKIM) và Báo cáo và hợp chuẩn, xác thực thư dựa trên miền (DMARC).
  • Truy xuất số liệu thống kê cho nhiều miền bằng một lệnh gọi API.

Sau đây là các thay đổi quan trọng:

  • Tài nguyên trafficStats đã được thay thế bằng domainStats.
  • Các phương thức domains.trafficStats.get và domains.trafficStats.list đã được thay thế bằng một phương thức domains.domainStats.query duy nhất.
  • Phương thức domains.getComplianceStatus mới có sẵn để truy xuất trạng thái tuân thủ cho SPF, DKIM và DMARC đối với một miền nhất định.
  • Phương thức domainStats.batchQuery mới có sẵn để truy xuất số liệu thống kê cho nhiều miền trong một lệnh gọi.
  • Thuật ngữ "chỉ số" được dùng trong phiên bản 1 đã được đổi tên thành "số liệu thống kê".

Cập nhật lên phiên bản 2

Để di chuyển từ phiên bản 1 sang phiên bản 2, bạn cần cập nhật thư viện ứng dụng lên phiên bản mới nhất và sửa đổi mã để sử dụng các tài nguyên và phương thức của phiên bản 2.

  1. Cập nhật thư viện ứng dụng Postmaster Tools API lên phiên bản 2 trở lên.
  2. Thay đổi tất cả lệnh gọi từ tài nguyên trafficStats thành tài nguyên domainStats.
  3. Thay thế mọi lệnh gọi đến domains.trafficStats.get hoặc domains.trafficStats.list bằng domains.domainStats.query, cung cấp các tham số startDate và endDate để chỉ định phạm vi ngày cho truy vấn.

Truy xuất số liệu thống kê về email

Trong phiên bản 1, các chỉ số về email được truy xuất bằng domains.trafficStats.get cho một ngày hoặc domains.trafficStats.list cho nhiều ngày. Trong phiên bản 2, số liệu thống kê về email được truy xuất bằng domains.domainStats.query.

Phương thức domains.domainStats.query cho phép bạn truy xuất số liệu thống kê trong một phạm vi ngày bằng cách chỉ định startDate và endDate.

Phiên bản 1: 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();

Phiên bản 2: domains.domainStats.query cho một ngày

Để truy xuất số liệu thống kê cho một ngày trong phiên bản 2, hãy gọi domains.domainStats.query với cùng startDate và 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()

Phiên bản 1: 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();

Phiên bản 2: domains.domainStats.query cho một phạm vi ngày

Để truy xuất số liệu thống kê cho một phạm vi ngày trong phiên bản 2, hãy gọi domains.domainStats.query với startDate và 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()

Các tính năng mới của phiên bản 2

Ngoài việc hợp nhất số liệu thống kê về lưu lượng truy cập get và list thành query, phiên bản 2 còn giới thiệu các tính năng sau.

Truy xuất trạng thái tuân thủ

Bạn có thể truy xuất trạng thái tuân thủ cho Khung chính sách người gửi (SPF), Thư được xác định theo khoá miền (DKIM) và Báo cáo và hợp chuẩn, xác thực thư dựa trên miền (DMARC) cho một miền bằng cách sử dụng domains.getComplianceStatus.

Hãy xem phần Truy xuất số liệu thống kê về email để biết mã mẫu.

Truy vấn hàng loạt số liệu thống kê về miền

Bạn có thể truy xuất số liệu thống kê cho nhiều miền bằng một lệnh gọi bằng cách sử dụng domainStats.batchQuery.