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)
  }
}
שדות
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

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

הערך שיועבר למסוף מאושר בהקשה חכמה ב-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 וצילומי מסך.

PassengerType

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

כתובת אימייל חלופית מדור קודם של SINGLE_PASSENGER. הוּצא משימוש.
MULTIPLE_PASSENGERS
multiplePassengers

כתובת אימייל חלופית מדור קודם של MULTIPLE_PASSENGERS. הוּצא משימוש.

TicketStatus

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

כתובת אימייל חלופית מדור קודם של USED. הוּצא משימוש.
REFUNDED
refunded

כתובת אימייל חלופית מדור קודם של REFUNDED. הוּצא משימוש.
EXCHANGED
exchanged

כתובת אימייל חלופית מדור קודם של EXCHANGED. הוּצא משימוש.

ConcessionCategory

טיפוסים בני מנייה (enums)
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)

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

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 באפריל 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 באפריל 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 באפריל 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

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

כתובת אימייל חלופית מדור קודם של ECONOMY. הוּצא משימוש.
FIRST
first

כתובת אימייל חלופית מדור קודם של FIRST. הוּצא משימוש.
BUSINESS
business

כתובת אימייל חלופית מדור קודם של BUSINESS. הוּצא משימוש.

TripType

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

כתובת אימייל חלופית מדור קודם של ROUND_TRIP. הוּצא משימוש.
ONE_WAY
oneWay

כתובת אימייל חלופית מדור קודם של ONE_WAY. הוּצא משימוש.

ActivationStatus

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

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

enum (State)

ארץ

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

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

כתובת אימייל חלופית מדור קודם של ACTIVATED. הוּצא משימוש.

DeviceContext

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

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

string

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

שיטות

addmessage

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

get

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

insert

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

list

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

patch

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

update

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