REST Resource: transitobject

משאב: TransitObject

ייצוג JSON 
{
  "classReference": {
    object (TransitClass)
  },
  "ticketNumber": string,
  "passengerType": enum (PassengerType),
  "passengerNames": string,
  "tripId": string,
  "ticketStatus": enum (TicketStatus),
  "customTicketStatus": {
    object (LocalizedString)
  },
  "concessionCategory": enum (ConcessionCategory),
  "customConcessionCategory": {
    object (LocalizedString)
  },
  "ticketRestrictions": {
    object (TicketRestrictions)
  },
  "purchaseDetails": {
    object (PurchaseDetails)
  },
  "ticketLeg": {
    object (TicketLeg)
  },
  "ticketLegs": [
    {
      object (TicketLeg)
    }
  ],
  "hexBackgroundColor": string,
  "tripType": enum (TripType),
  "id": string,
  "classId": string,
  "version": string,
  "state": enum (State),
  "barcode": {
    object (Barcode)
  },
  "messages": [
    {
      object (Message)
    }
  ],
  "validTimeInterval": {
    object (TimeInterval)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "hasUsers": boolean,
  "smartTapRedemptionValue": string,
  "hasLinkedDevice": boolean,
  "disableExpirationNotification": boolean,
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "appLinkData": {
    object (AppLinkData)
  },
  "activationStatus": {
    object (ActivationStatus)
  },
  "rotatingBarcode": {
    object (RotatingBarcode)
  },
  "deviceContext": {
    object (DeviceContext)
  },
  "heroImage": {
    object (Image)
  },
  "groupingInfo": {
    object (GroupingInfo)
  },
  "passConstraints": {
    object (PassConstraints)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  }
}
שדות
classReference

object (TransitClass)

עותק של השדות שעברו בירושה של מחלקת ההורה. השדות האלה מאוחזרים במהלך אחזור נתונים (GET).
ticketNumber

string

מספר הכרטיס. זהו מזהה ייחודי של הכרטיס במערכת של חברת התחבורה הציבורית.
passengerType

enum (PassengerType)

מספר הנוסעים.
passengerNames

string

שמות הנוסעים שאליהם הוקצה הכרטיס. השדה passengerType שלמעלה נועד לספק ל-Google הקשר לגבי השדה הזה.
tripId

string

המזהה הזה משמש לקיבוץ כרטיסים אם המשתמש שמר כמה כרטיסים לאותה נסיעה.
ticketStatus

enum (TicketStatus)

הסטטוס של הכרטיס. למצבים שמשפיעים על תצוגה, צריך להשתמש בשדה state.
customTicketStatus

object (LocalizedString)

סטטוס מותאם אישית לשימוש בערך של סטטוס הכרטיס כאשר ticketStatus לא מספק את האפשרות הנכונה. לא ניתן להגדיר גם את ticketStatus וגם את customTicketStatus.
concessionCategory

enum (ConcessionCategory)

קטגוריית המזנונים של הכרטיס.
customConcessionCategory

object (LocalizedString)

קטגוריית מזנונים מותאמת אישית לשימוש במקרים שבהם concessionCategory לא מספקת את האפשרות הנכונה. לא ניתן להגדיר גם את concessionCategory וגם את customConcessionCategory.
ticketRestrictions

object (TicketRestrictions)

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

object (PurchaseDetails)

פרטי הרכישה של הכרטיס הזה.
ticketLeg

object (TicketLeg)

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

object (TicketLeg)

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

string

צבע הרקע של הכרטיס. אם לא מגדירים את הצבע הדומיננטי של התמונה הראשית (Hero), משתמשים בתמונה הראשית (Hero) אם לא הגדרתם את הצבע הדומיננטי של הלוגו. הפורמט הוא #rrggbb, כאשר rrggbb הוא שלשה הקסדצימלית של RGB, למשל #ffcc00. אפשר גם להשתמש בגרסה המקוצרת של משולש ה-RGB שהיא #rgb, למשל #fc0.
tripType

enum (TripType)

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

string

חובה. המזהה הייחודי של האובייקט. המזהה הזה חייב להיות ייחודי בכל האובייקטים של המנפיק. הערך צריך להיות בפורמט issuer ID.identifier כאשר הראשון הונפק על ידי Google והאחרון נבחר על ידך. המזהה הייחודי יכול לכלול רק תווים אלפאנומריים, '.', '_' או '-'.
classId

string

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

מזהי הכיתות צריכים להיות בפורמט issuer ID.identifier כאשר הראשון הונפק על ידי Google והאחרון נבחר על ידך.
version
(deprecated)

string (int64 format)

הוצא משימוש
state

enum (State)

חובה. מצב האובייקט. השדה הזה משמש לקביעת האופן שבו האובייקט יוצג באפליקציה. לדוגמה, אובייקט inactive מועבר אל 'כרטיסים שפג תוקפם'. .
barcode

object (Barcode)

סוג הברקוד והערך שלו.
messages[]

object (Message)

מערך של הודעות שמוצגות באפליקציה. כל המשתמשים באובייקט הזה יקבלו את ההודעות שמשויכות אליו. אפשר להוסיף עד 10 שדות כאלה.
validTimeInterval

object (TimeInterval)

תקופת הזמן של האובייקט הזה תהיה active ואפשר להשתמש באובייקט. המצב של אובייקט ישתנה ל-expired לאחר פרק הזמן הזה.
locations[]

object (LatLongPoint)

הערה: השדה הזה לא נתמך כרגע להפעלת התראות גיאוגרפיות.
hasUsers

boolean

מציין אם לאובייקט יש משתמשים. השדה הזה מוגדר על ידי הפלטפורמה.
smartTapRedemptionValue

string

הערך שיועבר למסוף שאושר על ידי Smart Tap דרך NFC עבור האובייקט הזה. גם השדות enableSmartTap ו-redemptionIssuers ברמת הכיתה צריכים להיות מוגדרים כראוי כדי שכרטיס התמיכה יתמוך בתכונה 'הקשה חכמה'. יש תמיכה רק בתווי ASCII.
hasLinkedDevice

boolean

האם האובייקט הזה מקושר כרגע למכשיר אחד. השדה הזה מוגדר על ידי הפלטפורמה כשמשתמש שומר את האובייקט, והוא מקשר אותו למכשיר שלו. מיועד לשימוש של שותפים נבחרים. לקבלת מידע נוסף, אפשר לפנות לתמיכה.
disableExpirationNotification

boolean

השדה הזה מציין אם צריך להסתיר את ההתראות באופן מפורש. אם השדה הזה מוגדר כ-True, ללא קשר לשדה messages, התראות תפוגה למשתמש יבוטלו. כברירת מחדל, השדה הזה מוגדר כ-False.

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

object (InfoModuleData)

הוצא משימוש. במקומו צריך להשתמש ב-textModulesData.
imageModulesData[]

object (ImageModuleData)

נתונים של מודול התמונה. המספר המקסימלי של השדות האלה שמוצג הוא 1 ברמת האובייקט ו-1 ברמת אובייקט המחלקה.
textModulesData[]

object (TextModuleData)

נתונים של מודול הטקסט. אם גם נתוני מודול הטקסט מוגדרים במחלקה, שניהם יוצגו. מספר השדות המקסימלי שמוצג הוא 10 מהאובייקט ו-10 מהמחלקה.
activationStatus

object (ActivationStatus)

סטטוס ההפעלה של האובייקט. חובה אם בכיתה activationOptions מוגדרת.
rotatingBarcode

object (RotatingBarcode)

הסוג והערך של הברקוד המסתובב.
deviceContext

object (DeviceContext)

ההקשר של המכשיר שמשויך לאובייקט.
heroImage

object (Image)

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

object (GroupingInfo)

מידע שקובע איך הכרטיסים מקובצים יחד.
passConstraints

object (PassConstraints)

העברת האילוצים על האובייקט. כולל הגבלת התנהגויות של NFC וצילומי מסך.
saveRestrictions

object (SaveRestrictions)

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

PassengerType

טיפוסים בני מנייה (enum)
PASSENGER_TYPE_UNSPECIFIED
SINGLE_PASSENGER
singlePassenger

כינוי קודם של SINGLE_PASSENGER. הוצא משימוש.
MULTIPLE_PASSENGERS
multiplePassengers

כינוי קודם של MULTIPLE_PASSENGERS. הוצא משימוש.

TicketStatus

טיפוסים בני מנייה (enum)
TICKET_STATUS_UNSPECIFIED
USED
used

כינוי קודם של USED. הוצא משימוש.
REFUNDED
refunded

כינוי קודם של REFUNDED. הוצא משימוש.
EXCHANGED
exchanged

כינוי קודם של EXCHANGED. הוצא משימוש.

ConcessionCategory

טיפוסים בני מנייה (enum)
CONCESSION_CATEGORY_UNSPECIFIED
ADULT
adult

כינוי קודם של ADULT. הוצא משימוש.
CHILD
child

כינוי קודם של CHILD. הוצא משימוש.
SENIOR
senior

כינוי קודם של SENIOR. הוצא משימוש.

TicketRestrictions

ייצוג JSON 
{
  "routeRestrictions": {
    object (LocalizedString)
  },
  "routeRestrictionsDetails": {
    object (LocalizedString)
  },
  "timeRestrictions": {
    object (LocalizedString)
  },
  "otherRestrictions": {
    object (LocalizedString)
  }
}
שדות
routeRestrictions

object (LocalizedString)

הגבלות על מסלולים אפשריים. לדוגמה, זו יכולה להיות המחרוזת 'רכבות חוצות-מדינה בלבד'.
routeRestrictionsDetails

object (LocalizedString)

פרטים נוספים על routeRestrictions שצוינו למעלה.
timeRestrictions

object (LocalizedString)

הגבלות על זמני השימוש בכרטיס הזה.
otherRestrictions

object (LocalizedString)

הגבלות נוספות שלא נכללות ב'מסלול' או 'time' קטגוריות.

PurchaseDetails

ייצוג JSON 
{
  "purchaseReceiptNumber": string,
  "purchaseDateTime": string,
  "accountId": string,
  "confirmationCode": string,
  "ticketCost": {
    object (TicketCost)
  }
}
שדות
purchaseReceiptNumber

string

מספר קבלה/מזהה למעקב אחרי רכישת הכרטיס דרך הגוף שמכר את הכרטיס.
purchaseDateTime

string

התאריך/השעה של רכישת הכרטיס.

זהו תאריך/שעה בפורמט מורחב לפי תקן ISO 8601, עם או בלי קיזוז. ניתן לציין זמן עד לרמת דיוק של ננו-שנייה. אפשר לציין היסט בדיוק בשניות (למרות ששניות היסט הן חלק מתקן ISO 8601).

לדוגמה:

1985-04-12T23:20:50.52Z יהיה 20 דקות ו-50.52 שניות אחרי השעה ה-23 של 12 באפריל 1985 לפי שעון UTC.

1985-04-12T19:20:50.52-04:00 יהיה 20 דקות ו-50.52 שניות אחרי השעה ה-19 של 12 באפריל 1985, 4 שעות לפני שעון UTC (אותה נקודת זמן כמו בדוגמה שלמעלה). אם האירוע היה בניו יורק, הוא היה מקביל לשעון קיץ של החוף המזרחי (EDT). חשוב לזכור שההיסט שונה באזורים שבהם יש שעון קיץ (או שעון קיץ), בהתאם לעונה בשנה.

1985-04-12T19:20:50.52 יהיה 20 דקות ו-50.52 שניות אחרי השעה ה-19 של 12 באפריל 1985, ללא מידע על היסט.

בלי מידע על היסט, יכול להיות שחלק מהתכונות המתקדמות לא יהיו זמינות.
accountId

string

המספר של החשבון שדרכו בוצעה רכישת הכרטיס.
confirmationCode

string

קוד האישור של הרכישה. הערך הזה יכול להיות זהה לכמה כרטיסים שונים, והוא משמש לקיבוץ הכרטיסים יחד.
ticketCost

object (TicketCost)

עלות הכרטיס.

TicketCost

ייצוג JSON 
{
  "faceValue": {
    object (Money)
  },
  "purchasePrice": {
    object (Money)
  },
  "discountMessage": {
    object (LocalizedString)
  }
}
שדות
faceValue

object (Money)

הערך המקורי של הכרטיס.
purchasePrice

object (Money)

מחיר הרכישה בפועל של הכרטיס, אחרי מיסים ו/או הנחות.
discountMessage

object (LocalizedString)

הודעה שמתארת כל סוג של הנחה שהוחלה.

TicketLeg

ייצוג JSON 
{
  "originStationCode": string,
  "originName": {
    object (LocalizedString)
  },
  "destinationStationCode": string,
  "destinationName": {
    object (LocalizedString)
  },
  "departureDateTime": string,
  "arrivalDateTime": string,
  "fareName": {
    object (LocalizedString)
  },
  "carriage": string,
  "platform": string,
  "zone": string,
  "ticketSeat": {
    object (TicketSeat)
  },
  "ticketSeats": [
    {
      object (TicketSeat)
    }
  ],
  "transitOperatorName": {
    object (LocalizedString)
  },
  "transitTerminusName": {
    object (LocalizedString)
  }
}
שדות
originStationCode

string

הקוד של תחנת המוצא. הפעולה הזו נדרשת אם השדה destinationStationCode קיים או אם originName לא קיים.
originName

object (LocalizedString)

השם של תחנת המקור. הפעולה הזו נדרשת אם השדה desinationName קיים או אם originStationCode לא קיים.
destinationStationCode

string

קוד תחנת היעד.
destinationName

object (LocalizedString)

שם היעד.
departureDateTime

string

התאריך/שעת היציאה. הדרישה הזו נדרשת אם לא הוגדר מרווח זמן בתוקף לאובייקט המעבר.

זהו תאריך/שעה בפורמט מורחב לפי תקן ISO 8601, עם או בלי קיזוז. ניתן לציין זמן עד לרמת דיוק של ננו-שנייה. אפשר לציין היסט בדיוק בשניות (למרות ששניות היסט הן חלק מתקן ISO 8601).

לדוגמה:

1985-04-12T23:20:50.52Z יהיה 20 דקות ו-50.52 שניות אחרי השעה ה-23 של 12 באפריל 1985 לפי שעון UTC.

1985-04-12T19:20:50.52-04:00 יהיה 20 דקות ו-50.52 שניות אחרי השעה ה-19 של 12 באפריל 1985, 4 שעות לפני שעון UTC (אותה נקודת זמן כמו בדוגמה שלמעלה). אם האירוע היה בניו יורק, הוא היה מקביל לשעון קיץ של החוף המזרחי (EDT). חשוב לזכור שההיסט שונה באזורים שבהם יש שעון קיץ (או שעון קיץ), בהתאם לעונה בשנה.

1985-04-12T19:20:50.52 יהיה 20 דקות ו-50.52 שניות אחרי השעה ה-19 של 12 באפריל 1985, ללא מידע על היסט.

החלק של התאריך/השעה ללא הקיזוז נחשב כ"תאריך/שעה מקומיים". הערך הזה צריך להיות התאריך והשעה המקומיים בתחנת המוצא. לדוגמה, אם היציאה מתרחשת בשעה ה-20 של 5 ביוני 2018 בתחנת המוצא, החלק של התאריך המקומי צריך להיות 2018-06-05T20:00:00. אם התאריך והשעה המקומיים בתחנת המוצא הם 4 שעות לפני שעון UTC, ייתכן שיתווסף קיזוז של -04:00.

בלי מידע על היסט, יכול להיות שחלק מהתכונות המתקדמות לא יהיו זמינות.
arrivalDateTime

string

התאריך/השעה של ההגעה.

זהו תאריך/שעה בפורמט מורחב לפי תקן ISO 8601, עם או בלי קיזוז. ניתן לציין זמן עד לרמת דיוק של ננו-שנייה. אפשר לציין היסט בדיוק בשניות (למרות ששניות היסט הן חלק מתקן ISO 8601).

לדוגמה:

1985-04-12T23:20:50.52Z יהיה 20 דקות ו-50.52 שניות אחרי השעה ה-23 של 12 באפריל 1985 לפי שעון UTC.

1985-04-12T19:20:50.52-04:00 יהיה 20 דקות ו-50.52 שניות אחרי השעה ה-19 של 12 באפריל 1985, 4 שעות לפני שעון UTC (אותה נקודת זמן כמו בדוגמה שלמעלה). אם האירוע היה בניו יורק, הוא היה מקביל לשעון קיץ של החוף המזרחי (EDT). חשוב לזכור שההיסט שונה באזורים שבהם יש שעון קיץ (או שעון קיץ), בהתאם לעונה בשנה.

1985-04-12T19:20:50.52 יהיה 20 דקות ו-50.52 שניות אחרי השעה ה-19 של 12 באפריל 1985, ללא מידע על היסט.

החלק של התאריך/השעה ללא הקיזוז נחשב כ"תאריך/שעה מקומיים". התאריך הזה צריך להיות התאריך והשעה המקומיים בתחנת היעד. לדוגמה, אם האירוע מתרחש בשעה ה-20 של 5 ביוני 2018 בתחנת היעד, החלק של התאריך המקומי צריך להיות 2018-06-05T20:00:00. אם התאריך והשעה המקומיים בתחנת היעד הם 4 שעות לפני שעון UTC, ייתכן שיתווסף קיזוז של -04:00.

בלי מידע על היסט, יכול להיות שחלק מהתכונות המתקדמות לא יהיו זמינות.
fareName

object (LocalizedString)

תיאור קצר/שם של מחיר הכרטיס לנסיעה הזו. לדוגמה, 'בכל זמן שהוא לשימוש חד-פעמי'.
carriage

string

השם/המספר של הרכבת או החללית שהכרטיס צריך לעלות.
platform

string

הרציף או השער שבהם הנוסע יכול לעלות לרכבת.
zone

string

אזור העלייה למטוס בתוך הפלטפורמה.
ticketSeat

object (TicketSeat)

המושב השמור לנוסעים. אם מציינים יותר ממושב אחד, צריך להשתמש בשדה ticketSeats. לא ניתן להגדיר גם את ticketSeat וגם את ticketSeats.
ticketSeats[]

object (TicketSeat)

המושב השמור לנוסעים. אם מציינים מושב אחד בלבד, צריך להשתמש בשדה ticketSeat. לא ניתן להגדיר גם את ticketSeat וגם את ticketSeats.
transitOperatorName

object (LocalizedString)

השם של חברת התחבורה הציבורית שמשתמשת בחלק הזה של הנסיעה.
transitTerminusName

object (LocalizedString)

תחנת הרכבת/האוטובוס וכו'

TicketSeat

ייצוג JSON 
{
  "fareClass": enum (FareClass),
  "customFareClass": {
    object (LocalizedString)
  },
  "coach": string,
  "seat": string,
  "seatAssignment": {
    object (LocalizedString)
  }
}
שדות
fareClass

enum (FareClass)

מחלקה של מחיר הכרטיס למושב בכרטיס.
customFareClass

object (LocalizedString)

סיווג מותאם אישית של מחיר כרטיסים אם לא חל עליו fareClass. לא ניתן להגדיר גם את fareClass וגם את customFareClass.
coach

string

המזהה של קרון הרכבת או הקרון שבו נמצא המושב שקיבל הכרטיס. לדוגמה: '10'
seat

string

המזהה של המיקום שבו נמצא המושב שנרכש. לדוגמה: '42'. אם אין מזהה ספציפי, צריך להשתמש ב-seatAssigment במקום זאת.
seatAssignment

object (LocalizedString)

מושב הנוסע לדוגמה: "אין מושב ספציפי". לשימוש כשאין מזהה ספציפי שאפשר להשתמש בו ב-seat.

FareClass

טיפוסים בני מנייה (enum)
FARE_CLASS_UNSPECIFIED
ECONOMY
economy

כינוי קודם של ECONOMY. הוצא משימוש.
FIRST
first

כינוי קודם של FIRST. הוצא משימוש.
BUSINESS
business

כינוי קודם של BUSINESS. הוצא משימוש.

TripType

טיפוסים בני מנייה (enum)
TRIP_TYPE_UNSPECIFIED
ROUND_TRIP
roundTrip

כינוי קודם של ROUND_TRIP. הוצא משימוש.
ONE_WAY
oneWay

כינוי קודם של ONE_WAY. הוצא משימוש.

ActivationStatus

סטטוס ההפעלה של האובייקט. השדה הזה כולל את סטטוס ההפעלה אם הוא תומך בהפעלה.

ייצוג JSON 
{
  "state": enum (State)
}
שדות
state

enum (State)

מדינה

טיפוסים בני מנייה (enum)
UNKNOWN_STATE
NOT_ACTIVATED לא מופעל. זהו סטטוס ברירת המחדל
not_activated

כינוי קודם של NOT_ACTIVATED. הוצא משימוש.
ACTIVATED התכונה הופעלה
activated

כינוי קודם של ACTIVATED. הוצא משימוש.

DeviceContext

ההקשר של המכשיר שמשויך לאובייקט.

ייצוג JSON 
{
  "deviceToken": string
}
שדות
deviceToken

string

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

שיטות

addmessage

 הפונקציה מוסיפה הודעה לאובייקט המעבר שאליו מפנה מזהה האובייקט הנתון.

get

 מחזירה את אובייקט התעבורה עם מזהה האובייקט הנתון.

insert

 מוסיפה אובייקט מעבר עם המזהה והמאפיינים הנתונים.

list

 מחזירה רשימה של כל אובייקטי התחבורה עבור מזהה מנפיק נתון.

patch

 מעדכן את אובייקט המעבר שאליו מפנה מזהה האובייקט הנתון.

update

 מעדכן את אובייקט המעבר שאליו מפנה מזהה האובייקט הנתון.