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

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

खास जानकारी

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

  • हर दिन के बजाय, तारीख की सीमाओं के हिसाब से आंकड़े पाना.
  • Sender Policy Framework (SPF), DomainKeys Identified Mail (DKIM) और Domain-based Message Authentication, Reporting, and Conformance (DMARC) के लिए, अनुपालन की स्थिति के बारे में क्वेरी करना.
  • एपीआई को एक बार कॉल करके, एक से ज़्यादा डोमेन के आंकड़े पाना.

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

  • 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 पैरामीटर उपलब्ध कराएं.

ईमेल के आंकड़े पाना

v1 में, ईमेल की मेट्रिक पाने के लिए, एक दिन के लिए domains.trafficStats.get या एक से ज़्यादा दिनों के लिए domains.trafficStats.list का इस्तेमाल किया जाता था. v2 में, ईमेल के आंकड़े पाने के लिए domains.domainStats.query का इस्तेमाल किया जाता है.

domains.domainStats.query तरीके से, startDate और endDate तय करके, तारीख की सीमा के हिसाब से आंकड़े पाए जा सकते हैं.

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 में एक दिन के आंकड़े पाने के लिए, एक ही startDate और endDate के साथ domains.domainStats.query को कॉल करें.

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

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

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 का इस्तेमाल करके, किसी डोमेन के लिए SPF, DKIM, और DMARC के अनुपालन की स्थिति पाई जा सकती है.

सैंपल कोड के लिए, किसी डोमेन के लिए अनुपालन की स्थिति पाना लेख पढ़ें.

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

domainStats.batchQuery का इस्तेमाल करके, एक बार कॉल करके एक से ज़्यादा डोमेन के आंकड़े पाए जा सकते हैं.