Zur Postmaster Tools API v2 migrieren

In diesem Leitfaden werden die Unterschiede zwischen Version 1 und Version 2 der Postmaster Tools API beschrieben und Sie erfahren, wie Sie Ihre Version 1-Anwendung zu Version 2 migrieren.

Übersicht

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

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

Wichtige Änderungen:

  • Die Ressource trafficStats wurde durch domainStats ersetzt.
  • Die Methoden domains.trafficStats.get und domains.trafficStats.list wurden durch eine einzige Methode domains.domainStats.query ersetzt.
  • Eine neue Methode domains.getComplianceStatus ist verfügbar, um den Compliancestatus für SPF, DKIM und DMARC für eine bestimmte Domain abzurufen.
  • Eine neue Methode domainStats.batchQuery ist verfügbar, um Statistiken für mehrere Domains in einem einzigen Aufruf abzurufen.
  • Der in Version 1 verwendete Begriff „Messwerte“ wurde in „Statistiken“ umbenannt.

Auf Version 2 aktualisieren

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 Version 2-Ressourcen und ‑Methoden verwendet werden.

  1. Aktualisieren Sie Ihre Postmaster Tools API-Clientbibliothek auf Version 2 oder höher.
  2. Ändern Sie alle Aufrufe von der Ressource trafficStats zur Ressource domainStats.
  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.

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

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

Wenn Sie in Version 2 Statistiken für einen einzelnen Tag 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()

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

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

Wenn Sie in Version 2 Statistiken für einen Zeitraum abrufen möchten, rufen Sie domains.domainStats.query mit einem startDate und 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

Neben der Zusammenfassung von get und list für Traffic-Statistiken in query bietet Version 2 die folgenden Funktionen.

Compliancestatus abrufen

Mit domains.getComplianceStatus können Sie den Compliancestatus für SPF, DKIM und DMARC für eine Domain abrufen.

Beispielcode finden Sie unter Compliancestatus für eine Domain abrufen.

Domainstatistiken per Batch abfragen

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