Postmaster Tools API v2'ye geçiş yapma

Bu kılavuzda, Postmaster Tools API'nin v1 ve v2 sürümleri arasındaki farklar ile v1 uygulamanızı v2'ye taşıma hakkında bilgiler verilmektedir.

Genel Bakış

Postmaster Tools API'nin 2. sürümü, e-posta istatistiklerini alma konusunda mevcut işlevleri birleştirmenin yanı sıra çeşitli yeni özellikler sunar. 2. sürümle birlikte artık şunları yapabilirsiniz:

  • İstatistikleri günlük olarak değil, tarih aralıklarına göre alın.
  • Gönderen Politikası Çerçevesi (SPF), DomainKeys Identified Mail (DKIM) ve Alan Tabanlı İleti Kimlik Doğrulaması, Raporlama ve Uygunluk (DMARC) için uygunluk durumunu sorgulayın.
  • Tek bir API çağrısıyla birden fazla alanın istatistiklerini alın.

Başlıca değişiklikler:

  • trafficStats kaynağı, domainStats ile değiştirildi.
  • domains.trafficStats.get ve domains.trafficStats.list yöntemleri tek bir domains.domainStats.query yöntemiyle değiştirildi.
  • Belirli bir alan için SPF, DKIM ve DMARC'nin uygunluk durumunu almak üzere yeni bir domains.getComplianceStatus yöntemi kullanıma sunuldu.
  • Tek bir çağrıda birden fazla alan adıyla ilgili istatistikleri almak için yeni bir domainStats.batchQuery yöntemi kullanıma sunuldu.
  • v1'de kullanılan "metrikler" terimi "istatistikler" olarak yeniden adlandırıldı.

v2'ye güncelleme

v1'den v2'ye geçmek için istemci kitaplığınızı en yeni sürüme güncellemeniz ve kodunuzu v2 kaynaklarını ve yöntemlerini kullanacak şekilde değiştirmeniz gerekir.

  1. Postmaster Tools API istemci kitaplığınızı 2 veya daha yeni bir sürüme güncelleyin.
  2. trafficStats kaynağındaki tüm çağrıları domainStats kaynağına yönlendirin.
  3. domains.trafficStats.get veya domains.trafficStats.list işlevine yapılan tüm çağrıları domains.domainStats.query ile değiştirin. Sorgunun tarih aralığını belirtmek için startDate ve endDate parametrelerini sağlayın.

E-posta istatistiklerini alma

V1'de e-posta metrikleri tek bir gün için domains.trafficStats.get, birden fazla gün için domains.trafficStats.list kullanılarak alınıyordu. v2'de e-posta istatistikleri domains.domainStats.query kullanılarak alınır.

domains.domainStats.query yöntemi, startDate ve endDate değerlerini belirterek bir tarih aralığındaki istatistikleri almanıza olanak tanır.

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: Tek bir gün için domains.domainStats.query

v2'de tek bir güne ait istatistikleri almak için aynı startDate ve endDate ile domains.domainStats.query çağrısını yapın.

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 tarih aralığı için

v2'de bir tarih aralığına ait istatistikleri almak için domains.domainStats.query işlevini startDate ve endDate ile çağırın.

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

Yeni v2 özellikleri

v2, get ve list trafik istatistiklerini query içinde birleştirmenin yanı sıra aşağıdaki özellikleri de sunar.

Uygunluk durumunu alma

Bir alan için Gönderen Politikası Çerçevesi (SPF), Alan Anahtarı Tarafından Tanımlanan Posta (DKIM) ve Alan Adı Tabanlı İleti Kimlik Doğrulaması, Raporlama ve Uygunluk (DMARC) ile ilgili uygunluk durumunu domains.getComplianceStatus kullanarak alabilirsiniz.

Örnek kod için E-posta istatistiklerini alma başlıklı makaleyi inceleyin.

Alan istatistiklerini toplu olarak sorgulama

domainStats.batchQuery kullanarak tek bir çağrıyla birden fazla alanın istatistiklerini alabilirsiniz.