Postmaster Tools API v2 पर माइग्रेट करना

इस गाइड में, Postmaster Tools API के v1 और v2 के बीच के अंतर के बारे में बताया गया है. साथ ही, इसमें v1 ऐप्लिकेशन को v2 पर माइग्रेट करने का तरीका भी बताया गया है.

खास जानकारी

Postmaster Tools API के वर्शन 2 में कई नई सुविधाएं जोड़ी गई हैं. साथ ही, ईमेल के आंकड़े पाने की मौजूदा सुविधा को बेहतर बनाया गया है. v2 की मदद से, अब ये काम किए जा सकते हैं:

• हर दिन के बजाय, तारीख की सीमाओं के हिसाब से आंकड़े पाएं.
• सेन्डर पालिसी फ़्रेमवर्क (एसपीएफ़), डोमेन-की आइडेंटिफ़ाइड मेल (डीकेआईएम), और डोमेन के हिसाब से मैसेज की पुष्टि, शिकायत, और नियमों का पालन (डीएमएआरसी) के लिए, क्वेरी के अनुपालन की स्थिति.
• एक ही एपीआई कॉल से, कई डोमेन के आंकड़े पाएं.

मुख्य बदलावों में ये शामिल हैं:

• trafficStats संसाधन को domainStats से बदल दिया गया है.
• domains.trafficStats.get और domains.trafficStats.list तरीकों को एक ही domains.domainStats.query तरीके से बदल दिया गया है.
• किसी डोमेन के लिए, SPF, DKIM, और DMARC के अनुपालन की स्थिति पाने के लिए, नई domains.getComplianceStatus विधि उपलब्ध है.
• एक ही कॉल में कई डोमेन के लिए आंकड़े पाने के लिए, एक नया domainStats.batchQuery तरीका उपलब्ध है.
• v1 में इस्तेमाल किए गए "मेट्रिक" शब्द का नाम बदलकर "आंकड़े" कर दिया गया है.

v2 पर अपडेट करना

v1 से v2 पर माइग्रेट करने के लिए, आपको अपनी क्लाइंट लाइब्रेरी को नए वर्शन पर अपडेट करना होगा. साथ ही, v2 के संसाधनों और तरीकों का इस्तेमाल करने के लिए, अपने कोड में बदलाव करना होगा.

1. Postmaster Tools API की क्लाइंट लाइब्रेरी को वर्शन 2 या इसके बाद वाले वर्शन पर अपडेट करें.
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 और endDate तय करके, domains.domainStats.query तरीके से तारीख की सीमा के हिसाब से आंकड़े पाए जा सकते हैं.startDate

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: domains.domainStats.query एक दिन के लिए

v2 में किसी एक दिन के आंकड़े पाने के लिए, domains.domainStats.query को उसी startDate और endDate के साथ कॉल करें.

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 for a date range

v2 में, तारीख की सीमा के लिए आंकड़े पाने के लिए, domains.domainStats.query को startDate और endDate के साथ कॉल करें.

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

v2 की नई सुविधाएं

v2 में, get और list के ट्रैफ़िक के आंकड़ों को query में शामिल करने के साथ-साथ, ये सुविधाएं भी उपलब्ध हैं.

अनुपालन की स्थिति वापस पाना

domains.getComplianceStatus का इस्तेमाल करके, किसी डोमेन के लिए Sender Policy Framework (SPF), DomainKeys Identified Mail (DKIM), और Domain-based Message Authentication, Reporting, and Conformance (DMARC) के नियमों का पालन करने की स्थिति का पता लगाया जा सकता है.

सैंपल कोड के लिए, ईमेल के आंकड़े वापस पाना देखें.

डोमेन के आंकड़ों के लिए बैच क्वेरी

domainStats.batchQuery का इस्तेमाल करके, एक ही कॉल में कई डोमेन के लिए आंकड़े वापस पाए जा सकते हैं.