पता की पुष्टि करने वाला एपीआई, 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
— इससे पता चलता है कि Address Validation API को भेजे गए पते से कितनी जानकारी कैप्चर की गई है. अनुरोध, पुष्टि के रिस्पॉन्स में पते की जानकारी के लेवल पर असर डालता है. उदाहरण के लिए,PREMISE
से कम केinputGranularity
वाला पता आम तौर पर, लेवल की वजह से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
प्रॉपर्टी, इनपुट से जुड़ी जियोकोड की गई जगह के बारे में बताती है
इससे पहले ही अपने कारोबार के हिसाब से name@yourcompany.com जैसा कोई ईमेल पता बनाएं. यह प्रॉपर्टी, जगह के बारे में जानकारी देती है. जैसे, उसका प्लेस आईडी.
रेफ़रंस गाइड में Geocode देखें. |
metadata
प्रॉपर्टी
हो सकता है कि यह प्रॉपर्टी, पते की पुष्टि करने वाले एपीआई की मदद से प्रोसेस किए गए हर पते के लिए अपने-आप न भर जाए. हालांकि, इससे पता चलता है कि पता घर का है, कारोबार का है या पीओ बॉक्स का.
Address Validation API की कवरेज और Address metadata का रेफ़रंस देखें.
|
uspsData
प्रॉपर्टी
यह प्रॉपर्टी, अमेरिका के डाक पतों के लिए काम की जानकारी देती है.
हालांकि, इस बात की कोई गारंटी नहीं है कि इस फ़ील्ड में, सेवा की पुष्टि किए गए हर पते के लिए पूरी जानकारी होगी. इसलिए, आपको इस प्रॉपर्टी पर
का इस्तेमाल करके पतों की पुष्टि की जा सकती है, लेकिन इसके बजाय verdict
और
address
भी.
अमेरिका के पतों को मैनेज करना और UspsData का रेफ़रंस देखें.
|