Package google.maps.addressvalidation.v1

אינדקס

AddressValidation

השירות לאימות כתובות.

ProvideValidationFeedback

rpc ProvideValidationFeedback(ProvideValidationFeedbackRequest) returns (ProvideValidationFeedbackResponse)

משוב על התוצאה של רצף הניסיונות לאימות. זו צריכה להיות הקריאה האחרונה שבוצעה אחרי רצף של קריאות אימות לאותה כתובת, וצריך להתקשר אליה אחרי שהעסקה תושלם. יש לשלוח את הטופס הזה רק פעם אחת עבור רצף של ValidateAddress הבקשות לאימות מלא של כתובת.
ValidateAddress

rpc ValidateAddress(ValidateAddressRequest) returns (ValidateAddressResponse)

מאמת כתובת.

כתובת

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

שדות
formatted_address

string

הכתובת אחרי עיבוד, בפורמט של כתובת עם שורה אחת לפי כללי הפורמט של הכתובת לפי האזור שבו הכתובת ממוקמת.
postal_address

PostalAddress

הכתובת שאחרי העיבוד מיוצגת ככתובת למשלוח דואר.
address_components[]

AddressComponent

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

רכיבי הכתובות לא מסודרים לפי סדר מסוים. אל מניחים הנחות לגבי סדר רכיבי הכתובת ברשימה.
missing_component_types[]

string

סוגי הרכיבים שהיו אמורים להופיע בכתובת למשלוח דואר בפורמט תקין אבל לא נמצאו בקלט וגם לא ניתן היה להסיק אותם. רכיבים מהסוג הזה לא קיימים ב-formatted_address, ב-postal_address או ב-address_components. לדוגמה, הערך ['street_number', 'route'] יכול להיות קלט כמו "Boulder, Colorado, 80301, USA". רשימה של הסוגים האפשריים מופיעה כאן.
unconfirmed_component_types[]

string

סוגי הרכיבים שקיימים בaddress_components אבל לא ניתן היה לאשר שהם נכונים. מטעמי נוחות: התוכן שלו מקביל לאיטרציה באמצעות address_components כדי למצוא את הסוגים של כל הרכיבים שבהם הערך של confirmation_level אינו CONFIRMED או שהדגל inferred לא מוגדר לערך true. רשימה של הסוגים האפשריים מופיעה כאן.
unresolved_tokens[]

string

כל האסימונים בקלט שלא ניתן לפענח. זה יכול להיות קלט שלא זוהה כחלק מכתובת חוקית (לדוגמה, בקלט כמו "123235253253 Main St, San Francisco, CA, 94105". האסימונים שלא זוהו עשויים להיראות כמו ["123235253253"] כי זה לא נראה כמו מספר בית חוקי.

AddressComponent

מייצג רכיב כתובת, כמו רחוב, עיר או מדינה.

שדות
component_name

ComponentName

השם של הרכיב הזה.
component_type

string

הסוג של רכיב הכתובת. ראו טבלה 2: סוגים נוספים שהוחזרו על ידי שירות 'מקומות' לרשימת הסוגים האפשריים.
confirmation_level

ConfirmationLevel

מציין את רמת הוודאות שיש לנו לגבי כך שהרכיב נכון.
inferred

bool

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

bool

מציין תיקון לשגיאת איות בשם הרכיב. ה-API לא תמיד מסמן שינויים מווריאנט איות אחד לאחר, למשל כשמשנים את 'מרכז' ל'מרכז'. הוא גם לא תמיד מסמן שגיאות כתיב נפוצות, כמו שינוי של "Amphitheater Pkwy" ל-"Amphitheatre Pkwy".
replaced

bool

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

bool

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

ConfirmationLevel

הערכים האפשריים השונים של רמות האישור.

טיפוסים בני מנייה (enum)
CONFIRMATION_LEVEL_UNSPECIFIED ערך ברירת המחדל. הערך הזה לא בשימוש.
CONFIRMED הצלחנו לוודא שהרכיב הזה קיים ושהוא הגיוני בהקשר של שאר הכתובת.
UNCONFIRMED_BUT_PLAUSIBLE לא ניתן היה לאמת את הרכיב הזה, אבל סביר להניח שהוא קיים. לדוגמה, מספר בית שנמצא בטווח חוקי ידוע של מספרים ברחוב שבו מספרי בתים מסוימים לא ידועים.
UNCONFIRMED_AND_SUSPICIOUS הרכיב הזה לא אושר וסביר להניח שהוא שגוי. לדוגמה, שכונה שלא מתאימה לשאר הכתובת.

AddressMetadata

המטא-נתונים של הכתובת. לא מובטח שהשדה metadata יאוכלס במלואו בכל כתובת שנשלחת ל-API לאימות כתובת.

שדות
business

bool

מציין שזו כתובת של עסק. אם המדיניות לא מוגדרת, הערך מציין שהערך לא ידוע.
po_box

bool

מציין שהכתובת של תא דואר. אם המדיניות לא מוגדרת, הערך מציין שהערך לא ידוע.
residential

bool

מציין שזו כתובת מגורים. אם המדיניות לא מוגדרת, הערך מציין שהערך לא ידוע.

ComponentName

wrapper לשם הרכיב.

שדות
text

string

הטקסט של השם. לדוגמה, 'השדרה 5' לשם רחוב או '1253' למספר בית.
language_code

string

קוד השפה BCP-47. המידע הזה לא יופיע אם שם הרכיב לא משויך לשפה, כמו מספר בית.

קואורדינטות

מכיל מידע על המקום שאליו בוצע הקידוד הגיאוגרפי של הקלט.

שדות
location

LatLng

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

עדיף להשתמש במזהי מקומות על פני כתובות, קואורדינטות של קווי אורך ורוחב או קודי OLC. שימוש בקואורדינטות בעת ניתוב או חישוב מסלול נסיעה יגרום תמיד להצמדה של הנקודה לכביש הקרוב ביותר לקואורדינטות האלה. זה לא יכול להיות כביש שיוביל במהירות או בבטחה ליעד, ולא יכול להיות ליד נקודת גישה לנכס. בנוסף, כשמיקום מקודד בקידוד גיאוגרפי הפוך, לא מובטח שהכתובת שהוחזרה תתאים לכתובת המקורית.
plus_code

PlusCode

ה-Plus Code של location.
bounds

Viewport

גבולות המקום המקדים.
feature_size_meters

float

גודל המקום עם הקואורדינטות, במטרים. זה מדד נוסף של גסות המיקום הגיאוגרפי שמזינים בו את הקוד, אבל בגודלו הפיזי ולא במשמעות הסמנטית.
place_id

string

ה-PlaceID של המקום שאליו מתבצעת הקידוד הגיאוגרפי של הקלט הזה.

מידע נוסף על מזהי מקומות זמין כאן.
place_types[]

string

סוגי המקומות שהקלט ביצע להם קידוד גיאוגרפי. לדוגמה, ['locality', 'political']. רשימת הסוגים המלאה זמינה כאן.

LanguageOptions

תצוגה מקדימה: התכונה הזו נמצאת ב'תצוגה מקדימה' (pre-GA). יכול להיות שהתמיכה במוצרים ובתכונות טרום-GA תהיה מוגבלת, ויכול להיות ששינויים במוצרים ובתכונות טרום-GA לא יתאימו לגרסאות אחרות של טרום-GA. מוצרים במצב טרום-זמינות לכלל המשתמשים כפופים לתנאים הספציפיים לשירות של הפלטפורמה של מפות Google. מידע נוסף זמין במאמר תיאורים של שלבי ההשקה.

הפעלת ה-API לאימות כתובת כדי לכלול מידע נוסף בתשובה.

שדות
return_english_latin_address

bool

תצוגה מקדימה: החזרת google.maps.addressvalidation.v1.Address באנגלית. אתה יכול לראות עוד פרטים בכתובת google.maps.addressvalidation.v1.ValidationResult.english_latin_address.

PlusCode

Plus Code (http://plus.codes) הוא הפניה למיקום בשני פורמטים: קוד גלובלי שמגדיר 14mx14m (1/8, 000 במעלה) או מלבן קטן יותר, וקוד מורכב שמחליף את הקידומת במיקום של הפניה.

שדות
global_code

string

הקוד הגלובלי (מלא) של המקום, כמו '9FWM33GV+HQ', שמייצג שטח של 1/8,000 על 1/8,000 מעלות (כ-14 על 14 מטרים).
compound_code

string

קוד מורכב של מקום, למשל '33GV+HQ, Rammber, נורבגיה', שמכיל את הסיומת של הקוד הגלובלי ומחליף את הקידומת בשם בפורמט של ישות עזר.

ProvideValidationFeedbackRequest

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

שדות
conclusion

ValidationConclusion

חובה. התוצאה של רצף ניסיונות האימות.

אם קובעים בשדה הזה את הערך VALIDATION_CONCLUSION_UNSPECIFIED, תוחזר השגיאה INVALID_ARGUMENT.
response_id

string

חובה. המזהה של התשובה שהמשוב הזה מיועד לה. הוא אמור להיות [response_id][google.maps.address Validation.v1.VerifyAddressRequest.response_id] מהתגובה הראשונה בסדרה של ניסיונות לאימות כתובת.

ValidationConclusion

התוצאות הסופיות האפשריות של רצף הבקשות לאימות כתובת שנדרשות לאימות כתובת.

טיפוסים בני מנייה (enum)
VALIDATION_CONCLUSION_UNSPECIFIED הערך הזה לא בשימוש. אם קובעים בשדה ProvideValidationFeedbackRequest.conclusion את הערך VALIDATION_CONCLUSION_UNSPECIFIED, תוחזר השגיאה INVALID_ARGUMENT.
VALIDATED_VERSION_USED גרסת הכתובת שהוחזרה על ידי ה-API לאימות כתובת שימשה לעסקה.
USER_VERSION_USED גרסת הכתובת שסופקה על ידי המשתמש שימשה לעסקה
UNVALIDATED_VERSION_USED נעשה שימוש בגרסה של הכתובת שהוזנה אחרי ניסיון האימות האחרון, אבל לא אומתה מחדש, עבור העסקה.
UNUSED העסקה ננטשה ולא נעשה שימוש בכתובת.

ProvideValidationFeedbackResponse

אין שדות בסוג הזה.

התשובה למשוב על האימות.

אם המשוב נשלח בהצלחה, התגובה תהיה ריקה.

UspsAddress

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

שדות
first_address_line

string

שורת כתובת ראשונה.
firm

string

שם החברה.
second_address_line

string

שורת כתובת שנייה.
urbanization

string

שם העיור.
city_state_zip_address_line

string

עיר + מדינה + מיקוד.
city

string

שם העיר.
state

string

קוד מדינה בן 2 אותיות.
zip_code

string

מיקוד, למשל 10009.
zip_code_extension

string

סיומת בן 4 ספרות למיקוד, למשל: 5023.

UspsData

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

שדות
standardized_address

UspsAddress

כתובת סטנדרטית של USPS.
delivery_point_code

string

קוד נקודת מסירה בן 2 ספרות
delivery_point_check_digit

string

ספרת הביקורת של נקודת המסירה. המספר הזה מתווסף לסוף ה-delivery_point_barcode עבור דואר שנסרק באופן מכני. בחיבור כל הספרות של ה-delivery_point_barcode, delivery_point_check_digital, המיקוד וה-ZIP+4 אמורה להניב מספר שמתחלק ב-10.
dpv_confirmation

string

הערכים האפשריים לאישור DPV. מחזירה תו יחיד או לא מחזירה ערך.

  • N: נכשל אישור ה-DPV של פרטי המספר הראשי והפרטים המשניים.
  • D: הכתובת אושרה ל-DPV עבור המספר הראשי בלבד, ופרטי המספר המשני היו חסרים.
  • S: הכתובת אושרה DPV עבור המספר הראשי בלבד, ופרטי המספר המשני קיימים אבל לא אושרו.
  • Y: הכתובת אושרה ל-DPV למספר הראשי ולמספרים משניים.
  • ריקה: אם התשובה לא מכילה ערך dpv_confirmation, הכתובת לא נשלחה לאישור DPV.
dpv_footnote

string

הערות השוליים מאימות נקודת המסירה. ניתן להצמיד כמה הערות שוליים באותה מחרוזת.

  • AA: כתובת הקלט תואמת לקובץ ה-ZIP+4
  • A1: כתובת הקלט לא הותאמה לקובץ ZIP+4
  • BB: תואם ל-DPV (כל הרכיבים)
  • CC: אין התאמה למספר משני ולא נדרש
  • C1: אין התאמה למספר משני אבל נדרש
  • N1: בכתובת של רב קומות חסר מספר משני
  • M1: חסר מספר ראשי
  • M3: מספר ראשי לא חוקי
  • P1: חסר מספר הזמנת רכש, RR או תיבת מרכז העזרה של הכתובת
  • P3: מספר לא חוקי של כתובת הזמנת רכש, RR או תיבת מרכז העזרה
  • F1: כתובת הקלט הותאמה לכתובת צבאית
  • G1: כתובת הקלט שהוזנה לכתובת כללית למשלוח
  • U1: כתובת הקלט תואמת למיקוד ייחודי
  • PB: כתובת הקלט הותאמה לרשומת PBSA
  • RR: כתובת מאושרת של DPV עם פרטי PMB
  • R1: כתובת מאושרת של DPV ללא פרטי PMB
  • R7: רשומת R777 או רשומת R779 של ספק הסלולר
  • IA: זוהתה כתובת מאושרת
  • TA: המספר הראשי תואם על ידי השמטת אלפא בסוף
dpv_cmra

string

מציין אם הכתובת היא CMRA (סוכנות לקבלת דואר מסחרי) – עסק פרטי שמקבל דואר עבור לקוחות. מחזירה תו יחיד.

  • Y: הכתובת היא CMRA
  • N: הכתובת אינה CMRA
dpv_vacant

string

המקום הזה ריק? מחזירה תו יחיד.

  • Y: הכתובת ריקה
  • N: הכתובת לא ריקה
dpv_no_stat

string

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

  • Y: הכתובת לא פעילה
  • N: הכתובת פעילה
dpv_no_stat_reason_code

int32

מציין את הסוג NoStat. הפונקציה מחזירה את קוד הסיבה בפורמט int.

  • 1: IDA (כתובת מסירה פנימית) – כתובות שלא מקבלות אימייל ישירות מה-USPS אבל נמסרות לכתובת שנותנת שירות.
  • 2: תקליטורי CDS – כתובות שעדיין לא ניתן להעביר. לדוגמה, חלוקת משנה חדשה שבה הוגדרו חלקות ומספרים ראשיים, אבל עדיין לא קיים מבנה לתפוסה.
  • 3: התנגשות – כתובות שלא בוצע אישור של DPV בפועל.
  • 4: CMZ (מכללה, צבא וסוגים אחרים) – רשומות ZIP + 4 רשומות USPS שילבו בנתונים.
  • 5: רגילה – מציין כתובות שלא מקבלות משלוח, והכתובות לא נספרות כמשלוחים אפשריים.
  • 6: שדה חובה משני – הכתובת מחייבת מידע משני.
dpv_drop

string

דגל מציין שהאימייל נמסר לנמען אחד באתר. מחזירה תו יחיד.

  • Y: הדואר נמסר לנמען אחד באתר.
  • N: הדואר לא נמסר לנמען אחד באתר.
dpv_throwback

string

מציין שהדואר לא נמסר לכתובת. מחזירה תו יחיד.

  • Y: הדואר לא נמסר לכתובת.
  • N: הדואר נמסר לכתובת.
dpv_non_delivery_days

string

דגל מציין כי שליחת הדואר לא מתבצעת בכל יום בשבוע. מחזירה תו יחיד.

  • Y: שליחת הדואר לא מתבצעת בכל יום בשבוע.
  • N: אין אינדיקציה לכך ששליחת הדואר לא מתבצעת בכל יום בשבוע.
dpv_non_delivery_days_values

int32

מספר שלם שמזהה ימים שלא נמסרו. אפשר לבדוק את הנושא באמצעות סימונים בביט: 0x40 עד ראשון הוא יום ללא מסירה 0x20 – יום שני הוא יום אי-מסירה 0x10 – יום שלישי הוא יום אי-מסירה בין השעות 0x08 – יום רביעי הוא יום ללא מסירה 0x04 עד חמישי, אי מסירה ביום 0x02 עד שישי עד שבת, לא מסירה ביום 0x0
dpv_no_secure_location

string

הדגל מציין שהדלת נגישה, אבל החבילה לא תושאר בגלל בעיות אבטחה. מחזירה תו יחיד.

  • Y: החבילה לא תושאר בגלל בעיות אבטחה.
  • N: אין אינדיקציה שהחבילה לא תעזוב עקב בעיות אבטחה.
dpv_pbsa

string

מציין שהכתובת הותאמה לרשומת PBSA. מחזירה תו יחיד.

  • Y: הכתובת הותאמה לרשומת PBSA.
  • N: הכתובת לא הותאמה לרשומת PBSA.
dpv_door_not_accessible

string

הדגל מציין כתובות שבהן USPS לא יכול לבקש דפי נחיתה בדלת כדי למסור דואר. מחזירה תו יחיד.

  • Y: אין גישה לדלת.
  • N: אין סימן שאי אפשר לגשת לדלת.
dpv_enhanced_delivery_code

string

מציין שיש יותר מקוד החזרה אחד של DPV חוקי עבור הכתובת. מחזירה תו יחיד.

  • Y: הכתובת אושרה ל-DPV למספר הראשי ולמספרים משניים.
  • N: נכשל אישור ה-DPV של פרטי המספר הראשי והפרטים המשניים.
  • S: הכתובת אושרה כ-DPV עבור המספר הראשי בלבד, ופרטי המספר המשני היו קיימים אך לא אושרו, או שהושמטה אלפא אחת בסוף המספר הראשי כדי לבצע התאמת DPV ונדרש מידע משני.
  • D: הכתובת אושרה ל-DPV עבור המספר הראשי בלבד, ופרטי המספר המשני היו חסרים.
  • R: הכתובת אושרה אבל הוקצתה לנתיב הפנטום R777 ו-R779 ולא סופקה משלוח ב-USPS.
carrier_route

string

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

קידומות:

  • C: מסלול של חברת התובלה (או מסלול עירוני)
  • R: מסלול כפרי
  • H: מסלול עם חוזה בכביש מהיר
  • B: אזור של תא דואר
  • G: יחידת משלוח כללית
carrier_route_indicator

string

אינדיקטור למיון של קצב המסלול של חברת התובלה.
ews_no_match

bool

ניתן להתאים את הכתובת למשלוח, אבל בקובץ ה-EWS מצוין שהתאמה מדויקת תהיה זמינה בקרוב.
post_office_city

string

העיר הראשית של סניף הדואר.
post_office_state

string

המדינה הראשית של סניף הדואר.
abbreviated_city

string

קיצור של 'עיר'.
fips_county_code

string

קוד מחוז FIPS.
county

string

שם המחוז.
elot_number

string

מספר משופר של קו נסיעה (eLOT).
elot_flag

string

eLOT דגל עולה/יורד (A/D).
po_box_only_postal_code

bool

המיקוד של תא דואר בלבד.
pmb_designator

string

מגדיר יחידות PMB (תיבת דואר פרטית).
pmb_number

string

מספר PMB (תיבת דואר פרטית)
address_record_type

string

הסוג של רשומת הכתובת שתואמת לכתובת הקלט.

  • F: FIRM. זוהי התאמה לרשומת חברה, שהיא רמת ההתאמה הטובה ביותר שזמינה לכתובת מסוימת.
  • G: משלוח כללי. זוהי התאמה לרשומת הצגה כללית (General Delivery).
  • H: מיקום / דירה. זוהי התאמה לרשומה של בניין או דירה.
  • P: תיבת דואר לפרסום. פריט זה תואם לתא דואר.
  • R: RURAL ROUTE או highWAY CONTRACT: זוהי התאמה לרשומה של מסלול כפרי או לרשומה של חוזה בכביש מהיר, שלשניהם עשויים להיות טווחים משויכים של מספרי Box.
  • S: רשומת STREET: זוהי התאמה לרשומת רחוב שמכילה טווח מספרים ראשי חוקי.
default_address

bool

אינדיקטור שמציין שקיימת כתובת ברירת מחדל, אבל קיימות כתובות ספציפיות יותר.
error_message

string

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

יכול להיות ששדות הנתונים של USPS לא יאוכלסו כשהשגיאה הזו קיימת.
cass_processed

bool

אינדיקטור שמציין שהבקשה עברה עיבוד CASS.

ValidateAddressRequest

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

שדות
address

PostalAddress

חובה. הכתובת בתהליך אימות. כתובות לא מעוצבות יש לשלוח דרך address_lines.

האורך הכולל של השדות בקלט הזה לא יכול לחרוג מ-280 תווים.

כאן מפורטים האזורים הנתמכים.

הערך language_code בכתובת הקלט שמור לשימושים עתידיים והמערכת מתעלמת ממנו היום. התוצאה של הכתובת המאומתת תאוכלס בהתאם לשפה המועדפת של הכתובת הנתונה, כפי שהמערכת תזהה.

ה-API לאימות כתובת מתעלם מהערכים ב-recipients וב-organization. כל הערכים בשדות האלה יימחקו ולא יוחזרו. אין להגדיר אותן.
previous_response_id

string

השדה הזה חייב להיות ריק בבקשה הראשונה לאימות הכתובת. אם נדרשות בקשות נוספות כדי לאמת באופן מלא כתובת יחידה (לדוגמה, אם השינויים שהמשתמש מבצע אחרי האימות הראשוני צריך לאמת מחדש), כל בקשת המשך צריכה לאכלס את השדה הזה ב-response_id מהתגובה הראשונה ברצף האימות.
enable_usps_cass

bool

הפעלת מצב תואם ל-USPS CASS. הפעולה הזו משפיעה רק על השדה google.maps.addressvalidation.v1.ValidationResult.usps_data של google.maps.addressvalidation.v1.ValidationResult. הערה: בבקשות שנשלחות ב-USPS CASS לכתובות בפוארטו ריקו, יש לספק google.type.PostalAddress.region_code מהaddress כ-'PR', או במאפיין google.type.PostalAddress.administrative_area מהaddress כ-'Puerto Rico' (לא תלוי-רישיות) או כ-'PR'.

מומלץ להשתמש ברכיב address שמחושב כרכיב. לחלופין, מומלץ לציין לפחות שני רכיבי google.type.PostalAddress.address_lines שבהם השורה הראשונה מכילה את מספר הרחוב והשם והשורה השנייה כוללת את העיר, המדינה והמיקוד.
language_options

LanguageOptions

זה שינוי אופציונלי. תצוגה מקדימה: התכונה הזו נמצאת ב'תצוגה מקדימה' (pre-GA). יכול להיות שהתמיכה במוצרים ובתכונות טרום-GA תהיה מוגבלת, ויכול להיות ששינויים במוצרים ובתכונות טרום-GA לא יתאימו לגרסאות אחרות של טרום-GA. מוצרים במצב טרום-זמינות לכלל המשתמשים כפופים לתנאים הספציפיים לשירות של הפלטפורמה של מפות Google. מידע נוסף זמין במאמר תיאורים של שלבי ההשקה.

הפעלת ה-API לאימות כתובת כדי לכלול מידע נוסף בתשובה.
session_token

string

זה שינוי אופציונלי. מחרוזת המזהה פעילות של השלמה אוטומטית למטרות חיוב. חייב להיות מחרוזת base64 בטוחה לכתובת URL ולשם קובץ עם 36 תווי ASCII לכל היותר. אחרת, מוחזרת שגיאת INVALID_ARGUMENT.

הסשן מתחיל כשהמשתמש מבצע שאילתה של השלמה אוטומטית, ומסתיים כשהוא בוחר מקום ומתבצעת קריאה לפרטי מקום או לאימות כתובת. כל סשן יכול לכלול מספר שאילתות של השלמה אוטומטית, ולאחר מכן בקשה אחת לאימות פרטי מקום או בקשה לאימות כתובת. פרטי הכניסה שבהם נעשה שימוש לכל בקשה בסשן חייבים להיות שייכים לאותו פרויקט במסוף Google Cloud. לאחר סיום הסשן, האסימון כבר לא תקף. האפליקציה שלכם צריכה ליצור אסימון חדש לכל סשן. אם לא מזינים את הפרמטר sessionToken, או אם משתמשים שוב באסימון סשן, הסשן יחויב כאילו לא סופק אסימון סשן (כל בקשה מחויבת בנפרד).

הערה: ניתן להשתמש באימות כתובות רק בסשנים עם API של השלמה אוטומטית (חדש) ולא עם השלמה אוטומטית API. מידע נוסף זמין בכתובת https://developers.google.com/maps/documentation/places/web-service/session-pricing.

ValidateAddressResponse

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

שדות
result

ValidationResult

התוצאה של אימות הכתובת.
response_id

string

המזהה הייחודי (UUID) שמזהה את התגובה הזו. אם צריך לאמת מחדש את הכתובת, מזהה ייחודי אוניברסלי (UUID) חייב להצטרף לבקשה החדשה.

ValidationResult

התוצאה של אימות כתובת.

שדות
verdict

Verdict

דגלים לגבי תוצאה כוללת
address

Address

מידע על הכתובת עצמה, ולא על הקוד הגיאוגרפי.
geocode

Geocode

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

AddressMetadata

מידע אחר שרלוונטי למסירה. לא מובטח שהשדה metadata יאוכלס במלואו בכל כתובת שנשלחת ל-API לאימות כתובת.
usps_data

UspsData

סימוני מסירה נוספים סופקו על ידי USPS. סופק רק באזור US ו-PR.
english_latin_address

Address

תצוגה מקדימה: התכונה הזו נמצאת ב'תצוגה מקדימה' (pre-GA). יכול להיות שהתמיכה במוצרים ובתכונות טרום-GA תהיה מוגבלת, ויכול להיות ששינויים במוצרים ובתכונות טרום-GA לא יתאימו לגרסאות אחרות של טרום-GA. מוצרים במצב טרום-זמינות לכלל המשתמשים כפופים לתנאים הספציפיים לשירות של הפלטפורמה של מפות Google. מידע נוסף זמין במאמר תיאורים של שלבי ההשקה.

הכתובת תורגמה לאנגלית.

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

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

כדי להפעיל את הפלט הזה באמצעות הדגל google.maps.addressvalidation.v1.LanguageOptions.return_english_latin_address.

הערה: השדה google.maps.addressvalidation.v1.Address.unconfirmed_component_types ב-english_latin_address והשדות google.maps.addressvalidation.v1.AddressComponent.confirmation_level ב-english_latin_address.address_components לא מאוכלסים.

תוצאה

סקירה כללית ומקיפה של תוצאת אימות הכתובת והקואורדינטות שלה.

שדות
input_granularity

Granularity

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

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

Granularity

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

תוצאת האימות של רכיב לכתובת מופיעה ב-google.maps.addressvalidation.v1.Address.address_components.
geocode_granularity

Granularity

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

זה יכול להיות שונה מהמדד validation_granularity שמוצג למעלה מדי פעם. לדוגמה, מסד הנתונים עשוי לתעד את קיומו של מספר דירה, אבל לא את המיקום המדויק של הדירה בתוך מתחם דירות גדול. במקרה הזה, הערך של validation_granularity יהיה SUB_PREMISE אבל הערך של geocode_granularity יהיה PREMISE.
address_complete

bool

הכתובת נחשבת מלאה אם אין אסימונים שלא טופלו, אין רכיבי כתובת לא צפויים או חסרים. אם המדיניות לא מוגדרת, הערך הוא false. לפרטים נוספים, אפשר לעיין בשדות missing_component_types, unresolved_tokens או unexpected.
has_unconfirmed_components

bool

לא ניתן לסווג או לאמת לפחות רכיב כתובת אחד. לפרטים נוספים, יש לעיין בכתובת google.maps.addressvalidation.v1.Address.address_components.
has_inferred_components

bool

המערכת הסיקה (נוסף) לפחות רכיב כתובת אחד שלא נכלל בקלט. לפרטים נוספים, אפשר לעיין ב-google.maps.addressvalidation.v1.Address.address_components.
has_replaced_components

bool

הוחלף לפחות רכיב כתובת אחד. פרטים נוספים מופיעים בכתובת google.maps.addressvalidation.v1.Address.address_components.

רמת פירוט

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

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