توفّر واجهة برمجة تطبيقات التحقق من صحة العنوان نص استجابة بتنسيق 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
لعنوان
بجودة جيدة، ما يؤدي إلى عرض 4 حقول لهذا الطلب المحدّد:
"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
الجزء الأول.
اطّلِع على الدقة في الدليل المرجعي. |
اكتمال العنوان
يعرض البيان الخاص بالعنوان الخاص بـ 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
إلى الموقع المرمّز جغرافيًا المرتبط بالإدخال.
الخاص بك. تقدّم هذه السمة تفاصيل حول الموقع الجغرافي نفسه، مثل
معرّف مكانه.
اطّلِع على Geocode في الدليل المرجعي. |
السمة metadata
قد لا تتم تعبئة هذه السمة لكل عنوان تتم معالجته من خلال واجهة برمجة تطبيقات التحقق من صحة العناوين، ولكنها تشير إلى ما إذا كان العنوان سكنيًا، أو الشركة أو صندوق البريد.
يُرجى الاطّلاع على تغطية واجهة برمجة التطبيقات للتحقق من صحة العناوين ومرجع Address metadata .
|
السمة uspsData
تقدّم هذه السمة معلومات مفيدة للعناوين البريدية في الولايات المتحدة.
ومع ذلك، ليس مضمونًا أن تتم تعبئتها بالكامل لكل عنوان تم التحقّق من صحته.
حسب الخدمة. لهذا السبب، يجب ألّا تعتمد على هذه السمة على أنّها
فقط التحقق من العناوين، ولكن بدلاً من ذلك، يمكنك التحقق من verdict
address
أيضًا.
يُرجى الاطّلاع على التعامل مع العناوين في الولايات المتحدة ومرجع UspsData .
|