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

أرسِل طلبًا للتحقّق من العنوان من خلال إرسال طلب 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 إلى Address Validation API، ما عليك سوى تقديم حقل واحد: addressLines. ومع ذلك، يجب أن يحتوي أبسط طلب عنوان على الحقول الفرعية التالية:

• regionCode: يُنصح به. هذا الحقل اختياري، ولكن في حال حذفه، تستنتج واجهة برمجة التطبيقات Address Validation API المنطقة من العنوان. ومع ذلك، للحصول على أفضل النتائج، يُرجى تضمين regionCode إذا كان معروفًا لك. للحصول على قائمة المناطق التي تتوفّر فيها الخدمة، يُرجى الاطّلاع على المناطق التي تتوفّر فيها الخدمة.
• addressLines - مطلوب. صفيف يحتوي على عناوين تصف البنية الأدنى للعنوان

اطّلِع على PostalAddress في الدليل المرجعي.

خيار USPS CASS™

تدير شركة United States Postal Service® (USPS®)¹ نظام دعم دقة الترميز (CASS™) لدعم مقدّمي خدمات التحقّق من العناوين واعتمادهم.

في منطقتَي الولايات المتحدة والمقاطعة البرتغالية فقط، يمكنك تفعيل معالجة 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. في لوحة "مستكشف واجهات برمجة التطبيقات"، انقر على رمز التوسيع، ، لتوسيع نافذة "مستكشف واجهات برمجة التطبيقات".