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

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

שדות
latitude

double

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

double

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

כסף

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

שדות
currency_code

string

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

int64

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

אזור זמן

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

שדות
id

string

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

string

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