أرسل طلب التحقق من العنوان عن طريق إصدار طلب POST إلى إحدى نقاط النهاية التالية:
- validateAddress (REST)
- ValidateAddress (gRPC)
يجب أيضًا أن يرسل طلبك نص طلب JSON إلى الطلب الذي يحدّد العنوان المطلوب التحقّق منه. يحتوي نص الطلب التالي على حقل واحد وثلاثة حقول فرعية:
curl -X POST -d '{ "address": { "regionCode": "US", "locality": "Mountain View", "addressLines": ["1600 Amphitheatre Pkwy"] } }' \ -H 'Content-Type: application/json' \ "https://addressvalidation.googleapis.com/v1:validateAddress?key=API_KEY"
يمكنك أيضًا حذف locality
وتحديده كعنصر في مصفوفة addressLines
:
{
"address": {
"regionCode": "US",
"addressLines": ["1600 Amphitheatre Pkwy", "Mountain View, CA, 94043"]
},
}
حقول طلب العناوين
يتكون نص الطلب من حقل واحد:
address
— حقل من النوعPostalAddress
، والذي يجب أن يحتوي على إدخال واحد على الأقل فيaddressLines
.
عند إرسال الحقل address
إلى واجهة برمجة تطبيقات التحقّق من صحة العنوان، عليك توفير حقل واحد فقط: addressLines
. ومع ذلك، يجب أن يحتوي أبسط طلب عنوان
على الحقول الفرعية التالية:
regionCode
: يُنصَح بها. هذا حقل اختياري، ولكن في حال حذفه، تستنتج واجهة برمجة التطبيقات التحقّق من صحة العنوان المنطقة من العنوان. في المقابل، للحصول على أفضل النتائج، أدرِج السمةregionCode
إذا كنت تعرفها. للحصول على قائمة المناطق المتاحة، يُرجى الاطّلاع على المناطق التي يتوفّر فيها التطبيق.addressLines
: مطلوبة. صفيف يحتوي على عناوين تصف الهيكل السفلي للعنوان.
يُرجى الاطّلاع على PostalAddress في الدليل المرجعي. |
خيار USPS CASSTM
توفّر خدمة ®البريد الإلكتروني (USPS®) التابعة للولايات المتحدة (USPS®)1 نظام دعم دقة الترميز (CASSTM) لدعم مقدّمي خدمات التحقّق من صحة العنوان واعتمادهم.
يمكنك تفعيل معالجة CASS في الولايات المتحدة وPR من خلال ضبط
enableUspsCass
على true
في نص الطلب. للحصول على أفضل النتائج عند استخدام CASS، قدم عنوانًا يتضمن رقم الشارع والشارع مع المدينة والولاية والرمز البريدي:
{
"address": {
"regionCode": "US",
"locality": "Mountain View",
"administrativeArea": "CA",
"postalCode": "94043",
"addressLines": ["1600 Amphitheatre Pkwy"]
},
"enableUspsCass": true
}
-
"منصة خرائط Google" هي "منصة خرائط Google" جهة مرخَّص لها غير حصرية في الولايات المتحدة. وترتبط العلامات التجارية التالية بخدمة ®Postal Service بالولايات المتحدة، ويتم استخدامها بموجب إذن: ®Postal Service وCASSTM وCASS CertificateTM. ↩