- משאב: TransitObject
- PassengerType
- TicketStatus
- ConcessionCategory
- TicketRestrictions
- PurchaseDetails
- TicketCost
- TicketLeg
- TicketSeat
- FareClass
- TripType
- ActivationStatus (סטטוס ההפעלה)
- מדינה (State)
- DeviceContext
- שיטות
משאב: TransitObject
ייצוג JSON |
---|
{ "classReference": { object ( |
שדות | |
---|---|
classReference |
עותק של השדות שעברו בירושה של מחלקת ההורה. השדות האלה מאוחזרים במהלך GET. |
ticketNumber |
מספר הכרטיס. זהו מזהה ייחודי של הכרטיס במערכת של חברת התחבורה הציבורית. |
passengerType |
מספר הנוסעים. |
passengerNames |
שמות הנוסעים שהכרטיס מוקצה להם. השדה |
tripId |
המזהה הזה משמש לקיבוץ כרטיסים אם המשתמש שמר כמה כרטיסים לאותה נסיעה. |
ticketStatus |
הסטטוס של הכרטיס. למצבים שמשפיעים על תצוגה, יש להשתמש בשדה |
customTicketStatus |
סטטוס מותאם אישית לשימוש בערך של סטטוס הכרטיס כאשר |
concessionCategory |
הקטגוריה של כרטיס המתנה. |
customConcessionCategory |
קטגוריית קנייה מותאמת אישית לשימוש כאשר |
ticketRestrictions |
מידע על סוגי ההגבלות שחלות על השימוש בכרטיס הזה. לדוגמה, באילו ימים בשבוע חובה להשתמש או באילו מסלולים מותר לנסוע. |
purchaseDetails |
פרטי הרכישה של הכרטיס הזה. |
ticketLeg |
קטע כרטיס אחד מכיל מידע על זמני היציאה וההגעה וכן מידע על עלייה למטוס ועל מקומות ישיבה. אם צריך לציין יותר מקטע אחד, יש להשתמש במקום זאת בשדה |
ticketLegs[] |
כל כרטיס יכול להכיל קטע אחד או יותר. כל מקטע מכיל מידע על זמני היציאה וההגעה וכן מידע על עלייה למטוס ועל מקומות ישיבה. אם צריך לציין רק רגל אחת, משתמשים בשדה |
hexBackgroundColor |
צבע הרקע של הכרטיס. אם לא מגדירים את הצבע הדומיננטי של התמונה הראשית, ואם לא מוגדרת תמונה ראשית, נעשה שימוש בצבע הדומיננטי של הלוגו. הפורמט הוא #rrggbb, שבו rrggbb היא טריולת RGB הקסדצימלית, כמו |
tripType |
חובה. סוג הנסיעה שאובייקט התחבורה הזה מייצג. משמש כדי לקבוע את שם הכרטיס ו/או איזה סמל להשתמש בין נקודת המוצא ליעד. |
id |
חובה. המזהה הייחודי של אובייקט. המזהה הזה חייב להיות ייחודי בכל האובייקטים של המנפיק. הערך הזה צריך להיות בפורמט issuer ID.identifier שבו הראשון הונפק על ידי Google והאחרון נבחר על ידך. המזהה הייחודי יכול לכלול רק תווים אלפאנומריים, '.', '_' או '-'. |
classId |
חובה. המחלקה שמשויכת לאובייקט הזה. המחלקה חייבת להיות מאותו סוג כמו האובייקט הזה, היא חייבת להיות כבר קיימת וחייבת להיות מאושרת. מזהי מחלקות צריכים להיות בפורמט issuer ID.identifier שבו הראשון הונפק על ידי Google והאחרון נבחר על ידך. |
version |
הוצא משימוש |
state |
חובה. מצב האובייקט. השדה הזה משמש לקביעת אופן ההצגה של אובייקט באפליקציה. לדוגמה, אובייקט |
barcode |
הסוג והערך של הברקוד. |
messages[] |
מערך הודעות שמוצגות באפליקציה. כל המשתמשים באובייקט הזה יקבלו את ההודעות המשויכות אליו. המספר המקסימלי של השדות האלה הוא 10. |
validTimeInterval |
פרק הזמן שבו האובייקט הזה יהיה |
locations[] |
הערה: בשלב זה השדה הזה לא נתמך להפעלת התראות גיאוגרפיות. |
hasUsers |
מציין אם לאובייקט יש משתמשים. השדה הזה מוגדר על ידי הפלטפורמה. |
smartTapRedemptionValue |
הערך שיועבר למסוף מאושר בהקשה חכמה ב-NFC עבור האובייקט הזה. גם השדות ברמת הכיתה |
hasLinkedDevice |
אם האובייקט הזה מקושר כרגע למכשיר אחד. השדה הזה מוגדר על ידי הפלטפורמה כשמשתמש שומר את האובייקט ומקשר אותו למכשיר שלו. מיועד לשימוש על ידי שותפים נבחרים. לקבלת מידע נוסף, אפשר לפנות לתמיכה. |
disableExpirationNotification |
שדה זה מציין אם יש להסתיר את ההתראות באופן מפורש. אם השדה הזה מוגדר כ-True, לא משנה מה השדה כרגע אפשר להגדיר את האפשרות הזו רק למבצעים. |
infoModuleData |
הוּצא משימוש. במקומו צריך להשתמש ב-textModulesData. |
imageModulesData[] |
נתונים של מודול התמונה. המספר המקסימלי של השדות המוצגים הוא 1 ברמת האובייקט ו-1 ברמת האובייקט של הכיתה. |
textModulesData[] |
נתונים של מודול טקסט. אם נתונים של מודול טקסט מוגדרים גם במחלקה, שניהם יוצגו. המספר המקסימלי של השדות המוצגים הוא 10 מהאובייקט ו-10 מהמחלקה. |
linksModuleData |
נתונים של מודול הקישורים. אם נתוני מודול הקישורים מוגדרים גם במחלקה, שניהם יוצגו. |
appLinkData |
קישור אופציונלי לאפליקציה או לאתר שיוצג כלחצן בתחילת הכרטיס. אם הוגדר AppLinkData עבור המחלקה המתאימה, יוצג רק האובייקט AppLinkData. |
activationStatus |
סטטוס ההפעלה של האובייקט. חובה אם בקטגוריה |
rotatingBarcode |
הסוג והערך של הברקוד המסתובב. |
deviceContext |
הקשר המכשיר שמשויך לאובייקט. |
heroImage |
תמונת באנר אופציונלית מוצגת בחזית הכרטיס. אם אין תעודה מזהה, תוצג התמונה הראשית של הכיתה (אם יש כזו). אם גם התמונה הראשית (Hero) של הכיתה לא מוצגת, שום דבר לא יוצג. |
groupingInfo |
מידע שקובע איך הכרטיסים יקובצו יחד. |
passConstraints |
מעבירים את האילוצים של האובייקט. כולל הגבלת התנהגויות של NFC וצילומי מסך. |
PassengerType
טיפוסים בני מנייה (enums) | |
---|---|
PASSENGER_TYPE_UNSPECIFIED |
|
SINGLE_PASSENGER |
|
singlePassenger |
כתובת אימייל חלופית מדור קודם של |
MULTIPLE_PASSENGERS |
|
multiplePassengers |
כתובת אימייל חלופית מדור קודם של |
TicketStatus
טיפוסים בני מנייה (enums) | |
---|---|
TICKET_STATUS_UNSPECIFIED |
|
USED |
|
used |
כתובת אימייל חלופית מדור קודם של |
REFUNDED |
|
refunded |
כתובת אימייל חלופית מדור קודם של |
EXCHANGED |
|
exchanged |
כתובת אימייל חלופית מדור קודם של |
ConcessionCategory
טיפוסים בני מנייה (enums) | |
---|---|
CONCESSION_CATEGORY_UNSPECIFIED |
|
ADULT |
|
adult |
כתובת אימייל חלופית מדור קודם של |
CHILD |
|
child |
כתובת אימייל חלופית מדור קודם של |
SENIOR |
|
senior |
כתובת אימייל חלופית מדור קודם של |
TicketRestrictions
ייצוג JSON |
---|
{ "routeRestrictions": { object ( |
שדות | |
---|---|
routeRestrictions |
הגבלות על מסלולים שאפשר לבחור בהם. לדוגמה, השם יכול להיות המחרוזת 'רכבות קרוס קאנטרי בהזמנה בלבד'. |
routeRestrictionsDetails |
פרטים נוספים על |
timeRestrictions |
הגבלות לגבי זמני השימוש בכרטיס הזה. |
otherRestrictions |
הגבלות נוספות שלא נכללות בקטגוריות 'מסלול' או 'זמן'. |
PurchaseDetails
ייצוג JSON |
---|
{
"purchaseReceiptNumber": string,
"purchaseDateTime": string,
"accountId": string,
"confirmationCode": string,
"ticketCost": {
object ( |
שדות | |
---|---|
purchaseReceiptNumber |
מספר הקבלה/המזהה למעקב אחר רכישת הכרטיס דרך הגוף שמכר את הכרטיס. |
purchaseDateTime |
התאריך/השעה של רכישת הכרטיס. זהו תאריך/שעה בפורמט מורחב לפי תקן ISO 8601, עם או בלי קיזוז. ניתן להגדיר זמן עד לדיוק של ננו-שניות. ניתן לציין קיזוזים ברמת דיוק של שניות (למרות ששניות היסט אינן חלק מ-ISO 8601). למשל:
ללא מידע על קיזוזים, ייתכן שחלק מהתכונות העשירות לא יהיו זמינות. |
accountId |
המזהה של החשבון ששימש לרכישת הכרטיס. |
confirmationCode |
קוד האישור של הרכישה. התווית יכולה להיות זהה לכמה כרטיסים שונים, והיא משמשת לקיבוץ כרטיסים יחד. |
ticketCost |
עלות הכרטיס. |
TicketCost
ייצוג JSON |
---|
{ "faceValue": { object ( |
שדות | |
---|---|
faceValue |
הערך המקורי של הכרטיס. |
purchasePrice |
מחיר הרכישה בפועל של הכרטיס, אחרי מיסים ו/או הנחות. |
discountMessage |
הודעה שמתארת כל סוג של הנחה שהוחלה. |
TicketLeg
ייצוג JSON |
---|
{ "originStationCode": string, "originName": { object ( |
שדות | |
---|---|
originStationCode |
קוד תחנת המוצא. חובה לציין את זה אם |
originName |
שם תחנת המוצא. חובה לציין את זה אם |
destinationStationCode |
קוד תחנת היעד. |
destinationName |
שם היעד. |
departureDateTime |
תאריך/שעת היציאה. המאפיין הזה נדרש אם לא הוגדר מרווח זמן תקף לאובייקט ההובלה. זהו תאריך/שעה בפורמט מורחב לפי תקן ISO 8601, עם או בלי קיזוז. ניתן להגדיר זמן עד לדיוק של ננו-שניות. ניתן לציין קיזוזים ברמת דיוק של שניות (למרות ששניות היסט אינן חלק מ-ISO 8601). למשל:
החלק של התאריך/השעה ללא ההיסט נחשב ל "תאריך/שעה מקומיים". התאריך הזה צריך להיות התאריך והשעה המקומיים בתחנת המוצא. לדוגמה, אם היציאה מתרחשת בשעה 20 של 5 ביוני 2018 בתחנת המוצא, החלק של התאריך/השעה המקומי צריך להיות ללא מידע על קיזוזים, ייתכן שחלק מהתכונות העשירות לא יהיו זמינות. |
arrivalDateTime |
תאריך/שעת ההגעה. זהו תאריך/שעה בפורמט מורחב לפי תקן ISO 8601, עם או בלי קיזוז. ניתן להגדיר זמן עד לדיוק של ננו-שניות. ניתן לציין קיזוזים ברמת דיוק של שניות (למרות ששניות היסט אינן חלק מ-ISO 8601). למשל:
החלק של התאריך/השעה ללא ההיסט נחשב ל "תאריך/שעה מקומיים". התאריך הזה צריך להיות התאריך/השעה המקומיים בתחנת היעד. לדוגמה, אם האירוע מתרחש בשעה 20 של 5 ביוני 2018 בתחנת היעד, החלק של התאריך/השעה המקומי צריך להיות ללא מידע על קיזוזים, ייתכן שחלק מהתכונות העשירות לא יהיו זמינות. |
fareName |
תיאור/שם קצר של המחיר לנסיעה הזו. למשל, 'שימוש חד-פעמי בכל זמן'. |
carriage |
השם או המספר של הרכבת או האונייה שעל הנוסע. |
platform |
הרציף או השער שבהם הנוסע יכול לעלות לקרון. |
zone |
אזור העלייה למטוס בתוך הפלטפורמה. |
ticketSeat |
המושב השמור לנוסע/ים. אם רוצים לציין יותר ממושב אחד, משתמשים בשדה |
ticketSeats[] |
המושב השמור לנוסע/ים. אם רוצים לציין מושב אחד בלבד, משתמשים בשדה |
transitOperatorName |
שם חברת התחבורה הציבורית שמפעילה את הקטע הזה בנסיעה. |
transitTerminusName |
תחנת הרכבת הסופית או היעד של הרכבת/האוטובוס וכו' |
TicketSeat
ייצוג JSON |
---|
{ "fareClass": enum ( |
שדות | |
---|---|
fareClass |
סיווג המחיר של המושב שמכוס בו כרטיסים. |
customFareClass |
מחלקה של מחיר מותאם אישית לשימוש אם לא חלה |
coach |
המזהה של קרון הרכבת או הקרון שבו ממוקם המושב בתשלום. דוגמה '10' |
seat |
המזהה של מיקום המושב בתשלום. דוגמה '42'. אם אין מזהה ספציפי, יש להשתמש במקום זאת ב- |
seatAssignment |
בחירת מושב הנוסע. דוגמה "ללא מושב ספציפי". לשימוש כשאין מזהה ספציפי לשימוש ב- |
FareClass
טיפוסים בני מנייה (enums) | |
---|---|
FARE_CLASS_UNSPECIFIED |
|
ECONOMY |
|
economy |
כתובת אימייל חלופית מדור קודם של |
FIRST |
|
first |
כתובת אימייל חלופית מדור קודם של |
BUSINESS |
|
business |
כתובת אימייל חלופית מדור קודם של |
TripType
טיפוסים בני מנייה (enums) | |
---|---|
TRIP_TYPE_UNSPECIFIED |
|
ROUND_TRIP |
|
roundTrip |
כתובת אימייל חלופית מדור קודם של |
ONE_WAY |
|
oneWay |
כתובת אימייל חלופית מדור קודם של |
ActivationStatus
סטטוס ההפעלה של האובייקט. השדה הזה כולל את סטטוס ההפעלה, אם הערך הזה תומך בהפעלה.
ייצוג JSON |
---|
{
"state": enum ( |
שדות | |
---|---|
state |
|
ארץ
טיפוסים בני מנייה (enums) | |
---|---|
UNKNOWN_STATE |
|
NOT_ACTIVATED |
לא הופעל, זהו סטטוס ברירת המחדל |
not_activated |
כתובת אימייל חלופית מדור קודם של |
ACTIVATED |
התכונה הופעלה |
activated |
כתובת אימייל חלופית מדור קודם של |
DeviceContext
הקשר המכשיר שמשויך לאובייקט.
ייצוג JSON |
---|
{ "deviceToken": string } |
שדות | |
---|---|
deviceToken |
אם המדיניות מוגדרת, פרטי המימוש יוחזרו למכשיר הנתון רק לאחר הפעלת האובייקט. אסור להשתמש במספר הזה כמזהה יציב למעקב אחר מכשיר של משתמש. הוא יכול להשתנות בין כרטיסים שונים באותו מכשיר או אפילו להפעלות שונות של אותו מכשיר. במהלך ההגדרה הזו, המתקשרים חייבים להגדיר את hasLinkedDevice גם באובייקט שמופעל. |
שיטות |
|
---|---|
|
הוספת הודעה לאובייקט ההעברה שאליו מפנה מזהה האובייקט הנתון. |
|
מחזירה את אובייקט ההעברה עם מזהה האובייקט הנתון. |
|
הוספת אובייקט מעבר עם המזהה והמאפיינים הנתונים. |
|
מחזירה רשימה של כל אובייקטי התחבורה עבור מזהה מנפיק נתון. |
|
עדכון אובייקט ההעברה שמזהה האובייקט הנתון מפנה אליו. |
|
עדכון אובייקט ההעברה שמזהה האובייקט הנתון מפנה אליו. |