Address Validation API, JSON ऑब्जेक्ट के तौर पर रिस्पॉन्स का मुख्य हिस्सा उपलब्ध कराता है. इसमें दो टॉप लेवल प्रॉपर्टी होती हैं:
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
— इससे, पते की पुष्टि करने वाले एपीआई को भेजे गए पते से कैप्चर की गई जानकारी के लेवल के बारे में पता चलता है. अनुरोध में मौजूद पते की जानकारी का लेवल, पुष्टि के लिए भेजे गए जवाब में मौजूद पते की जानकारी के लेवल पर असर डालता है. उदाहरण के लिए,inputGranularity
वाले पते का लेवलPREMISE
से कम होने पर, आम तौर परvalidationGranularity
सेPREMISE
लेवल नहीं मिलता है.validationGranularity
— पते की पुष्टि का वह लेवल जिसके लिए पते की पुष्टि करने वाला एपीआई, पते की पूरी तरह से पुष्टि कर सकता है. ज़्यादातर मामलों में,PREMISE
याSUB_PREMISE
के ब्यौरे का लेवल, अच्छी क्वालिटी वाले पते को दिखाता है, जो डिलीवर किया जा सकता है.geocodeGranularity
— इससे पते से जुड़े जियोकोड की जानकारी के बारे में पता चलता है. उदाहरण के लिए, Google रिकॉर्ड किसी अपार्टमेंट नंबर की मौजूदगी का संकेत दे सकते हैं, लेकिन किसी बड़े अपार्टमेंट कॉम्प्लेक्स में उस खास अपार्टमेंट की सटीक जगह की जानकारी नहीं दे सकते. इस मामले में,validationGranularity
,SUB_PREMISE
है, लेकिनgeocodeGranularity
is
PREMISE`.
रेफ़रंस गाइड में, जानकारी का लेवल देखें. |
पता अधूरा है
नतीजा, अच्छी क्वालिटी वाले पते के सिग्नल के तौर पर addressComplete
प्रॉपर्टी दिखाता है. इसका मतलब है कि इसमें कोई भी कॉम्पोनेंट मौजूद नहीं है, जिसे ठीक नहीं किया गया है या जिसकी उम्मीद नहीं थी:
"verdict": {
"inputGranularity": "PREMISE",
"validationGranularity": "PREMISE",
"geocodeGranularity": "PREMISE",
"addressComplete": true
}
अगर पते में कोई कॉम्पोनेंट मौजूद नहीं होता है, उसमें समस्या के समाधान मौजूद नहीं होते या ऐसे कॉम्पोनेंट होते हैं जिनकी उम्मीद नहीं थी, तो फ़ील्ड को false
पर सेट कर दिया जाता है.
रेफ़रंस गाइड में, फ़ैसला और पता सेक्शन में जाकर addressComplete के बारे में जानें. |
पते की क्वालिटी
कई संभावित फ़ील्ड, पते के कॉम्पोनेंट की समस्याओं या उनमें हुए बदलावों की ओर इशारा करते हैं. जैसे, पते के कॉम्पोनेंट का अनुमान लगाना या मौजूद नहीं होना. उदाहरण के लिए, नीचे दी गई verdict
प्रॉपर्टी ऐसे पते के बारे में बताती है जिसमें ऐसे कॉम्पोनेंट शामिल हैं जिनकी पुष्टि नहीं हुई है और जिनमें addressComplete
फ़ील्ड मौजूद नहीं है:
"verdict": {
"inputGranularity": "PREMISE",
"validationGranularity": "OTHER",
"geocodeGranularity": "OTHER",
"hasUnconfirmedComponents": true,
"hasInferredComponents": true
}
रेफ़रंस गाइड में फ़ैसला देखें. |
address
और addressComponent
प्रॉपर्टी
address
प्रॉपर्टी, अनुरोध में दिए गए प्रोसेस किए गए पते के लिए फ़ॉर्मैटिंग उपलब्ध कराती है. इसमें पते की खास जानकारी के साथ-साथ कॉम्पोनेंट के लेवल पर खास जानकारी भी शामिल होती है. इसमें पते में गलत स्पेलिंग वाले हिस्से, गलत हिस्से, और ऐसे हिस्से शामिल होते हैं जो मौजूद नहीं हैं.
रेफ़रंस गाइड में Address देखें. |
addressComponent
प्रॉपर्टी, address
का एक सबकॉम्पोनेंट है. यह उस पते के एलिमेंट या कॉम्पोनेंट की पूरी जानकारी देता है जिसे Address Validation API ने प्रोसेस किया है. एपीआई हर कॉम्पोनेंट फ़ील्ड के नाम, टाइप, और पुष्टि के लेवल से उनकी पहचान करता है.
रेफ़रंस गाइड में addressComponent देखें. |
geocode
प्रॉपर्टी
geocode
प्रॉपर्टी, इनपुट पते से जुड़ी जियोकोड की गई जगह के बारे में बताती है. यह प्रॉपर्टी, जगह के बारे में जानकारी देती है, जैसे कि इसका जगह का आईडी.
रेफ़रंस गाइड में Geocode देखें. |
metadata
प्रॉपर्टी
हो सकता है कि इस प्रॉपर्टी में, पते की पुष्टि करने वाले एपीआई से प्रोसेस किए गए हर पते के लिए जानकारी अपने-आप न भरी जाए. हालांकि, इससे पता चलता है कि यह पता रिहायशी, कारोबार या पीओ बॉक्स का है या नहीं.
पते की पुष्टि करने वाले एपीआई का कवरेज और Address metadata का रेफ़रंस देखें.
|
uspsData
प्रॉपर्टी
यह प्रॉपर्टी, अमेरिका के डाक पतों के लिए काम की जानकारी देती है.
हालांकि, इस बात की कोई गारंटी नहीं है कि सेवा के ज़रिए पुष्टि किए गए हर पते के लिए यह जानकारी अपने-आप भर जाएगी. इस वजह से, आपको इस प्रॉपर्टी पर भरोसा नहीं करना चाहिए, क्योंकि पतों की पुष्टि करने के लिए सिर्फ़ यही तरीका इस्तेमाल होता है. इसके बजाय, verdict
और address
की जांच भी करें.
अमेरिका के पते मैनेज करें और UspsData का रेफ़रंस देखें.
|