Migracja do interfejsu Postmaster Tools API w wersji 2

Ten przewodnik opisuje różnice między wersjami 1 i 2 interfejsu Postmaster Tools API oraz sposób przeniesienia aplikacji z wersji 1 do wersji 2.

Przegląd

Wersja 2 interfejsu Postmaster Tools API wprowadza kilka nowych funkcji i konsoliduje dotychczasowe funkcje pobierania statystyk e-maili. W wersji 2 możesz teraz:

  • Pobieranie statystyk w zakresach dat zamiast dla każdego dnia.
  • Sprawdzanie stanu zgodności z protokołami SPF (Sender Policy Framework), DKIM (DomainKeys Identified Mail) i DMARC (Domain-based Message Authentication, Reporting and Conformance).
  • Pobieranie statystyk dla wielu domen za pomocą jednego wywołania interfejsu API.

Najważniejsze zmiany:

  • Zasób trafficStats został zastąpiony zasobem domainStats.
  • Metody domains.trafficStats.get i domains.trafficStats.list zostały zastąpione jedną metodą domains.domainStats.query.
  • Dostępna jest nowa domains.getComplianceStatus metoda pobierania stanu zgodności SPF, DKIM i DMARC w danej domenie.
  • Dostępna jest nowa metoda domainStats.batchQuery, która umożliwia pobieranie statystyk dla wielu domen w ramach jednego wywołania.
  • Termin „dane” używany w wersji 1 został zmieniony na „statystyki”.

Aktualizacja do wersji 2

Aby przejść z wersji 1 na wersję 2, musisz zaktualizować bibliotekę klienta do najnowszej wersji i zmodyfikować kod, aby używać zasobów i metod wersji 2.

  1. Zaktualizuj bibliotekę klienta interfejsu Postmaster Tools API do wersji 2 lub nowszej.
  2. Zmień wszystkie połączenia z zasobu trafficStats na zasób domainStats.
  3. Zastąp wszystkie wywołania funkcji domains.trafficStats.get lub domains.trafficStats.list funkcją domains.domainStats.query, podając parametry startDate i endDate, aby określić zakres dat zapytania.

Pobieranie statystyk e-maili

W wersji 1 dane o e-mailach były pobierane za pomocą funkcji domains.trafficStats.get w przypadku jednego dnia lub domains.trafficStats.list w przypadku wielu dni. W wersji 2 statystyki e-maili są pobierane za pomocą funkcji domains.domainStats.query.

Metoda domains.domainStats.query pozwala pobierać statystyki z określonego zakresu dat przez podanie wartości startDate i 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 na jeden dzień

Aby pobrać statystyki za jeden dzień w wersji 2, wywołaj funkcję domains.domainStats.query z tymi samymi wartościami startDate i 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();

Wersja 2: domains.domainStats.query w przypadku zakresu dat

Aby pobrać statystyki z zakresu dat w wersji 2, wywołaj funkcję domains.domainStats.query z parametrami startDate i 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()

Nowe funkcje wersji 2

Oprócz konsolidacji statystyk ruchu get i list w query wersja 2 wprowadza te funkcje:

Pobieranie stanu zgodności

Za pomocą domains.getComplianceStatus możesz sprawdzić stan zgodności domeny z protokołami SPF (Sender Policy Framework), DKIM (DomainKeys Identified Mail) i DMARC (Domain-based Message Authentication, Reporting, and Conformance).

Przykładowy kod znajdziesz w sekcji Pobieranie statystyk e-maili.

Zbiorcze statystyki zapytań o domeny

Możesz pobrać statystyki dla wielu domen za pomocą jednego wywołania przy użyciu domainStats.batchQuery.