Address Validation

המחלקה AddressValidation

מחלקה google.maps.addressValidation.AddressValidation

מחלקה סטטית לגישה לממשקי ה-API של AddressValidation.

כדי לקבל גישה, צריך לקרוא ל: const {AddressValidation} = await google.maps.importLibrary("addressValidation").
מידע נוסף מופיע בדף ספריות ב-Maps JavaScript API.

fetchAddressValidation
fetchAddressValidation(request)
פרמטרים: 
ערך מוחזר:  Promise<AddressValidation>
address
סוג:  Address optional
מידע על הכתובת עצמה, בניגוד לקואורדינטות.
geocode
סוג:  Geocode optional
מידע על המיקום והמקום שהכתובת הומרה אליהם.
metadata
סוג:  AddressMetadata optional
מידע אחר שרלוונטי ליכולת המסירה. לא מובטח שהשדה metadata יאוכלס במלואו בכל כתובת שנשלחת אל Address Validation API.
responseId
סוג:  string optional
ה-UUID שמזהה את התשובה הזו. אם צריך לאמת מחדש את הכתובת, ה-UUID הזה חייב להופיע בבקשה החדשה.
uspsData
סוג:  USPSData optional
סימונים נוספים של יכולת מסירה שסופקו על ידי USPS. השירות ניתן רק באזורים US ו-PR.
verdict
סוג:  Verdict optional
סימונים של קביעת התקינות הכוללת
toJSON
toJSON()
פרמטרים:  אין
ערך מוחזר:  Object
ממירה את המחלקה AddressValidation לאובייקט JSON עם אותם מאפיינים.

ממשק AddressValidationRequest

ממשק google.maps.addressValidation.AddressValidationRequest

ממשק הבקשה של AddressValidation.fetchAddressValidation.

address
הכתובת שמאמתים. צריך לשלוח כתובות לא מעוצבות דרך PostalAddress.addressLines.
placeAutocompleteElement optional
סוג:  PlaceAutocompleteElement optional
אם משתמשים ב-PlaceAutocompleteElement, צריך לכלול אותו כאן כדי לקשר את הקריאות ל-AddressValidation API לטוקן לסשן של ההשלמה האוטומטית.
previousResponseId optional
סוג:  string optional
אסור להגדיר את השדה הזה בבקשה הראשונה לאימות הכתובת. אם נדרשות בקשות נוספות כדי לאמת באופן מלא כתובת אחת (לדוגמה, אם צריך לאמת מחדש את השינויים שהמשתמש מבצע אחרי האימות הראשוני), אז כל בקשת מעקב חייבת לאכלס את השדה הזה ב-AddressValidation.responseId מהתגובה הראשונה ברצף האימות.
sessionToken optional
סוג:  AutocompleteSessionToken optional
טוקן שמזהה סשן של השלמה אוטומטית לצורכי חיוב.
uspsCASSEnabled optional
סוג:  boolean optional
הפעלת מצב תואם ל-USPS CASS. השינוי הזה משפיע רק על השדה AddressValidation.uspsData של AddressValidation. הערה: בבקשות שמופעל בהן USPS CASS לכתובות בפוארטו ריקו, צריך לספק PostalAddress.regionCode של address בתור "PR", או PostalAddress.administrativeArea של address בתור "Puerto Rico" (לא תלוי-רישיות) או "PR".

מחלקה לכתובת

מחלקה google.maps.addressValidation.Address

פרטי הכתובת אחרי העיבוד. העיבוד לאחר השליחה כולל תיקון של שגיאות איות בכתובת, החלפה של חלקים שגויים והסקת חלקים חסרים.

כדי לקבל גישה, צריך לקרוא ל: const {Address} = await google.maps.importLibrary("addressValidation").
מידע נוסף מופיע בדף ספריות ב-Maps JavaScript API.

components
רכיבי הכתובת הנפרדים של הכתובת המתוקנת והמעוצבת, יחד עם פרטי האימות. כאן אפשר לראות מידע על סטטוס האימות של הרכיבים השונים.
formattedAddress
סוג:  string optional
הכתובת אחרי העיבוד, בפורמט של כתובת בשורה אחת לפי כללי הפורמט של הכתובות באזור שבו הכתובת נמצאת.
missingComponentTypes
סוג:  Array<string>
סוגי הרכיבים שהיו אמורים להיות בכתובת למשלוח דואר בפורמט תקין, אבל לא נמצאו בקלט ולא ניתן היה להסיק אותם. רכיבים מהסוג הזה לא קיימים ב-formatted_address, ב-postal_address או ב-address_components. לדוגמה, ['street_number', 'route'] לקלט כמו "Boulder, Colorado, 80301, USA". כאן אפשר למצוא רשימה של סוגי המידע האפשריים.
postalAddress
סוג:  PostalAddress optional
הכתובת שעברה עיבוד, מיוצגת ככתובת למשלוח דואר.
unconfirmedComponentTypes
סוג:  Array<string>
סוגי הרכיבים שקיימים ב-address_components אבל לא ניתן לאשר שהם תקינים. השדה הזה מסופק מטעמי נוחות: התוכן שלו שווה ערך לחזרה על address_components כדי למצוא את הסוגים של כל הרכיבים שבהם AddressComponent.confirmationLevel הוא לא ConfirmationLevel.CONFIRMED או שהדגל AddressComponent.inferred לא מוגדר כ-true. כאן אפשר למצוא רשימה של סוגי המידע האפשריים.
unresolvedTokens
סוג:  Array<string>
כל הטוקנים בקלט שלא ניתן היה לפתור. יכול להיות שמדובר בקלט שלא זוהה כחלק תקין של כתובת (לדוגמה, בקלט כמו "‎123235253253 Main St, San Francisco, CA, 94105", האסימונים שלא נפתרו עשויים להיראות כמו ["123235253253"] כי זה לא נראה כמו מספר בית תקין.

המחלקה AddressComponent

מחלקה google.maps.addressValidation.AddressComponent

מייצג רכיב אחד של כתובת (למשל, שם רחוב, עיר).

כדי לקבל גישה, צריך לקרוא ל: const {AddressComponent} = await google.maps.importLibrary("addressValidation").
מידע נוסף מופיע בדף ספריות ב-Maps JavaScript API.

componentName
סוג:  string optional
הטקסט של שם הרכיב. לדוגמה, "רחוב הרצל" כשם הרחוב או "1253" כמספר הבית.
componentNameLanguageCode
סוג:  string optional
קוד השפה בתקן BCP-47. השדה הזה לא יופיע אם שם הרכיב לא משויך לשפה, כמו מספר בית.
componentType
סוג:  string optional
הסוג של רכיב הכתובת. רשימה של סוגים אפשריים מופיעה בטבלה 2: סוגים נוספים שמוחזרים על ידי שירות Places.
confirmationLevel
סוג:  ConfirmationLevel optional
מציין את רמת הוודאות שהרכיב נכון.
inferred
סוג:  boolean
אם המאפיין מוגדר בתור true, הרכיב הזה לא היה חלק מהקלט, אלא הוסק לגבי מיקום הכתובת. מומלץ לכלול את הרכיב הזה כדי שהכתובת תהיה מלאה.
replaced
סוג:  boolean
מציין ששם הרכיב הוחלף בשם אחר לגמרי. לדוגמה, החלפת מיקוד שגוי במיקוד הנכון של הכתובת. זה לא שינוי קוסמטי, רכיב הקלט הוחלף ברכיב אחר.
spellCorrected
סוג:  boolean
מציין תיקון של שגיאת כתיב בשם הרכיב. ה-API לא תמיד מסמן שינויים מגרסת איות אחת לאחרת, כמו "centre" ל-"center".
unexpected
סוג:  boolean
אם הערך הוא true, הרכיב הזה לא צפוי להופיע בכתובת דואר באזור הנתון. הוא נשמר רק כי הוא היה חלק מהקלט.

AddressMetadata class

מחלקה google.maps.addressValidation.AddressMetadata

המטא-נתונים של הכתובת. לא מובטח ש-AddressMetadata יאוכלס במלואו לכל כתובת שנשלחת אל Address Validation API.

כדי לקבל גישה, צריך לקרוא ל: const {AddressMetadata} = await google.maps.importLibrary("addressValidation").
מידע נוסף מופיע בדף ספריות ב-Maps JavaScript API.

business
סוג:  boolean
poBox
סוג:  boolean
residential
סוג:  boolean

קבועים של ConfirmationLevel

google.maps.addressValidation.ConfirmationLevel קבועים

הערכים האפשריים השונים שמציינים את רמת הוודאות שהרכיב נכון.

כדי לקבל גישה, צריך לקרוא ל: const {ConfirmationLevel} = await google.maps.importLibrary("addressValidation").
מידע נוסף מופיע בדף ספריות ב-Maps JavaScript API.

CONFIRMED
UNCONFIRMED_AND_SUSPICIOUS
UNCONFIRMED_BUT_PLAUSIBLE

מחלקה Geocode

מחלקה google.maps.addressValidation.Geocode

מכיל מידע על המקום שאליו הומרו הקואורדינטות של הקלט.

כדי לקבל גישה, צריך לקרוא ל: const {Geocode} = await google.maps.importLibrary("addressValidation").
מידע נוסף מופיע בדף ספריות ב-Maps JavaScript API.

bounds
סוג:  LatLngBounds optional
הגבולות של המקום שהכתובת שלו הומרה לקואורדינטות.
featureSizeMeters
סוג:  number optional
גודל המקום שהכתובת שלו הומרה לקואורדינטות, במטרים. זהו מדד נוסף לרמת הדיוק של המיקום שנקבע באמצעות המרת כתובות לקואורדינטות, אבל בגודל פיזי ולא במשמעות סמנטית.
location
סוג:  LatLngAltitude optional
המיקום של הקלט שהומר לקואורדינטות.
placeId
סוג:  string optional
מזהה המקום של המקום שהומרה לו הכתובת לקואורדינטות. עדיף להשתמש במקום מאשר בכתובות, בקואורדינטות של קו רוחב/קו אורך או ב-Plus Codes. אם משתמשים בקואורדינטות כדי לחשב מסלול נסיעה, הנקודה תמיד תתחבר לכביש שהכי קרוב לקואורדינטות האלה. יכול להיות שהכביש הזה לא יוביל ליעד במהירות או בבטחה, ושהוא לא קרוב לנקודת גישה לנכס. בנוסף, כשמבצעים המרת קואורדינטות לכתובות, אין ערובה לכך שהכתובת שתתקבל תהיה זהה לכתובת המקורית.
placeTypes
סוג:  Array<string>
סוגי המקומות שהקלט הומר לקואורדינטות שלהם. לדוגמה, ['locality', 'political']. הרשימה המלאה של הסוגים מופיעה במאמרי העזרה של Geocoding API.
plusCode
סוג:  PlusCode optional
ה-Plus Code שתואם ל-location.
fetchPlace
fetchPlace()
פרמטרים:  אין
ערך מוחזר:  אין
מחזירה ייצוג של מקום בקואורדינטות האלה. כדי לקבל את פרטי המקום המלאים, צריך לבצע קריאה ל-place.fetchFields()‎.

קבועים של רמת פירוט

google.maps.addressValidation.Granularity קבועים

רמות הפירוט השונות שיכולות להיות לכתובת או לקואורדינטות. כשמשתמשים בערכים האלה כדי לציין רמת פירוט של כתובת, הם מציינים עד כמה הכתובת מפורטת כדי לזהות יעד למשלוח דואר. לדוגמה, כתובת כמו "123 Main Street, Redwood City, CA, 94061" מזהה PREMISE, ואילו כתובת כמו "Redwood City, CA, 94061" מזהה LOCALITY. עם זאת, אם לא נמצא קואורדינטות של "רחוב הרצל 123" בתל אביב, יכול להיות שהקואורדינטות שיוחזרו יהיו ברמת הפירוט של LOCALITY, למרות שהכתובת מפורטת יותר.

כדי לקבל גישה, צריך לקרוא ל: const {Granularity} = await google.maps.importLibrary("addressValidation").
מידע נוסף מופיע בדף ספריות ב-Maps JavaScript API.

BLOCK הכתובת או הקואורדינטות מציינות בלוק. משתמשים בו רק באזורים שבהם הכתובות הן ברמת הבלוק, כמו ביפן.
OTHER כל שאר רמות הפירוט, שמקובצות יחד כי אי אפשר להציג אותן.
PREMISE תוצאה ברמת הבניין.
PREMISE_PROXIMITY קואורדינטות שמשוערות למיקום של הכתובת ברמת הבניין.
ROUTE הכתובת או הקואורדינטות מפורטות עד לרמת המסלול, כמו רחוב, כביש או דרך מהירה.
SUB_PREMISE תוצאה ברמה נמוכה יותר מבניין, כמו דירה.

קבועים של PossibleNextAction

google.maps.addressValidation.PossibleNextAction קבועים

סיכום פרשני של התגובה מה-API, שנועד לעזור לכם להחליט מה הפעולה הבאה שכדאי לבצע. השדה הזה נגזר משדות אחרים בתגובה מה-API, ואין להתייחס אליו כערובה לדיוק הכתובת או לאפשרות המסירה.

כדי לקבל גישה, צריך לקרוא ל: const {PossibleNextAction} = await google.maps.importLibrary("addressValidation").
מידע נוסף מופיע בדף ספריות ב-Maps JavaScript API.

ACCEPT התגובה מה-API לא מכילה אותות שמצדיקים את אחד מהערכים האחרים של PossibleNextAction. אתם יכולים להשתמש בכתובת שעברה עיבוד בלי לבקש מהלקוח להזין אותה שוב, אבל זה לא מבטיח שהכתובת תקינה, ויכול להיות שהיא עדיין תכלול תיקונים. אתם צריכים להחליט אם ואיך להציג בקשה ללקוח, בהתאם להערכת הסיכונים שלכם.
CONFIRM שדה אחד או יותר בתגובה מה-API מצביע על בעיות קלות פוטנציאליות בכתובת שעברה עיבוד, לדוגמה רכיב הכתובת postal_code היה replaced. בקשה מהלקוח לבדוק את הכתובת יכולה לעזור לשפר את איכות הכתובת.
CONFIRM_ADD_SUBPREMISES התגובה מה-API מציינת שיכול להיות שחסר משנה-מבנה בכתובת שעברה עיבוד. כדי לשפר את איכות הכתובת, אפשר לבקש מהלקוח לבדוק את הכתובת ולשקול להוסיף מספר דירה. יכול להיות שיהיו בכתובת המעובדת גם בעיות קלות אחרות. הערה: ערך ה-enum הזה יכול להיות מוחזר רק לכתובות בארה"ב.
FIX שדה אחד או יותר בתגובה מה-API מצביע על בעיה אפשרית בכתובת שעברה עיבוד, למשל verdict.validation_granularity הוא OTHER. אם תבקשו מהלקוחות לערוך את הכתובת, זה יכול לעזור לשפר את איכות הכתובת.

המחלקה USPSAddress

מחלקה google.maps.addressValidation.USPSAddress

הייצוג של כתובת בארה"ב לפי USPS.

כדי לקבל גישה, צריך לקרוא ל: const {USPSAddress} = await google.maps.importLibrary("addressValidation").
מידע נוסף מופיע בדף ספריות ב-Maps JavaScript API.

city
סוג:  string optional
שם העיר.
cityStateZipAddressLine
סוג:  string optional
שורת הכתובת שמכילה את העיר, המדינה והמיקוד.
firm
סוג:  string optional
שם החברה.
firstAddressLine
סוג:  string optional
השורה הראשונה של הכתובת.
secondAddressLine
סוג:  string optional
השורה השנייה של הכתובת.
state
סוג:  string optional
קוד המדינה בן 2 אותיות.
urbanization
סוג:  string optional
שם האזור העירוני בפורטו ריקו.
zipCode
סוג:  string optional
המיקוד, למשל "10009".
zipCodeExtension
סוג:  string optional
התוסף בן 4 הספרות של המיקוד, למשל "5023".

מחלקה USPSData

מחלקה google.maps.addressValidation.USPSData

נתוני USPS של הכתובת. לא מובטח ש-USPSData יאוכלס במלואו לכל כתובת בארה"ב או בפורטו ריקו שנשלחת אל Address Validation API. אם אתם משתמשים ב-uspsData כחלק העיקרי של התגובה, מומלץ לשלב בתגובה את שדות הכתובת לגיבוי.

כדי לקבל גישה, צריך לקרוא ל: const {USPSData} = await google.maps.importLibrary("addressValidation").
מידע נוסף מופיע בדף ספריות ב-Maps JavaScript API.

abbreviatedCity
סוג:  string optional
שם העיר בקיצור.
addressRecordType
סוג:  string optional
סוג רשומת הכתובת שתואמת לכתובת שהוזנה.
carrierRoute
סוג:  string optional
קוד המסלול של חברת התובלה. קוד בן ארבעה תווים שמורכב מקידומת של אות אחת ומזהה מסלול בן שלוש ספרות.
carrierRouteIndicator
סוג:  string optional
אינדיקטור למיון תעריפים של מסלולי חברות תובלה.
cassProcessed
סוג:  boolean
אינדיקטור לכך שהבקשה עברה עיבוד CASS.
county
סוג:  string optional
שם המחוז.
deliveryPointCheckDigit
סוג:  string optional
ספרת הביקורת של נקודת המסירה. המספר הזה מתווסף לסוף של delivery_point_barcode בדואר שנסרק באופן מכני. כשמחברים את כל הספרות של delivery_point_barcode, ספרת ביקורת של נקודת מסירה, המיקוד ו-ZIP+4, התוצאה צריכה להיות מספר שמתחלק ב-10.
deliveryPointCode
סוג:  string optional
קוד נקודת המסירה בן 2 ספרות.
dpvCMRA
סוג:  string optional
מציין אם הכתובת היא CMRA (סוכנות מסחרית לקבלת דואר) – עסק פרטי שמקבל דואר עבור לקוחות. מחזירה תו בודד.
dpvConfirmation
סוג:  string optional
הערכים האפשריים לאישור DPV. הפונקציה מחזירה תו בודד או לא מחזירה ערך.
dpvDoorNotAccessible
סוג:  string optional
הסימון מציין כתובות שבהן שירות הדואר של ארה"ב (USPS) לא יכול לדפוק על הדלת כדי למסור דואר. מחזירה תו בודד.
dpvDrop
סוג:  string optional
הדגל מציין שהדואר נמסר לתיבה אחת באתר. מחזירה תו בודד.
dpvEnhancedDeliveryCode
סוג:  string optional
מציין שיותר מקוד החזרה אחד של DPV תקף לכתובת. מחזירה תו בודד.
dpvFootnote
סוג:  string optional
הערות השוליים מאימות נקודת המסירה. אפשר לשרשר כמה הערות שוליים באותה מחרוזת.
dpvNonDeliveryDays
סוג:  string optional
הסימון מציין שאין משלוחי דואר בכל יום בשבוע. מחזירה תו בודד.
dpvNonDeliveryDaysValues
סוג:  number optional
מספר שלם שמזהה ימים שבהם אין משלוחים. אפשר לבדוק את זה באמצעות דגלי ביטים: 0x40 – יום ראשון הוא יום שאין בו משלוחים 0x20 – יום שני הוא יום שאין בו משלוחים 0x10 – יום שלישי הוא יום שאין בו משלוחים 0x08 – יום רביעי הוא יום שאין בו משלוחים 0x04 – יום חמישי הוא יום שאין בו משלוחים 0x02 – יום שישי הוא יום שאין בו משלוחים 0x01 – יום שבת הוא יום שאין בו משלוחים
dpvNoSecureLocation
סוג:  string optional
הסימון מציין שהדלת נגישה, אבל החבילה לא תושאר בגלל חששות בנוגע לאבטחה. מחזירה תו בודד.
dpvNoStat
סוג:  string optional
מציין אם הכתובת היא כתובת ללא נתונים סטטיסטיים או כתובת פעילה. כתובות ללא סטטיסטיקה הן כתובות שלא מאוישות באופן קבוע או כתובות ששירות הדואר של ארה"ב (USPS) לא מספק להן שירות. מחזירה תו בודד.
dpvNoStatReasonCode
סוג:  number optional
מציין את סוג ה-NoStat. הפונקציה מחזירה קוד סיבה כמספר שלם.
dpvPBSA
סוג:  string optional
מציין שהכתובת הותאמה לרשומת PBSA. מחזירה תו בודד.
dpvThrowback
סוג:  string optional
מציין שדואר לא נשלח לכתובת הרחוב. מחזירה תו בודד.
dpvVacant
סוג:  string optional
מציין אם הכתובת פנויה. מחזירה תו בודד.
elotFlag
סוג:  string optional
דגל eLOT עולה/יורד (A/D).
elotNumber
סוג:  string optional
מספר Enhanced Line of Travel ‏ (eLOT).
errorMessage
סוג:  string optional
הודעת שגיאה באחזור נתונים של USPS. השדה הזה מאוכלס כשהעיבוד של USPS מושעה בגלל זיהוי של כתובות שנוצרו באופן מלאכותי.
fipsCountyCode
סוג:  string optional
קוד FIPS של המחוז.
hasDefaultAddress
סוג:  boolean
אינדיקטור לכך שנמצאה כתובת ברירת מחדל, אבל קיימות כתובות ספציפיות יותר.
hasNoEWSMatch
סוג:  boolean
אפשר להתאים את הכתובת למשלוח, אבל קובץ ה-EWS מציין שהתאמה מדויקת תהיה זמינה בקרוב.
lacsLinkIndicator
סוג:  string optional
אינדיקטור של LACSLink.
lacsLinkReturnCode
סוג:  string optional
קוד החזרה של LACSLink.
pmbDesignator
סוג:  string optional
מזהה יחידה של PMB (תיבת דואר פרטית).
pmbNumber
סוג:  string optional
מספר תיבת דואר פרטית (PMB).
poBoxOnlyPostalCode
סוג:  boolean
מיקוד של תא דואר בלבד.
postOfficeCity
סוג:  string optional
העיר שבה נמצא סניף הדואר הראשי.
postOfficeState
סוג:  string optional
המדינה של סניף הדואר הראשי.
standardizedAddress
סוג:  USPSAddress optional
כתובת סטנדרטית של USPS.
suiteLinkFootnote
סוג:  string optional
הערות שוליים שנובעות מהתאמה בין רשומת רחוב או בניין רב-קומות לבין מידע על דירה או משרד. אם נמצאה התאמה לשם העסק, המספר המשני מוחזר.

Verdict class

מחלקה google.maps.addressValidation.Verdict

מייצג את הכתובת אחרי העיבוד של הכתובת שסופקה.

כדי לקבל גישה, צריך לקרוא ל: const {Verdict} = await google.maps.importLibrary("addressValidation").
מידע נוסף מופיע בדף ספריות ב-Maps JavaScript API.

addressComplete
סוג:  boolean
הכתובת נחשבת מלאה אם אין בה אסימונים לא פתורים, ואין בה רכיבי כתובת לא צפויים או חסרים. אם לא מוגדר, הערך הוא false. פרטים נוספים מופיעים בשדות Address.missingComponentTypes, Address.unresolvedTokens או AddressComponent.unexpected.
geocodeGranularity
סוג:  Granularity optional
מידע על רמת הפירוט של Geocode. אפשר להבין את זה כמשמעות הסמנטית של רמת הדיוק של המיקום שנקבע באמצעות המרת כתובות לקואורדינטות.
hasInferredComponents
סוג:  boolean
נוסף לפחות רכיב אחד של הכתובת שלא היה בקלט. פרטים נוספים זמינים ב-AddressComponent.
hasReplacedComponents
סוג:  boolean optional
לפחות רכיב אחד של הכתובת הוחלף – פרטים נוספים זמינים ב-AddressComponent.
hasUnconfirmedComponents
סוג:  boolean
אי אפשר לסווג או לאמת לפחות רכיב אחד של הכתובת. פרטים נוספים זמינים ב-AddressComponent.
inputGranularity
סוג:  Granularity optional
רמת הפירוט של הכתובת שהזנתם. זהו התוצאה של ניתוח הכתובת שהוזנה, והיא לא מספקת אותות אימות. אותות אימות מפורטים במאמר validationGranularity.
BetapossibleNextAction
סוג:  PossibleNextAction optional
פעולה אפשרית שכדאי לבצע בהתאם לשדות אחרים בתגובה מה-API. פרטים נוספים מופיעים בכתובת PossibleNextAction.
validationGranularity
סוג:  Granularity optional
רמת הפירוט שבה ה-API יכול לאמת את הכתובת באופן מלא. לדוגמה, אם הערך של validationGranularity הוא PREMISE, אפשר לאמת את כל רכיבי הכתובת ברמה של PREMISE וברמות רחבות יותר.