Address Validation

המחלקה AddressValidation

google.maps.addressValidation.AddressValidation ספריית
הכיתה "addressValidation"

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

const {AddressValidation} = await google.maps.importLibrary("addressValidation");

שיטות סטטיות
fetchAddressValidation	fetchAddressValidation(request) פרמטרים: request: AddressValidationRequest ערך מוחזר: Promise<AddressValidation> מאמת כתובת. מידע נוסף זמין בכתובת https://developers.google.com/maps/documentation/javascript/address-validation/validate-address.

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

Methods
בירושה: toJSON

ממשק AddressValidationRequest

ממשק google.maps.addressValidation.AddressValidationRequest

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

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

מחלקה לכתובת

google.maps.addressValidation.Address ספריית
הכיתה "addressValidation"

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

const {Address} = await google.maps.importLibrary("addressValidation");

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

Methods
בירושה: toJSON

המחלקה AddressComponent

google.maps.addressValidation.AddressComponent ספריית
הכיתה "addressValidation"

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

const {AddressComponent} = await google.maps.importLibrary("addressValidation");

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

AddressMetadata class

google.maps.addressValidation.AddressMetadata ספריית
הכיתה "addressValidation"

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

const {AddressMetadata} = await google.maps.importLibrary("addressValidation");

מאפיינים
business readonly	סוג: boolean
poBox readonly	סוג: boolean
residential readonly	סוג: boolean

Methods
בירושה: toJSON

קבועים של ConfirmationLevel

google.maps.addressValidation.ConfirmationLevel קבועים
ספרייה "addressValidation"

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

אפשר להשתמש בקבועים האלה גם כמחרוזות. ב-TypeScript, המחרוזות המילוליות מוגדרות לפי הסוג ConfirmationLevelString.

const {ConfirmationLevel} = await google.maps.importLibrary("addressValidation");

קבועים
CONFIRMED
UNCONFIRMED_AND_SUSPICIOUS
UNCONFIRMED_BUT_PLAUSIBLE

מחלקה Geocode

google.maps.addressValidation.Geocode ספריית
הכיתה "addressValidation"

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

const {Geocode} = await google.maps.importLibrary("addressValidation");

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

Methods
fetchPlace	fetchPlace() פרמטרים: אין הערך המוחזר: אין מחזירה ייצוג של מקום בקואורדינטות האלה. כדי לקבל את פרטי המקום המלאים, צריך לבצע קריאה ל-place.fetchFields()‎.
בירושה: toJSON

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

google.maps.addressValidation.Granularity קבועים
ספרייה "addressValidation"

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

אפשר להשתמש בקבועים האלה גם כמחרוזות. ב-TypeScript, המחרוזות המילוליות מוגדרות לפי הסוג GranularityString.

const {Granularity} = await google.maps.importLibrary("addressValidation");

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

קבועים של PossibleNextAction

google.maps.addressValidation.PossibleNextAction קבועים
ספרייה "addressValidation"

הערה: זמין רק ב-ערוץ בטא.

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

אפשר להשתמש בקבועים האלה גם כמחרוזות. ב-TypeScript, המחרוזות המילוליות מוגדרות לפי הסוג PossibleNextActionString.

const {PossibleNextAction} = await google.maps.importLibrary("addressValidation");

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

המחלקה USPSAddress

google.maps.addressValidation.USPSAddress ספריית
הכיתה "addressValidation"

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

const {USPSAddress} = await google.maps.importLibrary("addressValidation");

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

Methods
בירושה: toJSON

מחלקה USPSData

google.maps.addressValidation.USPSData ספריית
הכיתה "addressValidation"

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

const {USPSData} = await google.maps.importLibrary("addressValidation");

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

Methods
בירושה: toJSON

Verdict class

google.maps.addressValidation.Verdict ספריית
הכיתה "addressValidation"

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

const {Verdict} = await google.maps.importLibrary("addressValidation");

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