Package google.type

אינדקס

תאריך

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

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

סוגים קשורים:

שדות
year

int32

שנת התאריך. חייב להיות בין 1 ל-9999, או 0 כדי לציין תאריך ללא שנה.

month

int32

החודש בשנה. צריך להיות בין 1 ל-12, או 0 כדי לציין שנה בלי חודש ויום.

day

int32

היום בחודש. הערך צריך להיות בין 1 ל-31 והוא תקף לשנה ולחודש, או 0 כדי לציין שנה בלבד או שנה וחודש שבהם היום לא משמעותי.

DayOfWeek

מייצג את היום בשבוע.

טיפוסים בני מנייה (enums)
DAY_OF_WEEK_UNSPECIFIED היום בשבוע לא צוין.
MONDAY יום שני
TUESDAY שלישי
WEDNESDAY רביעי
THURSDAY יום חמישי
FRIDAY שישי
SATURDAY שבת
SUNDAY ראשון

LatLng

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

שדות
latitude

double

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

longitude

double

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

כסף

מייצג סכום כסף לפי סוג המטבע.

שדות
currency_code

string

קוד המטבע בן שלוש אותיות כפי שמוגדר בתקן ISO 4217.

units

int64

מספר היחידות השלמות של הסכום. לדוגמה, אם הערך של currencyCode הוא "USD", המשמעות היא ש-1 יחידה = דולר ארה"ב אחד.

nanos

int32

מספר יחידות הננו (10^-9) של הסכום. הערך חייב להיות בין -999,999,999 ו+999,999,999, כולל. אם הערך של units הוא חיובי, nanos חייב להיות חיובי או אפס. אם הערך של units הוא אפס, הערך של nanos יכול להיות חיובי, אפס או שלילי. אם הערך של units הוא שלילי, הערך של nanos חייב להיות שלילי או אפס. לדוגמה, הסכום $-1.75 מיוצג כך: units=-1 וגם nanos=-750,000,000.

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

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

sublocality

string

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

address_lines[]

string

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

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

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

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

recipients[]

string

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

organization

string

אפשרות. שם הארגון בכתובת.

TimeOfDay

מייצג את השעה ביום. התאריך ואזור הזמן אינם משמעותיים או מצוינים במקום אחר. ממשק API עשוי לבחור לאפשר שניות מעבר. הסוגים הקשורים הם google.type.Date ו-google.protobuf.Timestamp.

שדות
hours

int32

שעות ביום בפורמט 24 שעות. צריך להיות בין 0 ל-23. ממשק API עשוי לאפשר את הערך '24:00:00' בתרחישים כמו שעת הסגירה של העסק.

minutes

int32

דקות בשעה ביום. הערך חייב להיות בין 0 ל-59.

seconds

int32

שניות של דקות מזמן. בדרך כלל צריך להיות מספר בין 0 ל-59. ממשק API עשוי להתיר את הערך 60 אם הוא מאפשר שניות מדלגות.

nanos

int32

שברים של שניות בננו-שניות. חייב להיות בין 0 ל-999,999,999.