مهاجرت به API نسخه ۲ ابزارهای مدیریت پست

این راهنما تفاوت‌های بین نسخه ۱ و نسخه ۲ رابط برنامه‌نویسی کاربردی ابزارهای مدیریت پست (Postmaster Tools API) و نحوه انتقال برنامه نسخه ۱ به نسخه ۲ را شرح می‌دهد.

نمای کلی

نسخه ۲ رابط برنامه‌نویسی کاربردی ابزارهای مدیریت ایمیل (Postmaster Tools API) چندین ویژگی جدید را معرفی می‌کند و قابلیت‌های موجود برای بازیابی آمار ایمیل را یکپارچه می‌کند. با نسخه ۲، اکنون می‌توانید:

  • به جای هر روز، آمار را بر اساس محدوده‌های زمانی بازیابی کنید.
  • وضعیت انطباق با استانداردهای چارچوب سیاست فرستنده (SPF)، ایمیل شناسایی‌شده با کلیدهای دامنه (DKIM) و احراز هویت، گزارش‌دهی و انطباق پیام مبتنی بر دامنه (DMARC) را جستجو کنید.
  • بازیابی آمار برای چندین دامنه با یک فراخوانی API واحد.

تغییرات کلیدی عبارتند از:

  • منبع trafficStats با domainStats جایگزین شده است.
  • متدهای domains.trafficStats.get و domains.trafficStats.list با یک متد domains.domainStats.query جایگزین شده‌اند.
  • یک متد جدید domains.getComplianceStatus برای بازیابی وضعیت انطباق SPF، DKIM و DMARC برای یک دامنه مشخص در دسترس است.
  • یک متد جدید domainStats.batchQuery برای بازیابی آمار چندین دامنه در یک فراخوانی واحد در دسترس است.
  • اصطلاح «معیارها» که در نسخه ۱ استفاده شده بود، به «آمار» تغییر نام داده است.

به نسخه ۲ به‌روزرسانی کنید

برای مهاجرت از نسخه ۱ به نسخه ۲، باید کتابخانه کلاینت خود را به آخرین نسخه به‌روزرسانی کنید و کد خود را برای استفاده از منابع و متدهای نسخه ۲ اصلاح کنید.

  1. کتابخانه کلاینت API ابزارهای مدیریت پست خود را به نسخه ۲ یا بالاتر به‌روزرسانی کنید.
  2. تمام فراخوانی‌ها از منبع trafficStats را به منبع domainStats تغییر دهید.
  3. هرگونه فراخوانی domains.trafficStats.get یا domains.trafficStats.list را با domains.domainStats.query جایگزین کنید، و پارامترهای startDate و endDate را برای مشخص کردن محدوده تاریخ برای پرس و جو ارائه دهید.

بازیابی آمار ایمیل‌ها

در نسخه ۱، معیارهای ایمیل با استفاده از domains.trafficStats.get برای یک روز یا domains.trafficStats.list برای چندین روز بازیابی می‌شدند. در نسخه ۲، آمار ایمیل با استفاده از domains.domainStats.query بازیابی می‌شود.

متد domains.domainStats.query به شما امکان می‌دهد با مشخص کردن startDate و endDate ، آمار را در یک محدوده تاریخ بازیابی کنید.

نسخه ۱: domains.trafficStats.get

جاوا 

String query = String.format("domains/%s/trafficStats/%s", domainName, date);
TrafficStats trafficStats = service.domains().trafficStats().get(query).execute();

پایتون 

query = 'domains/%s/trafficStats/%s' %(domain_name,date)
traffic_stats = service.domains().trafficStats().get(name=query).execute();

نسخه ۲: domains.domainStats.query برای یک روز

برای بازیابی آمار یک روز در نسخه ۲، تابع 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();

پایتون 

date = {'year': 2024, 'month': 1, 'day': 1}
stats = service.domains().domainStats().query(
    parent='domains/' + domain_name,
    startDate=date,
    endDate=date).execute()

نسخه ۱: domains.trafficStats.list

جاوا 

ListTrafficStatsResponse listTrafficStatsResponse = service.domains().trafficStats().list("domains/" + domainName)
        .execute();

پایتون 

query = 'domains/' + domain_name
list_traffic_stats_response = service.domains().trafficStats().list(parent=query).execute();

نسخه ۲: domains.domainStats.query برای یک محدوده تاریخ

برای بازیابی آمار برای یک محدوده تاریخ در نسخه ۲، تابع 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();

پایتون 

stats = service.domains().domainStats().query(
    parent='domains/' + domain_name,
    startDate={'year': 2024, 'month': 1, 'day': 1},
    endDate={'year': 2024, 'month': 1, 'day': 7}).execute()

ویژگی‌های جدید نسخه ۲

علاوه بر ادغام آمار ترافیک get و list در query ، نسخه ۲ ویژگی‌های زیر را معرفی می‌کند.

بازیابی وضعیت انطباق

شما می‌توانید وضعیت انطباق با استانداردهای «چارچوب سیاست فرستنده» (SPF)، «نامه شناسایی‌شده با کلیدهای دامنه» (DKIM) و «احراز هویت، گزارش‌دهی و انطباق پیام مبتنی بر دامنه» (DMARC) را برای یک دامنه با استفاده از domains.getComplianceStatus بازیابی کنید.

برای نمونه کد، به بازیابی آمار ایمیل مراجعه کنید.

آمار دامنه پرس و جوی دسته‌ای

شما می‌توانید آمار چندین دامنه را با یک فراخوانی واحد با استفاده از domainStats.batchQuery بازیابی کنید.