- בקשת HTTP
- גוף הבקשה
- גוף התשובה
- PostalAddress
- LanguageOptions
- ValidationResult
- פסק דין
- רמת פירוט
- כתובת
- AddressComponent
- ComponentName
- ConfirmationLevel
- Geocode (קואורדינטות)
- LatLng
- PlusCode
- אזור תצוגה
- AddressMetadata
- UspsData
- UspsAddress
מאמת כתובת.
בקשת HTTP
POST https://addressvalidation.googleapis.com/v1:validateAddress
בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{ "address": { object ( |
שדות | |
---|---|
address |
חובה. הכתובת בתהליך אימות. כתובות לא מעוצבות יש לשלוח דרך האורך הכולל של השדות בקלט הזה לא יכול לחרוג מ-280 תווים. כאן מפורטים האזורים הנתמכים. הערך ה-API לאימות כתובת מתעלם מהערכים ב- |
previousResponseId |
השדה הזה חייב להיות ריק בבקשה הראשונה לאימות הכתובת. אם נדרשות בקשות נוספות כדי לאמת באופן מלא כתובת יחידה (לדוגמה, אם השינויים שהמשתמש מבצע אחרי האימות הראשוני צריך לאמת מחדש), כל בקשת המשך צריכה לאכלס את השדה הזה ב- |
enableUspsCass |
הפעלת מצב תואם ל-USPS CASS. הפעולה הזו משפיעה רק על השדה מומלץ להשתמש ברכיב |
languageOptions |
זה שינוי אופציונלי. תצוגה מקדימה: התכונה הזו נמצאת ב'תצוגה מקדימה' (pre-GA). יכול להיות שהתמיכה במוצרים ובתכונות טרום-GA תהיה מוגבלת, ויכול להיות ששינויים במוצרים ובתכונות טרום-GA לא יתאימו לגרסאות אחרות של טרום-GA. מוצרים במצב טרום-זמינות לכלל המשתמשים כפופים לתנאים הספציפיים לשירות של הפלטפורמה של מפות Google. מידע נוסף זמין במאמר תיאורים של שלבי ההשקה. הפעלת ה-API לאימות כתובת כדי לכלול מידע נוסף בתשובה. |
sessionToken |
זה שינוי אופציונלי. מחרוזת המזהה פעילות של השלמה אוטומטית למטרות חיוב. חייב להיות מחרוזת base64 בטוחה לכתובת URL ולשם קובץ עם 36 תווי ASCII לכל היותר. אחרת, מוחזרת שגיאת INVALID_ARGUMENT. הסשן מתחיל כשהמשתמש מבצע שאילתה של השלמה אוטומטית, ומסתיים כשהוא בוחר מקום ומתבצעת קריאה לפרטי מקום או לאימות כתובת. כל סשן יכול לכלול מספר שאילתות של השלמה אוטומטית, ולאחר מכן בקשה אחת לאימות פרטי מקום או בקשה לאימות כתובת. פרטי הכניסה שבהם נעשה שימוש לכל בקשה בסשן חייבים להיות שייכים לאותו פרויקט במסוף Google Cloud. אחרי שסשן מסתיים, האסימון כבר לא בתוקף. האפליקציה חייבת ליצור אסימון חדש לכל סשן. אם לא מזינים את הפרמטר הערה: ניתן להשתמש באימות כתובות רק בסשנים עם API של השלמה אוטומטית (חדש) ולא עם השלמה אוטומטית API. מידע נוסף זמין בכתובת https://developers.google.com/maps/documentation/places/web-service/session-pricing. |
גוף התשובה
תשובה לבקשה לאימות כתובת.
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{
"result": {
object ( |
שדות | |
---|---|
result |
התוצאה של אימות הכתובת. |
responseId |
המזהה הייחודי (UUID) שמזהה את התגובה הזו. אם צריך לאמת מחדש את הכתובת, מזהה ייחודי אוניברסלי (UUID) חייב להצטרף לבקשה החדשה. |
PostalAddress
מייצג כתובת למשלוח דואר, למשל עבור כתובות למשלוח דואר או תשלומים. אם תספקו כתובת למשלוח דואר, שירות הדואר יכול לשלוח פריטים לעסק שלכם, P.O. Box או דומה. הוא לא נועד לבנות מודלים של מיקומים גיאוגרפיים (כבישים, ערים, הרים).
בשימוש אופייני, כתובת תיווצר על ידי קלט של משתמשים או על ידי ייבוא נתונים קיימים, בהתאם לסוג התהליך.
עצות לגבי קלט / עריכה של כתובת: - השתמשו בווידג'ט כתובת שמוכן ללוקליזציה כמו https://github.com/google/libaddressinput) - אסור להציג למשתמשים רכיבים בממשק המשתמש לצורך קלט או עריכה של שדות מחוץ למדינות שבהן השדה הזה נמצא בשימוש.
הנחיות נוספות לשימוש בסכימה הזו זמינות בכתובת https://support.google.com/business/answer/6397478
ייצוג JSON |
---|
{ "revision": integer, "regionCode": string, "languageCode": string, "postalCode": string, "sortingCode": string, "administrativeArea": string, "locality": string, "sublocality": string, "addressLines": [ string ], "recipients": [ string ], "organization": string } |
שדות | |
---|---|
revision |
הגרסה הקודמת של הסכימה של |
regionCode |
זה שינוי אופציונלי. קוד האזור במאגר CLDR של המדינה או האזור של הכתובת. פרטים נוספים זמינים בכתובת https://cldr.unicode.org/ ובכתובת https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html. דוגמה: 'CH' עבור שווייץ. אם לא תציינו את קידומת האזור, המערכת תסיק אותו מהכתובת בכתובת. לקבלת הביצועים הכי טובים, מומלץ לכלול את קוד האזור אם הוא ידוע לך. אזורים לא עקביים או חוזרים על עצמם עלולים להוביל לביצועים נמוכים. לדוגמה, אם |
languageCode |
קוד השפה בכתובת הקלט שמור לשימושים עתידיים והמערכת מתעלמת ממנו היום. ה-API מחזיר את הכתובת בשפה המתאימה למיקום של הכתובת. |
postalCode |
זה שינוי אופציונלי. המיקוד של הכתובת. לא בכל המדינות נעשה שימוש במספרי המיקוד או שחובה לציין אותם, אבל במקומות שבהם נעשה שימוש בתכונה הזו, המערכת עשויה להפעיל אימות נוסף בחלקים אחרים של הכתובת (למשל, אימות מדינה או מיקוד בארה"ב). |
sortingCode |
זה שינוי אופציונלי. קוד מיון נוסף ספציפי למדינה. ברוב האזורים לא נעשה שימוש בהרשאה הזו. במקומות שבהם משתמשים בו, הערך הוא מחרוזת כמו CEDEX, ואחריו מספר (למשל CEDEX 7) או מספר בלבד, שמייצג את 'קוד המגזר'. (ג'מייקה), "אינדיקטור אזור למשלוחים" (מלאווי) או "אינדיקטור של סניף דואר" (למשל, חוף השנהב). |
administrativeArea |
זה שינוי אופציונלי. חלוקת המשנה האדמיניסטרטיבית הגבוהה ביותר שמשמשת לכתובות דואר של מדינה או אזור. לדוגמה, סוג המשנה יכול להיות מדינה, מחוז, אובלסט או מחוז. באופן ספציפי, בספרד מדובר במחוז ולא בקהילה האוטונומית (למשל, "ברצלונה" ולא "קטלוניה"). במדינות רבות לא נעשה שימוש באזור מנהלי בכתובות דואר. לדוגמה בשווייץ, אין למלא את השדה הזה. |
locality |
זה שינוי אופציונלי. מתייחס באופן כללי לחלק של העיר או העיר בכתובת. דוגמאות: עיר בארה"ב, קהילת IT, עיר דואר בבריטניה. באזורים בעולם שבהם רשויות מוניציפאליות לא מוגדרות היטב או שלא מתאימות למבנה הזה בצורה טובה, השאירו את הרשות המוניציפאלית ריקה והשתמשו בקווי כתובת. |
sublocality |
זה שינוי אופציונלי. אזור המשנה של הכתובת. לדוגמה, המאפיינים יכולים להיות שכונות, רובעים או מחוזות. |
addressLines[] |
חובה. שורות כתובת לא מובנות, שמתארות את הרמות הנמוכות יותר של כתובת. |
recipients[] |
יש להימנע מהגדרת השדה הזה. ה-API לאימות כתובת לא משתמש בו כרגע. בשלב הזה ה-API לא ידחה בקשות עם השדה הזה, אבל המידע יימחק ולא יוחזר בתשובה. |
organization |
יש להימנע מהגדרת השדה הזה. ה-API לאימות כתובת לא משתמש בו כרגע. בשלב הזה ה-API לא ידחה בקשות עם השדה הזה, אבל המידע יימחק ולא יוחזר בתשובה. |
LanguageOptions
תצוגה מקדימה: התכונה הזו נמצאת ב'תצוגה מקדימה' (pre-GA). יכול להיות שהתמיכה במוצרים ובתכונות טרום-GA תהיה מוגבלת, ויכול להיות ששינויים במוצרים ובתכונות טרום-GA לא יתאימו לגרסאות אחרות של טרום-GA. מוצרים במצב טרום-זמינות לכלל המשתמשים כפופים לתנאים הספציפיים לשירות של הפלטפורמה של מפות Google. מידע נוסף זמין במאמר תיאורים של שלבי ההשקה.
הפעלת ה-API לאימות כתובת כדי לכלול מידע נוסף בתשובה.
ייצוג JSON |
---|
{ "returnEnglishLatinAddress": boolean } |
שדות | |
---|---|
returnEnglishLatinAddress |
תצוגה מקדימה: החזרת |
ValidationResult
התוצאה של אימות כתובת.
ייצוג JSON |
---|
{ "verdict": { object ( |
שדות | |
---|---|
verdict |
דגלים לגבי תוצאה כוללת |
address |
מידע על הכתובת עצמה, ולא על הקוד הגיאוגרפי. |
geocode |
מידע על המיקום והמקום שאליו הכתובת המקודדת. |
metadata |
מידע אחר שרלוונטי למסירה. לא מובטח שהשדה |
uspsData |
סימוני מסירה נוספים סופקו על ידי USPS. סופק רק באזור |
englishLatinAddress |
תצוגה מקדימה: התכונה הזו נמצאת ב'תצוגה מקדימה' (pre-GA). יכול להיות שהתמיכה במוצרים ובתכונות טרום-GA תהיה מוגבלת, ויכול להיות ששינויים במוצרים ובתכונות טרום-GA לא יתאימו לגרסאות אחרות של טרום-GA. מוצרים במצב טרום-זמינות לכלל המשתמשים כפופים לתנאים הספציפיים לשירות של הפלטפורמה של מפות Google. מידע נוסף זמין במאמר תיאורים של שלבי ההשקה. הכתובת תורגמה לאנגלית. אי אפשר לעשות שימוש חוזר בכתובות מתורגמות כקלט API. השירות מספק אותן כך שהמשתמש יוכל להשתמש בשפת האם שלו כדי לאשר או לדחות את האימות של הכתובת שסופקה במקור. אם לחלק מהכתובת אין תרגום לאנגלית, השירות יחזיר את החלק הזה בשפה חלופית עם כתב לטיני. כאן מוסבר איך נבחרת השפה החלופית. אם חלק מהכתובת לא כולל תרגומים או תעתיקים בשפה שמבוססת על כתב לטיני, השירות יחזיר את החלק הזה בשפה המקומית שמשויכת לכתובת. כדי להפעיל את הפלט הזה באמצעות הדגל הערה: השדה |
תוצאה
סקירה כללית ברמה גבוהה של תוצאת אימות הכתובת והקואורדינטות שלו.
ייצוג JSON |
---|
{ "inputGranularity": enum ( |
שדות | |
---|---|
inputGranularity |
רמת הפירוט של הכתובת לקלט. התוצאה היא ניתוח של כתובת הקלט והיא לא מספקת אותות אימות. מידע לגבי אותות אימות מופיע בקטע לדוגמה, אם הכתובת שהוזן כוללת מספר דירה ספציפי, הערך של |
validationGranularity |
רמת הפירוט שבה ה-API יכול לאמת באופן מלא את הכתובת. לדוגמה, תוצאת האימות של רכיב לכתובת מופיעה ב- |
geocodeGranularity |
מידע על רמת הפירוט של זה יכול להיות שונה מהמדד |
addressComplete |
הכתובת נחשבת מלאה אם אין אסימונים שלא טופלו, אין רכיבי כתובת לא צפויים או חסרים. אם המדיניות לא מוגדרת, הערך הוא |
hasUnconfirmedComponents |
לא ניתן לסווג או לאמת לפחות רכיב כתובת אחד. לפרטים נוספים, יש לעיין בכתובת |
hasInferredComponents |
המערכת הסיקה (נוסף) לפחות רכיב כתובת אחד שלא נכלל בקלט. לפרטים נוספים, אפשר לעיין ב- |
hasReplacedComponents |
הוחלף לפחות רכיב כתובת אחד. פרטים נוספים מופיעים בכתובת |
רמת פירוט
פירוט הנתונים השונים שיכולים להיות לכתובת או לקואורדינטות. כשהם מציינים את רמת הפירוט של כתובת, הערכים האלה מציינים את רמת הפירוט של הכתובת לזיהוי יעד למשלוח דואר. לדוגמה, כתובת כמו "123 Main Street, Redwood City, CA, 94061" מזהה PREMISE
, במקום משהו כמו "Redwood City, CA, 94061" מזהה LOCALITY
. עם זאת, אם אין באפשרותנו למצוא קואורדינטות של "הרחוב הראשי 123" ברדווד סיטי, הקוד הגיאוגרפי שמוחזר עשוי להיות ברמת פירוט של LOCALITY
למרות שהכתובת מפורטת יותר.
טיפוסים בני מנייה (enum) | |
---|---|
GRANULARITY_UNSPECIFIED |
ערך ברירת המחדל. הערך הזה לא בשימוש. |
SUB_PREMISE |
תוצאה מתחת לרמת הבניין, כגון דירה. |
PREMISE |
תוצאה ברמת המבנה. |
PREMISE_PROXIMITY |
קואורדינטות שזהות למיקום ברמת הבניין של הכתובת. |
BLOCK |
הכתובת או הגאוגרפיה מציינים חסימה. בשימוש רק באזורים עם כתובות ברמת חסימה, כמו יפן. |
ROUTE |
הקוד הגיאוגרפי או הכתובת מפורטים לניתוב, למשל רחוב, כביש או כביש מהיר. |
OTHER |
את כל שאר הפירוטים, שמקובצים יחד כי לא ניתן להציג אותם. |
כתובת
פרטי הכתובת לאחר העיבוד. עיבוד לאחר עיבוד כולל תיקון של חלקים בכתובת עם שגיאות איות, החלפת חלקים שגויים והסקת חלקים חסרים.
ייצוג JSON |
---|
{ "formattedAddress": string, "postalAddress": { object ( |
שדות | |
---|---|
formattedAddress |
הכתובת אחרי עיבוד, בפורמט של כתובת עם שורה אחת לפי כללי הפורמט של הכתובת לפי האזור שבו הכתובת ממוקמת. |
postalAddress |
הכתובת שאחרי העיבוד מיוצגת ככתובת למשלוח דואר. |
addressComponents[] |
רשימה לא ממוינת. רכיבי הכתובת הנפרדים של הכתובת בפורמט הנכון והמתוקן, יחד עם פרטי אימות. כך אפשר לקבל מידע על סטטוס האימות של הרכיבים הבודדים. רכיבי הכתובות לא מסודרים לפי סדר מסוים. אל מניחים הנחות לגבי סדר רכיבי הכתובת ברשימה. |
missingComponentTypes[] |
סוגי הרכיבים שהיו אמורים להופיע בכתובת למשלוח דואר בפורמט תקין אבל לא נמצאו בקלט וגם לא ניתן היה להסיק אותם. רכיבים מהסוג הזה לא קיימים ב- |
unconfirmedComponentTypes[] |
סוגי הרכיבים שקיימים ב |
unresolvedTokens[] |
כל האסימונים בקלט שלא ניתן לפענח. זה יכול להיות קלט שלא זוהה כחלק מכתובת חוקית (לדוגמה, בקלט כמו "123235253253 Main St, San Francisco, CA, 94105". האסימונים שלא זוהו עשויים להיראות כמו |
AddressComponent
מייצג רכיב כתובת, כמו רחוב, עיר או מדינה.
ייצוג JSON |
---|
{ "componentName": { object ( |
שדות | |
---|---|
componentName |
השם של הרכיב הזה. |
componentType |
הסוג של רכיב הכתובת. ראו טבלה 2: סוגים נוספים שהוחזרו על ידי שירות 'מקומות' לרשימת הסוגים האפשריים. |
confirmationLevel |
מציין את רמת הוודאות שיש לנו לגבי כך שהרכיב נכון. |
inferred |
מציין שהרכיב לא היה חלק מהקלט, אבל הסקנו אותו לגבי מיקום הכתובת ואנחנו מאמינים שצריך לספק אותו כדי לציין כתובת מלאה. |
spellCorrected |
מציין תיקון לשגיאת איות בשם הרכיב. ה-API לא תמיד מסמן שינויים מווריאנט איות אחד לאחר, למשל כשמשנים את ה'מרכז'. ל-"center" [מרכז]. הוא גם לא תמיד מסמן שגיאות איות נפוצות, כמו למשל שינוי של "Amphiteater Pkwy" (אמפיתיאטרון Pkwy) ועד Amphitheatre Pkwy. |
replaced |
מציין ששם הרכיב הוחלף בשם אחר לגמרי. לדוגמה, מיקוד שגוי הוחלף במיקוד הנכון עבור הכתובת. זה לא שינוי קוסמטי, רכיב הקלט הוחלף לרכיב אחר. |
unexpected |
מציין רכיב כתובת שלא צפוי להופיע בכתובת למשלוח דואר באזור הנתון. שמרנו אותו רק בגלל שהוא היה חלק מהקלט. |
ComponentName
wrapper לשם הרכיב.
ייצוג JSON |
---|
{ "text": string, "languageCode": string } |
שדות | |
---|---|
text |
הטקסט של השם. לדוגמה, "השדרה החמישית" לשם רחוב או '1253' למספר בית. |
languageCode |
קוד השפה BCP-47. המידע הזה לא יופיע אם שם הרכיב לא משויך לשפה, כמו מספר בית. |
ConfirmationLevel
הערכים האפשריים השונים של רמות האישור.
טיפוסים בני מנייה (enum) | |
---|---|
CONFIRMATION_LEVEL_UNSPECIFIED |
ערך ברירת המחדל. הערך הזה לא בשימוש. |
CONFIRMED |
הצלחנו לוודא שהרכיב הזה קיים ושהוא הגיוני בהקשר של שאר הכתובת. |
UNCONFIRMED_BUT_PLAUSIBLE |
לא ניתן היה לאמת את הרכיב הזה, אבל סביר להניח שהוא קיים. לדוגמה, מספר בית שנמצא בטווח חוקי ידוע של מספרים ברחוב שבו מספרי בתים מסוימים לא ידועים. |
UNCONFIRMED_AND_SUSPICIOUS |
הרכיב הזה לא אושר וסביר להניח שהוא שגוי. לדוגמה, שכונה שלא מתאימה לשאר הכתובת. |
קואורדינטות
מכיל מידע על המקום שאליו בוצע הקידוד הגיאוגרפי של הקלט.
ייצוג JSON |
---|
{ "location": { object ( |
שדות | |
---|---|
location |
המיקום הקואורדינטות של הקלט. עדיף להשתמש במזהי מקומות על פני כתובות, קואורדינטות של קווי אורך ורוחב או קודי OLC. שימוש בקואורדינטות בעת ניתוב או חישוב מסלול נסיעה יגרום תמיד להצמדה של הנקודה לכביש הקרוב ביותר לקואורדינטות האלה. זה לא יכול להיות כביש שיוביל במהירות או בבטחה ליעד, ולא יכול להיות ליד נקודת גישה לנכס. בנוסף, כשהגדרת המיקום היא הפוכה, לא מובטח שהכתובת שהוחזרה תתאים לכתובת המקורית. |
plusCode |
ה-Plus Code של |
bounds |
גבולות המקום המקדים. |
featureSizeMeters |
גודל המקום עם הקואורדינטות, במטרים. זה מדד נוסף של גסות המיקום הגיאוגרפי שמזינים בו את הקוד, אבל בגודלו הפיזי ולא במשמעות הסמנטית. |
placeId |
ה-PlaceID של המקום שאליו מתבצעת הקידוד הגיאוגרפי של הקלט הזה. מידע נוסף על מזהי מקומות זמין כאן. |
placeTypes[] |
סוגי המקומות שהקלט ביצע להם קידוד גיאוגרפי. לדוגמה, |
LatLng
אובייקט שמייצג צמד של קו רוחב/קו אורך. הערך הזה מבוטאת כצמד של כפולים כדי לייצג מעלות קו רוחב ומעלות קו אורך. האובייקט חייב לעמוד בדרישות של תקן WGS84, אלא אם צוין אחרת. הערכים חייבים להיות בטווחים מנורמלים.
ייצוג JSON |
---|
{ "latitude": number, "longitude": number } |
שדות | |
---|---|
latitude |
קו הרוחב במעלות. הוא חייב להיות בטווח [-90.0, +90.0]. |
longitude |
קו האורך במעלות. הוא חייב להיות בטווח [-180.0, +180.0]. |
PlusCode
Plus Code (http://plus.codes) הוא הפניה למיקום בשני פורמטים: קוד גלובלי שמגדיר 14mx14m (1/8, 000 במעלה) או מלבן קטן יותר, וקוד מורכב שמחליף את הקידומת במיקום של הפניה.
ייצוג JSON |
---|
{ "globalCode": string, "compoundCode": string } |
שדות | |
---|---|
globalCode |
הקוד הגלובלי (מלא) של המקום, כמו '9FWM33GV+HQ', שמייצג שטח של 1/8,000 על 1/8,000 מעלות (כ-14 על 14 מטרים). |
compoundCode |
קוד מורכב של מקום, למשל '33GV+HQ, Rammber, נורבגיה', שמכיל את הסיומת של הקוד הגלובלי ומחליף את הקידומת בשם בפורמט של ישות עזר. |
אזור התצוגה
אזור תצוגה של קו רוחב, מיוצג בשתי אלכסון מול low
ו-high
נקודות. אזור תצוגה נחשב לאזור סגור, כלומר הוא כולל את התחום שלו. גבולות הרוחב חייבים להיות בטווח של -90 עד 90 מעלות כולל, וגבולות קו האורך חייבים לנוע בין -180 ל-180 מעלות, כולל. מקרים שונים כוללים:
אם
low
=high
, אזור התצוגה מורכב מנקודה אחת בלבד.אם
low.longitude
>high.longitude
, טווח קו האורך הפוך (אזור התצוגה חוצה את קו האורך 180 מעלות).אם
low.longitude
= -180 מעלות ו-high.longitude
= 180 מעלות, אזור התצוגה כולל את כל קווי האורךאם
low.longitude
= 180 מעלות ו-high.longitude
= 180 מעלות, טווח קו האורך ריק.אם
low.latitude
>high.latitude
, טווח קו הרוחב ריק.
צריך לאכלס גם את low
וגם את high
, והתיבה המיוצגת לא יכולה להיות ריקה (כפי שצוין בהגדרות שלמעלה). אזור תצוגה ריק יגרום לשגיאה.
לדוגמה, אזור התצוגה הזה כולל את כל העיר תל אביב:
{ "low": { "latitude": 40.477398, "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": -73.70018 } }
ייצוג JSON |
---|
{ "low": { object ( |
שדות | |
---|---|
low |
חובה. הנקודה הנמוכה של אזור התצוגה. |
high |
חובה. הנקודה הגבוהה של אזור התצוגה. |
AddressMetadata
המטא-נתונים של הכתובת. לא מובטח שהשדה metadata
יאוכלס במלואו בכל כתובת שנשלחת ל-API לאימות כתובת.
ייצוג JSON |
---|
{ "business": boolean, "poBox": boolean, "residential": boolean } |
שדות | |
---|---|
business |
מציין שזו כתובת של עסק. אם המדיניות לא מוגדרת, הערך מציין שהערך לא ידוע. |
poBox |
מציין שהכתובת של תא דואר. אם המדיניות לא מוגדרת, הערך מציין שהערך לא ידוע. |
residential |
מציין שזו כתובת מגורים. אם המדיניות לא מוגדרת, הערך מציין שהערך לא ידוע. |
UspsData
נתוני USPS של הכתובת. לא מובטח שהשדה uspsData
יאוכלס במלואו לכל כתובת בארה"ב או כתובת ציבורית שנשלחת ל-Address Validation API. אם אתם משתמשים ב-uspsData כחלק הראשי של התשובה, מומלץ לשלב בתשובה את שדות הכתובת לגיבוי.
ייצוג JSON |
---|
{
"standardizedAddress": {
object ( |
שדות | |
---|---|
standardizedAddress |
כתובת סטנדרטית של USPS. |
deliveryPointCode |
קוד נקודת מסירה בן 2 ספרות |
deliveryPointCheckDigit |
ספרת הביקורת של נקודת המסירה. המספר הזה מתווסף לסוף ה-delivery_point_barcode עבור דואר שנסרק באופן מכני. חיבור כל הספרות של ה-delivery_point_barcode, deliveryPointCheckDigit, המיקוד וה-ZIP+4 אמור להניב מספר שמתחלק ב-10. |
dpvConfirmation |
הערכים האפשריים לאישור DPV. מחזירה תו יחיד או לא מחזירה ערך.
|
dpvFootnote |
הערות השוליים מאימות נקודת המסירה. ניתן להצמיד כמה הערות שוליים באותה מחרוזת.
|
dpvCmra |
מאפיין זה מציין אם הכתובת היא CMRA (סוכנות לקבלת דואר מסחרי) – עסק פרטי שמקבל דואר עבור לקוחות. מחזירה תו יחיד.
|
dpvVacant |
המקום הזה ריק? מחזירה תו יחיד.
|
dpvNoStat |
האם זו כתובת קבועה או כתובת פעילה? אין כתובות סטטיות הן כתובות שלא מאוכלסות באופן קבוע או כתובות שלא ניתנות שירות על ידי USPS. מחזירה תו יחיד.
|
dpvNoStatReasonCode |
מציין את הסוג NoStat. הפונקציה מחזירה את קוד הסיבה בפורמט int.
|
dpvDrop |
דגל מציין שהאימייל נשלח לנמען אחד באתר מסוים. מחזירה תו יחיד.
|
dpvThrowback |
מציין שהדואר לא נמסר לכתובת. מחזירה תו יחיד.
|
dpvNonDeliveryDays |
דגל מציין כי שליחת הדואר לא מתבצעת בכל יום בשבוע. מחזירה תו יחיד.
|
dpvNonDeliveryDaysValues |
מספר שלם שמזהה ימים שלא נמסרו. אפשר לבדוק את הנושא באמצעות סימונים בביט: 0x40 עד יום ראשון הוא יום ללא מסירה 0x20 – יום שני הוא יום אי-מסירה 0x10 – יום שלישי הוא יום אי-מסירה בין השעות 0x08 – יום רביעי הוא יום אי-מסירה 0x04 עד חמישי הוא יום ללא מסירה 0x02 עד שישי עד שבת, לא מסירה ביום 0x0 |
dpvNoSecureLocation |
הדגל מציין שהדלת נגישה, אבל החבילה לא תושאר בגלל בעיות אבטחה. מחזירה תו יחיד.
|
dpvPbsa |
מציין שהכתובת הותאמה לרשומת PBSA. מחזירה תו יחיד.
|
dpvDoorNotAccessible |
הדגל מציין כתובות שבהן USPS לא יכול לבקש דפי נחיתה בדלת כדי למסור דואר. מחזירה תו יחיד.
|
dpvEnhancedDeliveryCode |
מציין שיש יותר מקוד החזרה אחד של DPV חוקי עבור הכתובת. מחזירה תו יחיד.
|
carrierRoute |
קוד המסלול של הספק. קוד בן ארבעה תווים שמורכב מקידומת של אות אחת ומציין מסלול בן שלוש ספרות. קידומות:
|
carrierRouteIndicator |
אינדיקטור למיון של קצב המסלול של חברת התובלה. |
ewsNoMatch |
ניתן להתאים את הכתובת למשלוח, אבל בקובץ ה-EWS מצוין שהתאמה מדויקת תהיה זמינה בקרוב. |
postOfficeCity |
העיר הראשית של סניף הדואר. |
postOfficeState |
המדינה הראשית של סניף הדואר. |
abbreviatedCity |
קיצור של 'עיר'. |
fipsCountyCode |
קוד מחוז FIPS. |
county |
שם המחוז. |
elotNumber |
מספר משופר של קו נסיעה (eLOT). |
elotFlag |
eLOT דגל עולה/יורד (A/D). |
lacsLinkReturnCode |
קוד החזרה של LACSLink. |
lacsLinkIndicator |
אינדיקטור של LACSLink. |
poBoxOnlyPostalCode |
המיקוד של תא דואר בלבד. |
suitelinkFootnote |
הערות שוליים החל מהתאמת רישום של רחוב או רב-קומות ועד למידע על מקבץ. אם נמצאה התאמה לשם העסק, מוחזר המספר המשני.
|
pmbDesignator |
מגדיר יחידות PMB (תיבת דואר פרטית). |
pmbNumber |
מספר PMB (תיבת דואר פרטית) |
addressRecordType |
הסוג של רשומת הכתובת שתואמת לכתובת הקלט.
|
defaultAddress |
אינדיקטור שמציין שקיימת כתובת ברירת מחדל, אבל קיימות כתובות ספציפיות יותר. |
errorMessage |
הודעת שגיאה לאחזור נתונים של USPS. השדה הזה מאוכלס כשעיבוד USPS מושעה עקב זיהוי של כתובות שנוצרו באופן מלאכותי. יכול להיות ששדות הנתונים של USPS לא יאוכלסו כשהשגיאה הזו קיימת. |
cassProcessed |
אינדיקטור שמציין שהבקשה עברה עיבוד CASS. |
UspsAddress
ייצוג של כתובת בארה"ב ב-USPS.
ייצוג JSON |
---|
{ "firstAddressLine": string, "firm": string, "secondAddressLine": string, "urbanization": string, "cityStateZipAddressLine": string, "city": string, "state": string, "zipCode": string, "zipCodeExtension": string } |
שדות | |
---|---|
firstAddressLine |
שורת כתובת ראשונה. |
firm |
שם החברה. |
secondAddressLine |
שורת כתובת שנייה. |
urbanization |
שם העיור. |
cityStateZipAddressLine |
עיר + מדינה + מיקוד. |
city |
שם העיר. |
state |
קוד מדינה בן 2 אותיות. |
zipCode |
מיקוד, למשל 10009. |
zipCodeExtension |
סיומת מיקוד בן 4 ספרות, למשל: 5023. |