Package google.type

אינדקס

LatLng

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

שדות
latitude

double

קו הרוחב במעלות. הערך צריך להיות בטווח [‎-90.0, ‎+90.0].
longitude

double

קו האורך במעלות. הערך חייב להיות בטווח [‎-180.0, ‎+180.0].

LocalizedText

גרסה מקומית של טקסט בשפה מסוימת.

שדות
text

string

מחרוזת מקומית בשפה שמתאימה ל-language_code שבהמשך.
language_code

string

קוד השפה של הטקסט בפורמט BCP-47, למשל en-US או sr-Latn.

מידע נוסף זמין בכתובת http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.

PostalAddress

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

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

המלצות להזנה או לעריכה של כתובת:

  • משתמשים בווידג'ט כתובת שמוכן לבינאום, כמו https://github.com/google/libaddressinput.
  • אסור להציג למשתמשים רכיבים בממשק המשתמש להזנה או לעריכה של שדות מחוץ למדינות שבהן נעשה שימוש בשדה הזה.

הנחיות נוספות לשימוש בסכימה הזו זמינות בכתובת: https://support.google.com/business/answer/6397478.

שדות
revision

int32

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

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

string

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

string

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

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

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

string

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

string

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

string

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

string

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

string

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

string

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

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

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

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

string

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

string

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