PostalAddress

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

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

עצות לגבי קלט / עריכה של כתובת: - השתמשו בווידג'ט של כתובת שמוכן ל-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

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

string

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

string

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

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

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

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

string

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

string

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