שליחת בקשה לאימות כתובת

מפתחים באזור הכלכלי האירופי (EEA)

כדי לשלוח בקשת Address Validation, שולחים בקשת POST לאחת מנקודות הקצה הבאות:

בנוסף, צריך להעביר לבקשה גוף בקשה בפורמט 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"]
  },
}

בעזרת APIs Explorer אתם יכולים לשלוח בקשות בזמן אמת כדי להכיר את ה-API ואת האפשרויות שלו:

שדות של בקשת כתובת

גוף הבקשה מורכב משדה אחד:

  • ‫address – שדה מסוג PostalAddress, שחייב להכיל לפחות רשומה אחת ב-addressLines.

כששולחים את השדה address ל-Address Validation API, צריך לספק רק שדה אחד: addressLines. עם זאת, בקשת הכתובת הפשוטה ביותר צריכה להכיל את שדות המשנה הבאים:

  • regionCode — מומלץ. השדה הזה אופציונלי, אבל אם משמיטים אותו, Address Validation API מסיק את האזור מהכתובת. עם זאת, כדי לקבל את התוצאות הכי טובות, כדאי לכלול את regionCode אם אתם יודעים אותו. כאן אפשר למצוא את רשימת האזורים הנתמכים.
  • ‫addressLines — חובה. מערך עם כתובות שמתארות את המבנה התחתון של הכתובת.
אפשר לעיין בקטע PostalAddress במדריך העזר.

אפשרות USPS CASS™‎

שירות הדואר של ארצות הברית (USPS®)1 מנהל את מערכת התמיכה לדיוק קידוד (CASS™‎) כדי לתמוך בספקי אימות כתובות ולהעניק להם אישורים.

באזורים בארה"ב ובפוארטו ריקו בלבד, אפשר להפעיל עיבוד CASS על ידי הגדרת enableUspsCass ל-true בגוף הבקשה. כדי לקבל את התוצאות הכי טובות כשמשתמשים ב-CASS, צריך לספק כתובת שכוללת את הרחוב ומספר הבית, יחד עם העיר, המדינה והמיקוד:

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

רוצה לנסות?

ב-APIs Explorer אתם יכולים לשלוח בקשות לדוגמה כדי להכיר את ה-API ואת האפשרויות שהוא מציע.

  1. לוחצים על סמל ה-API‏ api בצד שמאל של הדף.

  2. אפשר לערוך את הפרמטרים של הבקשה.

  3. לוחצים על הכפתור Execute. בתיבת הדו-שיח, בוחרים את החשבון שבו רוצים להשתמש כדי לשלוח את הבקשה.

  4. בחלונית APIs Explorer, לוחצים על סמל המסך המלא fullscreen כדי להרחיב את החלון של APIs Explorer.

  1. Google Maps Platform היא בעלת רישיון לא בלעדי של United States Postal Service®‎. הסימנים המסחריים הבאים נמצאים בבעלות United States Postal Service®‎ והשימוש בהם נעשה באישור: United States Postal Service®‎,‏ CASS™‎, ‏ CASS Certified™‎. ↩