Zur Postmaster Tools API v2 migrieren

In dieser Anleitung werden die Unterschiede zwischen Version 1 und Version 2 der Postmaster Tools API beschrieben. Außerdem wird erläutert, wie Sie Ihre Version 1-Anwendung zu Version 2 migrieren.

Übersicht

Version 2 der Postmaster Tools API bietet mehrere neue Funktionen und fasst vorhandene Funktionen zum Abrufen von E‑Mail-Statistiken zusammen. Mit Version 2 haben Sie jetzt folgende Möglichkeiten:

  • Statistiken für Zeiträume anstelle von einzelnen Tagen abrufen.
  • Sie können den Compliance-Status für Sender Policy Framework (SPF), DomainKeys Identified Mail (DKIM) und Domain-based Message Authentication, Reporting and Conformance (DMARC) abfragen.
  • Statistiken für mehrere Domains mit einem einzelnen API-Aufruf abrufen

Wichtige Änderungen:

  • Die Ressource trafficStats wurde durch domainStats ersetzt.
  • Die Methoden domains.trafficStats.get und domains.trafficStats.list wurden durch eine einzelne Methode domains.domainStats.query ersetzt.
  • Es ist eine neue domains.getComplianceStatus-Methode verfügbar, mit der der Compliance-Status für SPF, DKIM und DMARC für eine bestimmte Domain abgerufen werden kann.
  • Mit der neuen Methode domainStats.batchQuery können Statistiken für mehrere Domains in einem einzigen Aufruf abgerufen werden.
  • Der in Version 1 verwendete Begriff „Messwerte“ wurde in „Statistiken“ umbenannt.

Aktualisierung auf Version 2

Wenn Sie von Version 1 zu Version 2 migrieren möchten, müssen Sie Ihre Clientbibliothek auf die neueste Version aktualisieren und Ihren Code so ändern, dass er Version 2-Ressourcen und ‑Methoden verwendet.

  1. Aktualisieren Sie Ihre Postmaster Tools API-Clientbibliothek auf Version 2 oder höher.
  2. Ändern Sie alle Aufrufe der trafficStats-Ressource in die domainStats-Ressource.
  3. Ersetzen Sie alle Aufrufe von domains.trafficStats.get oder domains.trafficStats.list durch domains.domainStats.query und geben Sie die Parameter startDate und endDate an, um den Zeitraum für die Abfrage festzulegen.

E-Mail-Statistiken abrufen

In Version 1 wurden E-Mail-Messwerte mit domains.trafficStats.get für einen einzelnen Tag oder mit domains.trafficStats.list für mehrere Tage abgerufen. In Version 2 werden E-Mail-Statistiken mit domains.domainStats.query abgerufen.

Mit der Methode domains.domainStats.query können Sie Statistiken für einen Zeitraum abrufen, indem Sie startDate und endDate angeben.

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();

Version 2: domains.domainStats.query für einen einzelnen Tag

Wenn Sie Statistiken für einen einzelnen Tag in Version 2 abrufen möchten, rufen Sie domains.domainStats.query mit demselben startDate und endDate auf.

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();

Version 2: domains.domainStats.query für einen Zeitraum

Wenn Sie Statistiken für einen Zeitraum in Version 2 abrufen möchten, rufen Sie domains.domainStats.query mit einem startDate und einem endDate auf.

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()

Neue Funktionen in Version 2

Zusätzlich zur Konsolidierung der Traffic-Statistiken für get und list in query bietet Version 2 die folgenden Funktionen.

Compliancestatus abrufen

Mit domains.getComplianceStatus können Sie den Compliance-Status für Sender Policy Framework (SPF), DomainKeys Identified Mail (DKIM) und Domain-based Message Authentication, Reporting and Conformance (DMARC) für eine Domain abrufen.

Beispielcode

Batch-Abfrage von Domainstatistiken

Mit domainStats.batchQuery können Sie Statistiken für mehrere Domains mit einem einzigen Aufruf abrufen.