Package google.type

אינדקס

תאריך

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

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

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

שדות
year

int32

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

month

int32

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

day

int32

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

DayOfWeek

מייצג יום בשבוע.

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

מרווח

מייצג מרווח זמן, מוצפן כחותמת זמן של התחלה (כולל) וחותמת זמן של סיום (לא כולל).

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

שדות
start_time

Timestamp

זה שינוי אופציונלי. ההתחלה של מרווח הזמן, כולל.

אם מציינים את המרווח, חותמת הזמן שמתאימה לו צריכה להיות זהה לזמן ההתחלה או מאוחרת ממנו.

end_time

Timestamp

זה שינוי אופציונלי. סיום המרווח, לא כולל.

אם מציינים חותמת זמן, היא צריכה להיות לפני סוף המרווח.

LatLng

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

שדות
latitude

double

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

longitude

double

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

כסף

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

שדות
currency_code

string

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

units

int64

מספר היחידות השלמות של הסכום. לדוגמה: אם הערך של currencyCode הוא "USD", המשמעות היא ש-1 יחידה = 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

זה שינוי אופציונלי. מתייחס בדרך כלל לחלק של העיר או העיירה בכתובת. דוגמאות: עיר בארה"ב, קומונה באיטליה, עיר למשלוח דואר בבריטניה. באזורים בעולם שבהם היישובים לא מוגדרים היטב או לא מתאימים למבנה הזה, משאירים את 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

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

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 או שווה לו.

אזור זמן

מייצג אזור זמן ממסד הנתונים של אזור זמן IANA.

שדות
id

string

אזור זמן במסד הנתונים של IANA. לדוגמה, America/New_York.

version

string

זה שינוי אופציונלי. מספר הגרסה של מסד הנתונים של אזורי הזמן של IANA. לדוגמה, '2019a'.