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