PostalAddress

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

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

עצות לגבי הזנת כתובת או עריכת כתובת: - יש להשתמש בווידג'ט כתובות מוכן ל-i18n, כמו 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

integer

גרסת הסכימה של PostalAddress. יש להגדיר את הערך כ-0, שהוא הגרסה האחרונה.

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

regionCode

string

חובה. קוד האזור במאגר CLDR של המדינה או האזור של הכתובת. המערכת אף פעם לא מסיקה את הערך הזה, והמשתמש צריך לוודא שהערך נכון. פרטים נוספים זמינים בכתובת http://cldr.unicode.org/ ובכתובת http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html. דוגמה: 'CH' עבור שווייץ.

languageCode

string

זה שינוי אופציונלי. קוד השפה BCP-47 של התוכן בכתובת הזו (אם ידוע). לרוב זוהי שפת ממשק המשתמש של טופס הקלט, או שהיא אמורה להתאים לאחת מהשפות שציינת בכתובת מדינה/אזור, או את המקבילים בתעתיק שלהם. הדבר עשוי להשפיע על העיצוב במדינות מסוימות, אבל הוא לא קריטי לנכונות הנתונים, ולעולם לא ישפיע על תהליכי אימות או על פעולות אחרות שלא קשורות לעיצוב.

אם הערך הזה לא ידוע, צריך להשמיט אותו (במקום לציין ערך ברירת מחדל שעלול להיות שגוי).

דוגמאות: 'zh-Hant',‏ 'ja',‏ 'ja-Latn',‏ 'en'.

postalCode

string

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

sortingCode

string

זה שינוי אופציונלי. קוד מיון נוסף ספציפי למדינה. ברוב האזורים לא משתמשים באפשרות הזו. במקומות שבהם משתמשים בו, הערך הוא מחרוזת כמו CEDEX, ואחריו מספר (למשל CEDEX 7) או מספר בלבד, שמייצג את 'קוד המגזר'. (ג'מייקה), "אינדיקטור אזור למשלוחים" (מלאווי) או "אינדיקטור של סניף דואר" (למשל, חוף השנהב).

administrativeArea

string

זה שינוי אופציונלי. הרמה המנהלית הגבוהה ביותר שמשמשת לכתובות דואר של מדינה או אזור. לדוגמה, סוג המשנה יכול להיות מדינה, מחוז, אובלסט או מחוז. בספרד, הפרמטר הזה מייצג את המחוז ולא את הקהילה האוטונומית (למשל, 'ברצלונה' ולא 'קטלוניה'). במדינות רבות לא נעשה שימוש באזור מנהלי בכתובות דואר. לדוגמה, בשווייץ לא צריך לאכלס את השדה הזה.

locality

string

זה שינוי אופציונלי. בדרך כלל מתייחס לחלק של העיר בכתובת. דוגמאות: עיר בארה"ב, עיר בבריטניה, יישוב בבריטניה. באזורים בעולם שבהם היישובים לא מוגדרים בצורה טובה או לא מתאימים למבנה הזה, משאירים את השדה locality ריק ומשתמשים ב-addressLines.

sublocality

string

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

addressLines[]

string

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

מכיוון שלערכים בשדה addressLines אין פרטי טיפוס, ולפעמים הם מכילים כמה ערכים בשדה אחד (למשל 'Austin, TX'), חשוב שהסדר של השורות יהיה ברור. סדר שורות הכתובת צריך להיות "סדר מעטפה" עבור המדינה/האזור של הכתובת. במקומות שבהם הערך הזה יכול להשתנות (למשל, יפן), משתמשים ב-address_language כדי לציין אותה באופן מפורש (למשל 'ja' לסידור מהגדול לקטן ו-'ja-Latn' או 'en' לקטן לגדול). כך ניתן לבחור את שורת הכתובת הספציפית ביותר בהתאם לשפה.

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

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

recipients[]

string

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

organization

string

זה שינוי אופציונלי. שם הארגון בכתובת.