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

זה שינוי אופציונלי. סיום בלעדי של המרווח.

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

PhoneNumber

אובייקט שמייצג מספר טלפון, מתאים בפורמט של כבל API.

הייצוג הזה:

  • אין להשתמש בפורמט הזה לציון מספר טלפון בפורמט ספציפי ללוקאל, למשל +1 (650) 253-0000 ext. 123"

  • לא מיועד לאחסון יעיל

  • ייתכן שלא מתאימות לחיוג - יש להשתמש בספריות מיוחדות (ראו הפניות) כדי לנתח את המספר למטרה זו

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

לדוגמה, ב-Java זה ייראה כך:

com.google.type.PhoneNumber wireProto = com.google.type.PhoneNumber.newBuilder().build(); com.google.i18n.phonenumbers.Phonenumber.PhoneNumber phoneNumber = PhoneNumberUtil.getInstance().parse(wireProto.getE164Number(), "ZZ"); if (!wireProto.getExtension().isEmpty()) { phoneNumber.setExtension(wireProto.getExtension()); }

הפניות: - https://github.com/google/libphonenumber

שדות
extension

string

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

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

שדה איחוד kind. חובה. מספר רגיל או קוד מקוצר. יכול להיות שבעתיד יתווספו שדות חדשים לאחד מהשדות שלמטה, לכן על הלקוחות להתעלם ממספרי טלפון שלא מוגדר עבורם אף אחד מהשדות שהם מקודדים. kind יכול להיות רק אחת מהאפשרויות הבאות:
e164_number

string

מספר הטלפון, מיוצג באמצעות סימן פלוס ('+') ואחריו מספר טלפון בפורמט רגוע של ITU E.164. המספר הזה כולל את קידומת החיוג למדינה (1 עד 3 ספרות) ואת מספר המנוי, ללא רווחים או פורמט נוספים, למשל: - נכון: +15552220123" - שגוי: +1 (555) 222-01234 x123".

הפורמט ITU E.164 מגביל את הפורמט השני ל-12 ספרות, אבל בפועל לא כל המדינות מכבדים זאת, ולכן אנחנו מבהירים כאן את ההגבלה הזו. אי אפשר להשתמש במספרים לאומיים בלבד.

מקורות מידע: https://www.itu.int/rec/T-REC-E.164-201011-Ihttps://en.wikipedia.org/wiki/E.164. – https://en.wikipedia.org/wiki/List_of_country_calling_codes

short_code

ShortCode

קוד מקוצר.

קובצי עזר: – https://en.wikipedia.org/wiki/Short_code

ShortCode

אובייקט שמייצג קוד מקוצר, שהוא מספר טלפון שבדרך כלל קצר בהרבה ממספרי טלפון רגילים, ואפשר להשתמש בו כדי לטפל בהודעות במערכות MMS ו-SMS, וגם לחיוג מקוצר (למשל, "Text 611 כדי לראות כמה דקות נותרו לך בתוכנית").

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

שדות
region_code

string

חובה. קוד האזור BCP-47 של המיקום שבו ניתן לבצע שיחות למספר המקוצר הזה, כמו 'US' ו-'BB'.

קובצי עזר: - http://www.unicode.org/reports/tr35/#unicode_region_subtag

number

string

חובה. הספרות הקצרות, ללא סימן פלוס ('+') בהתחלה או קידומת מדינה, למשל '611'.

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

יצירת כתובת שמכילה רק area_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.

TimeZone

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

שדות
id

string

אזור זמן IANA Time Zone Database, למשל "America/New_York".

version

string

זה שינוי אופציונלי. מספר הגרסה של IANA Time Zone Database, למשל: "2019a".