- משאב: 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 ב-hex, למשל |
tripType |
חובה. סוג הנסיעה שאותו מייצג אובייקט התחבורה הציבורית. משמש לקביעת שם הכרטיס ו/או הסמל שבו יש להשתמש בין נקודת היציאה ליעד. |
id |
חובה. המזהה הייחודי של אובייקט. המזהה הזה חייב להיות ייחודי בכל האובייקטים של מנפיק. הערך צריך להיות בפורמט issuer ID.identifier, כאשר המזהה הראשון מונפק על ידי Google והשני נבחר על ידכם. המזהה הייחודי צריך לכלול רק תווים אלפאנומריים, '.', '_' או '-'. |
classId |
חובה. הכיתה שמשויכת לאובייקט הזה. הכיתה צריכה להיות מאותו סוג כמו האובייקט הזה, היא כבר צריכה להתקיים והיא צריכה להיות מאושרת. מזהי הכיתות צריכים להיות בפורמט issuer ID.identifier, כאשר המזהה הראשון מונפק על ידי Google והשני נבחר על ידכם. |
version |
הוצא משימוש |
state |
חובה. המצב של האובייקט. השדה הזה משמש לקביעת האופן שבו אובייקט מוצג באפליקציה. לדוגמה, אובייקט |
barcode |
סוג הברקוד והערך שלו. |
messages[] |
מערך של הודעות שמוצגות באפליקציה. כל המשתמשים באובייקט הזה יקבלו את ההודעות המשויכות אליו. המספר המקסימלי של השדות האלה הוא 10. |
validTimeInterval |
פרק הזמן שבו האובייקט יהיה |
locations[] |
הערה: בשלב הזה אין תמיכה בשדה הזה כדי להפעיל התראות גיאוגרפיות. |
hasUsers |
מציין אם יש לאובייקט משתמשים. השדה הזה מוגדר על ידי הפלטפורמה. |
smartTapRedemptionValue |
הערך שיישלח לאובייקט הזה למסוף מאושר של Smart Tap באמצעות NFC. כדי שהכרטיס יתמוך בתכונה 'הקשה חכמה', צריך להגדיר גם את השדות |
hasLinkedDevice |
אם האובייקט הזה מקושר כרגע למכשיר אחד. השדה הזה מוגדר על ידי הפלטפורמה כשמשתמש שומר את האובייקט ומקשר אותו למכשיר שלו. מיועד לשימוש של שותפים נבחרים. לקבלת מידע נוסף, אפשר לפנות לתמיכה. |
disableExpirationNotification |
מציין אם צריך לדכא את ההתראות באופן מפורש. אם השדה הזה מוגדר כ-true, ללא קשר לשדה בשלב הזה אפשר להגדיר את האפשרות הזו רק למבצעים. |
infoModuleData |
הוצא משימוש. במקום זאת, צריך להשתמש ב-textModulesData. |
imageModulesData[] |
נתוני מודול התמונה. המספר המקסימלי של השדות האלה שמוצגים הוא 1 ברמת האובייקט ו-1 ברמת אובייקט הכיתה. |
textModulesData[] |
נתונים של מודול טקסט. אם מוגדרים גם נתונים של מודול טקסט בכיתה, יוצגו שניהם. המספר המקסימלי של השדות האלה שמוצגים הוא 10 מהאובייקט ו-10 מהכיתה. |
linksModuleData |
נתוני המודול 'קישורים'. אם הנתונים של מודול הקישורים מוגדרים גם בכיתה, יוצגו שניהם. |
appLinkData |
קישור אופציונלי לאפליקציה או לאתר שיוצג כלחצן בחזית הכרטיס. אם יסופקו נתוני AppLinkData לסיווג המתאים, יוצגו רק נתוני AppLinkData של האובייקט. |
activationStatus |
סטטוס ההפעלה של האובייקט. חובה אם בכיתה מוגדר |
rotatingBarcode |
הסוג והערך של הברקוד המסתובב. |
deviceContext |
ההקשר של המכשיר שמשויך לאובייקט. |
heroImage |
תמונה אופציונלית של באנר שמוצגת בחזית הכרטיס. אם לא תהיה תמונה כזו, תוצג תמונה ראשית של הכיתה, אם יש כזו. אם גם תמונת ה-Hero של הכיתה לא תופיע, לא יוצג כלום. |
groupingInfo |
מידע שקובע את אופן הקיבוץ של הכרטיסים. |
passConstraints |
מעבירים את האילוצים של האובייקט. כולל הגבלת התנהגויות של NFC וצילומי מסך. |
saveRestrictions |
הגבלות על האובייקט שצריך לאמת לפני שהמשתמש ינסה לשמור את הכרטיס. חשוב לזכור שההגבלות האלה יחולו רק במהלך זמן השמירה. אם ההגבלות השתנו אחרי שהמשתמש שמר את הכרטיס, ההגבלות החדשות לא יחולו על כרטיס שכבר נשמר. |
linkedObjectIds[] |
linkedObjectIds היא רשימה של אובייקטים אחרים, כמו כרטיס אירוע, כרטיס מועדון לקוחות, מבצע, אובייקט כללי, כרטיס מתנה, כרטיס לתחבורה ציבורית וכרטיס עלייה למטוס, שצריך לצרף באופן אוטומטי לאובייקט התחבורה הציבורית הזה. אם משתמש שמר את כרטיס התחבורה הציבורית הזה, מזהי ה-linkedObjectIds האלה יועברו באופן אוטומטי לארנק של המשתמש (אלא אם הוא השבית את ההגדרה לקבלת כרטיסים מקושרים כאלה). חשוב לוודא שהאובייקטים שמופיעים ב-linkedObjectIds כבר הוכנסו – אחרת הקריאות ייכשל. אחרי שמקשרים אובייקטים, אי אפשר לבטל את הקישור שלהם. אי אפשר לקשר אובייקטים ששייכים למנפיק אחר. יש מגבלה על מספר האובייקטים שאפשר לקשר לאובייקט יחיד. אחרי שמגיעים למגבלה, המערכת תתעלם בשקט מאובייקטים מקושרים חדשים בשיחה. מזהי אובייקטים צריכים להיות בפורמט issuer ID.identifier, כאשר הראשון מונפק על ידי Google והשני נבחר על ידכם. |
notifyPreference |
האם עדכוני שדות באובייקט הזה יפעילו התראות. כשהערך מוגדר ל-NOTIFY, אנחנו מנסים להפעיל התראה למשתמשים על עדכון השדה. ההתראות האלה יישלחו למשתמשים רק אם השדה נכלל ברשימת ההיתרים. אם הערך מוגדר כ-DO_NOT_NOTIFY או כ-NOTIFICATION_SETTINGS_UNSPECIFIED, לא תופעל התראה. ההגדרה הזו היא זמנית וצריך להגדיר אותה בכל בקשת PATCH או UPDATE, אחרת לא תופעל התראה. |
valueAddedModuleData[] |
נתונים אופציונליים של מודול עם ערך מוסף. עד עשר באותו אובייקט. |
PassengerType
טיפוסים בני מנייה (enum) | |
---|---|
PASSENGER_TYPE_UNSPECIFIED |
|
SINGLE_PASSENGER |
|
singlePassenger |
כתובת אימייל חלופית מדור קודם של |
MULTIPLE_PASSENGERS |
|
multiplePassengers |
כתובת אימייל חלופית מדור קודם של |
TicketStatus
טיפוסים בני מנייה (enum) | |
---|---|
TICKET_STATUS_UNSPECIFIED |
|
USED |
|
used |
כתובת אימייל חלופית מדור קודם של |
REFUNDED |
|
refunded |
כתובת אימייל חלופית מדור קודם של |
EXCHANGED |
|
exchanged |
כתובת אימייל חלופית מדור קודם של |
ConcessionCategory
טיפוסים בני מנייה (enum) | |
---|---|
CONCESSION_CATEGORY_UNSPECIFIED |
|
ADULT |
|
adult |
כתובת אימייל חלופית מדור קודם של |
CHILD |
|
child |
כתובת אימייל חלופית מדור קודם של |
SENIOR |
|
senior |
כתובת אימייל חלופית מדור קודם של |
TicketRestrictions
ייצוג ב-JSON |
---|
{ "routeRestrictions": { object ( |
שדות | |
---|---|
routeRestrictions |
הגבלות על המסלולים שאפשר לנסוע בהם. לדוגמה, יכול להיות שהיא תהיה המחרוזת 'רכבות CrossCountry שמוזמנות בלבד'. |
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 |
המושבים שהוקצו לנוסעים. לדוגמה: 'no specific seat'. משמש כשאין מזהה ספציפי לשימוש ב- |
FareClass
טיפוסים בני מנייה (enum) | |
---|---|
FARE_CLASS_UNSPECIFIED |
|
ECONOMY |
|
economy |
כתובת אימייל חלופית מדור קודם של |
FIRST |
|
first |
כתובת אימייל חלופית מדור קודם של |
BUSINESS |
|
business |
כתובת אימייל חלופית מדור קודם של |
TripType
טיפוסים בני מנייה (enum) | |
---|---|
TRIP_TYPE_UNSPECIFIED |
|
ROUND_TRIP |
|
roundTrip |
כתובת אימייל חלופית מדור קודם של |
ONE_WAY |
|
oneWay |
כתובת אימייל חלופית מדור קודם של |
ActivationStatus
סטטוס ההפעלה של האובייקט. השדה הזה כולל את סטטוס ההפעלה אם הערך תומך בהפעלה.
ייצוג ב-JSON |
---|
{
"state": enum ( |
שדות | |
---|---|
state |
|
מדינה
טיפוסים בני מנייה (enum) | |
---|---|
UNKNOWN_STATE |
|
NOT_ACTIVATED |
לא הופעל, זהו סטטוס ברירת המחדל |
not_activated |
כתובת אימייל חלופית מדור קודם של |
ACTIVATED |
התכונה הופעלה |
activated |
כתובת אימייל חלופית מדור קודם של |
DeviceContext
ההקשר של המכשיר שמשויך לאובייקט.
ייצוג ב-JSON |
---|
{ "deviceToken": string } |
שדות | |
---|---|
deviceToken |
אם ההגדרה מוגדרת, פרטי המימוש יחזרו למכשיר הנתון רק אחרי הפעלת האובייקט. אין להשתמש בו כמזהה יציב למעקב אחרי מכשיר של משתמש. הוא יכול להשתנות בין כרטיסים שונים לאותו מכשיר, או אפילו בין הפעלות שונות של אותו כרטיס במכשיר. כשמגדירים את ההגדרה הזו, מבצעי הקריאה החוזרת צריכים גם להגדיר את hasLinkedDevice באובייקט שמופעל. |
Methods |
|
---|---|
|
הוספת הודעה לאובייקט המעבר שמשויך למזהה האובייקט הנתון. |
|
הפונקציה מחזירה את אובייקט המעבר עם מזהה האובייקט הנתון. |
|
הוספה של אובייקט מעבר עם המזהה והמאפיינים שצוינו. |
|
הפונקציה מחזירה רשימה של כל אובייקטי המעבר למזהה מנפיק נתון. |
|
עדכון של אובייקט המעבר שמוזכר במזהה האובייקט הנתון. |
|
עדכון של אובייקט המעבר שמוזכר במזהה האובייקט הנתון. |