Esegui la migrazione all'API Postmaster Tools v2

Questa guida descrive le differenze tra la v1 e la v2 dell'API Postmaster Tools e come eseguire la migrazione dell'applicazione v1 alla v2.

Panoramica

La versione 2 dell'API Postmaster Tools introduce diverse nuove funzionalità e consolida quelle esistenti per il recupero delle statistiche email. Con la v2 ora puoi:

  • Recupera le statistiche in base agli intervalli di date anziché per giorno.
  • Esegui query sullo stato di conformità per SPF (Sender Policy Framework), DKIM (Domainkeys Identified Mail) e DMARC (Domain-based Message Authentication, Reporting and Conformance).
  • Recupera le statistiche per più domini con una singola chiamata API.

Le principali modifiche includono:

  • La risorsa trafficStats è stata sostituita con domainStats.
  • I metodi domains.trafficStats.get e domains.trafficStats.list sono stati sostituiti da un unico metodo domains.domainStats.query.
  • È disponibile un nuovo metodo domains.getComplianceStatus per recuperare lo stato di conformità per SPF, DKIM e DMARC per un determinato dominio.
  • È disponibile un nuovo metodo domainStats.batchQuery per recuperare le statistiche per più domini in una singola chiamata.
  • Il termine "metriche" utilizzato nella v1 è stato rinominato "statistiche".

Aggiornamento alla versione 2

Per eseguire la migrazione dalla v1 alla v2, devi aggiornare la libreria client all'ultima versione e modificare il codice per utilizzare le risorse e i metodi della v2.

  1. Aggiorna la libreria client API Postmaster Tools alla versione 2 o successive.
  2. Modifica tutte le chiamate dalla risorsa trafficStats alla risorsa domainStats.
  3. Sostituisci tutte le chiamate a domains.trafficStats.get o domains.trafficStats.list con domains.domainStats.query, fornendo i parametri startDate e endDate per specificare l'intervallo di date per la query.

Recuperare le statistiche email

Nella v1, le metriche email venivano recuperate utilizzando domains.trafficStats.get per un singolo giorno o domains.trafficStats.list per più giorni. Nella versione 2, le statistiche email vengono recuperate utilizzando domains.domainStats.query.

Il metodo domains.domainStats.query consente di recuperare le statistiche in un intervallo di date specificando startDate e 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 per un solo giorno

Per recuperare le statistiche per un singolo giorno nella v2, chiama domains.domainStats.query con gli stessi startDate e 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 per un intervallo di date

Per recuperare le statistiche per un intervallo di date nella v2, chiama domains.domainStats.query con startDate e 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()

Nuove funzionalità della versione 2

Oltre a consolidare le statistiche sul traffico di get e list in query, la v2 introduce le seguenti funzionalità.

Recuperare lo stato di conformità

Puoi recuperare lo stato di conformità per SPF (Sender Policy Framework), DKIM (DomainKeys Identified Mail) e DMARC (Domain-based Message Authentication, Reporting, and Conformance) per un dominio utilizzando domains.getComplianceStatus.

Per un esempio di codice, consulta Recuperare le statistiche email.

Statistiche sul dominio delle query batch

Puoi recuperare le statistiche per più domini con una singola chiamata utilizzando domainStats.batchQuery.