نقل البيانات إلى الإصدار 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 وطُرق الإصدار 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();

v2: 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.