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/REGION_information.html. דוגמה: "CH" עבור שווייץ.

languageCode

string

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

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

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

postalCode

string

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

sortingCode

string

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

administrativeArea

string

אופציונלי. חלוקת המשנה המנהלית הגבוהה ביותר המשמשת לכתובות דואר של מדינה או אזור. לדוגמה: מדינה, מחוז, אובלסט או מחוז. באופן ספציפי, בספרד היא הפרובינציה ולא הקהילה האוטונומית (למשל "Barçona" ולא "קטלוניה"). מדינות רבות לא משתמשות באזור מנהלי בכתובות דואר. למשל, בשווייץ צריך להשאיר את השדה הזה לא מאוכלס.

locality

string

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

sublocality

string

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

addressLines[]

string

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

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

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

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

recipients[]

string

אופציונלי. הנמען בכתובת. בשדה הזה עשוי להיות מידע בנסיבות מרובות, בנסיבות מסוימות. לדוגמה, הוא עשוי להכיל מידע "care&&; .

organization

string

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