إرسال طلب التحقق من العنوان

يمكنك إرسال طلب للتحقق من العنوان من خلال إصدار طلب 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

تحتفظ مؤسسة Postal Service® (USPS®) ¹ بـ نظام دعم دقة الترميز (CASSTM) لدعم موفّري خدمات التحقّق من العنوان واعتمادهم.

في الولايات المتحدة والولايات المتحدة الأمريكية فقط، يمكنك تفعيل معالجة CASS من خلال ضبط enableUspsCass على true في نص الطلب. للحصول على أفضل النتائج عند استخدام CASS، قدم عنوانًا يتضمن رقم الشارع والشارع بالإضافة إلى المدينة والولاية والرمز البريدي:

{
  "address": {
    "regionCode": "US",
    "locality": "Mountain View",
    "administrativeArea": "CA",
    "postalCode": "94043",
    "addressLines": ["1600 Amphitheatre Pkwy"]
  },
  "enableUspsCass": true
}

تجربة

يتيح لك مستكشف واجهات برمجة التطبيقات تقديم طلبات نموذجية حتى تتعرّف على خيارات واجهة برمجة التطبيقات وواجهة برمجة التطبيقات.

1. انقر على رمز واجهة برمجة التطبيقات، ، على يسار الصفحة.

2. يمكنك اختياريًا توسيع عرض المَعلمات العادية وضبط المَعلمة fields على قناع الحقل.

3. يمكنك تعديل نص الطلب اختياريًا.

4. انقر على الزر تنفيذ. في مربع الحوار، اختر الحساب الذي تريد استخدامه لتقديم الطلب.

5. في لوحة "مستكشف واجهة برمجة التطبيقات"، انقر على رمز التوسيع، ، لتوسيع نافذة مستكشف واجهة برمجة التطبيقات.