نقل البيانات إلى الإصدار 2 من Postmaster Tools API

يصف هذا الدليل الاختلافات بين الإصدارَين 1 و2 من Postmaster Tools API وكيفية نقل تطبيقك من الإصدار 1 إلى الإصدار 2.

نظرة عامة

يقدّم الإصدار 2 من Postmaster Tools API عدة ميزات جديدة ويجمع الوظائف الحالية لاسترداد إحصاءات البريد الإلكتروني. باستخدام الإصدار 2، يمكنك الآن إجراء ما يلي:

  • استرداد الإحصاءات على نطاقات زمنية بدلاً من استردادها يوميًا
  • الاستعلام عن حالة الامتثال لنظام التعرُّف على هوية المُرسِل (SPF) والبريد المُعرَّف بمفاتيح النطاق (DKIM) ومصادقة الرسائل والإبلاغ عنها ومطابقتها استنادًا إلى النطاق (DMARC)
  • استرداد إحصاءات نطاقات متعددة باستخدام طلب بيانات من واجهة برمجة التطبيقات واحد

تشمل التغييرات الرئيسية ما يلي:

  • تم استبدال مورد trafficStats بمورد domainStats.
  • تم استبدال الطريقتَين domains.trafficStats.get وdomains.trafficStats.list بطريقة واحدة هي domains.domainStats.query.
  • تتوفّر طريقة جديدة هي domains.getComplianceStatus لاسترداد حالة الامتثال لنظام التعرُّف على هوية المُرسِل (SPF) والبريد المُعرَّف بمفاتيح النطاق (DKIM) ومصادقة الرسائل والإبلاغ عنها ومطابقتها استنادًا إلى النطاق (DMARC) لنطاق معيّن.
  • تتوفّر طريقة جديدة هي domainStats.batchQuery لاسترداد إحصاءات نطاقات متعددة في طلب واحد.
  • تمت إعادة تسمية المصطلح "مقاييس" المستخدَم في الإصدار 1 إلى "إحصاءات".

التحديث إلى الإصدار 2

للنقل من الإصدار 1 إلى الإصدار 2، عليك تحديث مكتبة برامج العميل إلى أحدث إصدار وتعديل الرمز البرمجي لاستخدام موارد الإصدار 2 وطُرق عرضه.

  1. حدِّث مكتبة برامج عميل Postmaster Tools API إلى الإصدار 2 أو إصدار أحدث.
  2. غيِّر جميع الطلبات من مورد trafficStats إلى مورد domainStats.
  3. استبدِل أي طلبات إلى domains.trafficStats.get أو domains.trafficStats.list بالطلب domains.domainStats.query، مع توفير المَعلمتَين startDate وendDate لتحديد النطاق الزمني للاستعلام.

استرداد إحصاءات البريد الإلكتروني

في الإصدار 1، تم استرداد مقاييس البريد الإلكتروني باستخدام domains.trafficStats.get ليوم واحد أو domains.trafficStats.list لأيام متعددة. في الإصدار 2، يتم استرداد إحصاءات البريد الإلكتروني باستخدام domains.domainStats.query.

تتيح لك الطريقة domains.domainStats.query استرداد الإحصاءات على نطاق زمني من خلال تحديد startDate وendDate.

الإصدار 1: domains.trafficStats.get

جافا

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

الإصدار 2: domains.domainStats.query ليوم واحد

لاسترداد الإحصاءات ليوم واحد في الإصدار 2، عليك استدعاء domains.domainStats.query باستخدام startDate وendDate نفسَيهما.

جافا

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

الإصدار 1: domains.trafficStats.list

جافا

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

الإصدار 2: domains.domainStats.query لنطاق زمني

لاسترداد الإحصاءات لنطاق زمني في الإصدار 2، عليك استدعاء domains.domainStats.query باستخدام startDate وendDate.

جافا

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

ميزات الإصدار 2 الجديدة

بالإضافة إلى دمج إحصاءات الزيارات get وlist في query، يقدّم الإصدار 2 الميزات التالية.

استرداد حالة الامتثال

يمكنك استرداد حالة الامتثال لنظام التعرُّف على هوية المُرسِل (SPF) والبريد المُعرَّف بمفاتيح النطاق (DKIM) ومصادقة الرسائل والإبلاغ عنها ومطابقتها استنادًا إلى النطاق (DMARC) لنطاق باستخدام domains.getComplianceStatus.

يمكنك الاطّلاع على استرداد حالة الامتثال لنطاق لمعرفة نموذج الرمز البرمجي.

الاستعلام عن إحصاءات النطاق على شكل دُفعات

يمكنك استرداد إحصاءات نطاقات متعددة باستخدام طلب واحد باستخدام domainStats.batchQuery.