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