Address Validation (beta)

AddressValidation class

google.maps.addressValidation.AddressValidation class

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

אפשר להתקשר אל 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 interface

google.maps.addressValidation.AddressValidationRequest ממשק

ממשק בקשות עבור AddressValidation.fetchAddressValidation.

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

כתובת class

google.maps.addressValidation.Address class

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

אפשר להתקשר אל 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 class

google.maps.addressValidation.AddressComponent class

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

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

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

AddressMetadata class

google.maps.addressValidation.AddressMetadata class

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

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

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

ConfirmationLevel constants

google.maps.addressValidation.ConfirmationLevel constants

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

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

CONFIRMED
UNCONFIRMED_AND_SUSPICIOUS
UNCONFIRMED_BUT_PLAUSIBLE

Geocode class

google.maps.addressValidation.Geocode class

מכיל מידע על המקום שאליו הקלט גיאוקודד.

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

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

רמת הפירוט קבועים

google.maps.addressValidation.Granularity constants

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

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

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

PossibleNextAction constants

google.maps.addressValidation.PossibleNextAction constants

סיכום פרשני של התגובה מה-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 class

google.maps.addressValidation.USPSAddress class

ייצוג של כתובת בארה"ב בפורמט של 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 class

google.maps.addressValidation.USPSData class

הנתונים של 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_check_digit, ‏ postal code ו-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 Ascending/Descending (עולה/יורד).
elotNumber
סוג:  string optional
מספר משופר של קו הנסיעה (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
הערות שוליים שנוצרות מהתאמה של רשומה של רחוב או בניין רב-קומות למידע על סוויטה. אם נמצאה התאמה לשם העסק, הפונקציה מחזירה את המספר המשני.

תוצאה סיווג

google.maps.addressValidation.Verdict class

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

אפשר להתקשר אל 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.
possibleNextAction
סוג:  PossibleNextAction optional
פעולה אפשרית נוספת שאפשר לבצע על סמך שדות אחרים בתגובת ה-API. פרטים נוספים מופיעים בכתובת PossibleNextAction.
validationGranularity
סוג:  Granularity optional
רמת הגרנולריות שבה ה-API יכול לאמת את הכתובת באופן מלא. לדוגמה, ערך validationGranularity של PREMISE מציין שאפשר לאמת את כל רכיבי הכתובת ברמה של PREMISE וברמה רחבה יותר.