पते की पुष्टि से जुड़े बुनियादी जवाब को समझना

पते की पुष्टि करने वाला एपीआई, JSON ऑब्जेक्ट के तौर पर response body उपलब्ध कराता है. इसमें दो टॉप-लेवल प्रॉपर्टी होती हैं:

• result, ValidationResult टाइप का ऑब्जेक्ट
• responseID

{
  "result": {
    // Validation verdict.
    "verdict": {},
    // Address details determined by the API.
    "address": {},
    // The geocode generated for the input address.
    "geocode": {},
    // Information indicating if the address is a business, residence, etc.
    "metadata": {},
    // Information about the address from the US Postal Service
    // ("US" and "PR" addresses only).
    "uspsData": {},
  },
  // A unique identifier generated for every request to the API.
  "responseId": "ID"
}

इस दस्तावेज़ में result ऑब्जेक्ट के बारे में बताया गया है. responseID के बारे में जानकारी के लिए, अपडेट किए गए पतों को मैनेज करना देखें.

verdict प्रॉपर्टी

verdict प्रॉपर्टी, पते की पुष्टि के नतीजों की खास जानकारी देती है. साथ ही, यह पते की जांच करने वाला लॉजिक बनाते समय, आकलन करने वाली पहली प्रॉपर्टी होनी चाहिए. आउटपुट पते की क्वालिटी के आधार पर, प्रॉपर्टी कई तरह के फ़ील्ड दिखा सकती है. उदाहरण के लिए, यहां अच्छी क्वालिटी के पते की verdict प्रॉपर्टी दिखाई गई है. यह इस खास अनुरोध के लिए चार फ़ील्ड दिखाती है:

"verdict": {
  "inputGranularity": "PREMISE",
  "validationGranularity": "PREMISE",
  "geocodeGranularity": "PREMISE",
  "addressComplete": true
}

नीचे दिए गए सेक्शन में, verdict प्रॉपर्टी के सभी फ़ील्ड की खास जानकारी दी गई है.

पते की जानकारी

पते की जानकारी का स्तर, किसी पते या जियोकोड की विशेषता तय करने के लिए इस्तेमाल किए गए ब्यौरे के लेवल से है. validationGranularity रिस्पॉन्स में पते की जानकारी, यह बताने का अहम सिग्नल है कि पते पर डिलीवरी की जा सकती है या नहीं.

verdict प्रॉपर्टी, ज़्यादा जानकारी वाले ये सिग्नल दिखाती है:

• inputGranularity — इससे पता चलता है कि Address Validation API को भेजे गए पते से कितनी जानकारी कैप्चर की गई है. अनुरोध में पते की जानकारी के लेवल का असर, पुष्टि के जवाब में पते की जानकारी के लेवल पर पड़ता है. उदाहरण के लिए, आम तौर पर PREMISE से नीचे inputGranularity वाले पते को validationGranularity से PREMISE लेवल पर नहीं बदला जाता.
• validationGranularity — पते की पुष्टि का वह लेवल जिसके लिए पते की पुष्टि करने वाला एपीआई, पते की पूरी तरह से पुष्टि कर सकता है. ज़्यादातर मामलों में, PREMISE या SUB_PREMISE के ब्यौरे का लेवल, अच्छी क्वालिटी वाले पते को दिखाता है, जो डिलीवर किया जा सकता है.
• geocodeGranularity — पते से जुड़े जियोकोड की जानकारी के लेवल के बारे में बताता है. उदाहरण के लिए, Google के रिकॉर्ड में किसी अपार्टमेंट नंबर की जानकारी हो सकती है, लेकिन बड़े अपार्टमेंट कॉम्प्लेक्स में उस अपार्टमेंट की सटीक जगह की जानकारी नहीं हो सकती. इस मामले में, validationGranularity SUB_PREMISE है, लेकिन geocodeGranularityisPREMISE`.

पता अधूरा है

नतीजा, addressComplete प्रॉपर्टी को अच्छी क्वालिटी वाले पते के सिग्नल के तौर पर दिखाता है. इसका मतलब है कि इसमें कोई कॉम्पोनेंट मौजूद नहीं है, कोई समस्या नहीं है या कोई अनचाहा कॉम्पोनेंट नहीं है:

"verdict": {
    "inputGranularity": "PREMISE",
    "validationGranularity": "PREMISE",
    "geocodeGranularity": "PREMISE",
    "addressComplete": true
}

अगर पते में कोई कॉम्पोनेंट मौजूद नहीं है, हल नहीं हुआ है या अचानक से दिख रहा है, तो फ़ील्ड को false पर सेट किया जाता है.

पते की क्वालिटी

कई संभावित फ़ील्ड, पते के कॉम्पोनेंट से जुड़ी समस्याओं या उनमें किए गए बदलावों के बारे में बताते हैं. जैसे, पते के कॉम्पोनेंट का अनुमान लगाना या उनका मौजूद न होना. उदाहरण के लिए, यहां दी गई verdict प्रॉपर्टी से पता चलता है कि यह एक ऐसा पता है जिसमें पुष्टि नहीं किए गए कॉम्पोनेंट हैं और addressComplete फ़ील्ड मौजूद नहीं है:

"verdict": {
    "inputGranularity": "PREMISE",
    "validationGranularity": "OTHER",
    "geocodeGranularity": "OTHER",
    "hasUnconfirmedComponents": true,
    "hasInferredComponents": true
}

address और addressComponent प्रॉपर्टी

address प्रॉपर्टी, अनुरोध में दिए गए प्रोसेस किए गए पते के लिए फ़ॉर्मैटिंग उपलब्ध कराती है. इसमें पते की खास जानकारी के साथ-साथ कॉम्पोनेंट के लेवल पर खास जानकारी भी शामिल होती है. इसमें पते में गलत स्पेलिंग वाले हिस्से, गलत हिस्से, और ऐसे हिस्से शामिल होते हैं जो मौजूद नहीं हैं.

addressComponent प्रॉपर्टी, address का एक सबकॉम्पोनेंट है. यह उस पते के एलिमेंट या कॉम्पोनेंट की पूरी जानकारी देता है जिसे Address Validation API ने प्रोसेस किया है. एपीआई, हर कॉम्पोनेंट फ़ील्ड की पहचान उसके नाम, टाइप, और पुष्टि के लेवल के हिसाब से करता है.

geocode प्रॉपर्टी

geocode प्रॉपर्टी से, इनपुट पते से जुड़ी जगह की जानकारी मिलती है. इस प्रॉपर्टी में, जगह की जानकारी होती है. जैसे, उसका प्लेस आईडी.

metadata प्रॉपर्टी

हो सकता है कि यह प्रॉपर्टी, पते की पुष्टि करने वाले एपीआई की मदद से प्रोसेस किए गए हर पते के लिए अपने-आप न भर जाए. हालांकि, इससे पता चलता है कि पता घर का है, कारोबार का है या पीओ बॉक्स का.

uspsData प्रॉपर्टी

यह प्रॉपर्टी, अमेरिका के डाक पतों के बारे में काम की जानकारी देती है. हालांकि, इस बात की कोई गारंटी नहीं है कि इस फ़ील्ड में, सेवा की पुष्टि किए गए हर पते के लिए पूरी जानकारी होगी. इसलिए, आपको इस प्रॉपर्टी पर भरोसा नहीं करना चाहिए, क्योंकि यह पतों की पुष्टि करने का एकमात्र तरीका नहीं है. इसके बजाय, verdict और address की भी जांच करें.