- Ressource: TransitObject
- PassengerType
- TicketStatus
- ConcessionCategory
- TicketRestrictions
- PurchaseDetails
- TicketCost
- TicketLeg
- TicketSeat
- FareClass
- TripType
- ActivationStatus
- Bundesland
- DeviceContext
- Methoden
Ressource: TransitObject
JSON-Darstellung |
---|
{ "classReference": { object ( |
Felder | |
---|---|
classReference |
Eine Kopie der übernommenen Felder der übergeordneten Klasse. Diese Felder werden bei einem GET abgerufen. |
ticketNumber |
Die Nummer des Tickets. Dies ist eine eindeutige Kennung für das Ticket im System des Verkehrsunternehmens. |
passengerType |
Die Anzahl der Passagiere. |
passengerNames |
Die Namen der Passagiere, denen das Ticket zugewiesen ist. Das obige |
tripId |
Diese ID wird verwendet, um Tickets zu gruppieren, wenn der Nutzer mehrere Tickets für dieselbe Fahrt gespeichert hat. |
ticketStatus |
Der Status des Tickets. Verwenden Sie für Status, die sich auf die Anzeige auswirken, stattdessen das Feld |
customTicketStatus |
Ein benutzerdefinierter Status, der für den Ticketstatuswert verwendet wird, wenn |
concessionCategory |
Die Ermäßigungskategorie des Tickets. |
customConcessionCategory |
Eine benutzerdefinierte Ermäßigungskategorie, die verwendet werden soll, wenn |
ticketRestrictions |
Informationen zu den Einschränkungen bei der Nutzung dieses Tickets. z. B., an welchen Wochentagen sie verwendet werden müssen oder welche Routen sie nehmen dürfen. |
purchaseDetails |
Details zum Kauf dieses Tickets. |
ticketLeg |
Ein Abschnitt mit Einzeltickets enthält Informationen zu Abfahrt und Ankunft sowie Informationen zu Abfahrt und Sitzplatz. Wenn mehr als ein Streckenabschnitt angegeben werden soll, verwenden Sie stattdessen das Feld |
ticketLegs[] |
Jedes Ticket kann eine oder mehrere Streckenabschnitte enthalten. Für jeden Abschnitt sind Abfahrts- und Ankunftsinformationen sowie Informationen zum Boarding und zu den Sitzen verfügbar. Wenn nur ein Streckenabschnitt angegeben werden soll, verwenden Sie stattdessen das Feld |
hexBackgroundColor |
Die Hintergrundfarbe der Karte. Wenn nicht festgelegt, wird die Hauptfarbe des Hero-Images verwendet, und wenn kein Hero-Image festgelegt ist, wird die Hauptfarbe des Logos verwendet. Das Format ist #rrggbb, wobei rrggbb ein hexadezimales RGB-Triplet wie |
tripType |
Erforderlich. Die Art der Fahrt, die dieses Verkehrsobjekt darstellt. Wird verwendet, um den Titel der Karte bzw. das Ticket zu bestimmen, das zwischen Start- und Zielort verwendet werden soll. |
id |
Erforderlich. Die eindeutige Kennung für ein Objekt. Diese ID muss für alle Objekte eines Ausstellers eindeutig sein. Dieser Wert muss das Format issuer ID haben.identifier, bei denen ersteres von Google ausgestellt und Letzteres von Ihnen ausgewählt wird. Die eindeutige Kennung darf nur alphanumerische Zeichen, „.“, „_“ oder „-“ enthalten. |
classId |
Erforderlich. Die mit diesem Objekt verknüpfte Klasse. Die Klasse muss denselben Typ wie dieses Objekt haben, bereits vorhanden sein und genehmigt werden. Klassen-IDs müssen das Format issuer ID haben.identifier, bei denen ersteres von Google ausgestellt und Letzteres von Ihnen ausgewählt wird. |
version |
Eingestellte Funktionen |
state |
Erforderlich. Der Status des Objekts. Mit diesem Feld wird festgelegt, wie ein Objekt in der App angezeigt wird. Ein |
barcode |
Typ und Wert des Barcodes. |
messages[] |
Ein Array von Nachrichten, das in der App angezeigt wird. Alle Nutzer dieses Objekts erhalten die zugehörigen Nachrichten. Es sind maximal 10 Felder zulässig. |
validTimeInterval |
Der Zeitraum, in dem dieses Objekt |
locations[] |
Hinweis: Dieses Feld wird derzeit nicht zum Auslösen von Geo-Benachrichtigungen unterstützt. |
hasUsers |
Gibt an, ob das Objekt Nutzer hat. Dieses Feld wird von der Plattform festgelegt. |
smartTapRedemptionValue |
Der Wert, der für dieses Objekt über NFC an ein Smart-Bonus-zertifiziertes Terminal übertragen wird. Die Felder auf Klassenebene |
hasLinkedDevice |
Gibt an, ob dieses Objekt derzeit mit einem einzelnen Gerät verknüpft ist. Dieses Feld wird von der Plattform festgelegt, wenn ein Nutzer das Objekt speichert und mit seinem Gerät verknüpft. Zur Verwendung durch ausgewählte Partner vorgesehen. Weitere Informationen erhalten Sie beim Support. |
disableExpirationNotification |
Gibt an, ob Benachrichtigungen explizit unterdrückt werden sollen. Wenn dieses Feld unabhängig vom Feld Derzeit kann dies nur für Angebote festgelegt werden. |
infoModuleData |
Veraltet. Verwende stattdessen „textModulesData“. |
imageModulesData[] |
Bildmoduldaten. Es werden maximal 1 Feld auf Objektebene und 1 Feld auf Klassenobjektebene angezeigt. |
textModulesData[] |
Textmoduldaten. Wenn für die Klasse auch Textmoduldaten definiert sind, werden beide angezeigt. Es werden maximal 10 Felder aus dem Objekt und 10 aus der Klasse angezeigt. |
linksModuleData |
Linkmoduldaten. Wenn für die Klasse auch Daten des Linkmoduls definiert sind, werden beide angezeigt. |
appLinkData |
Optionaler App- oder Website-Link, der als Schaltfläche auf der Vorderseite der Karte bzw. des Tickets angezeigt wird. Wenn „AppLinkData“ für die entsprechende Klasse angegeben ist, wird nur das AppLinkData-Objekt angezeigt. |
activationStatus |
Der Aktivierungsstatus für das Objekt. Erforderlich, wenn für die Klasse |
rotatingBarcode |
Typ und Wert des rotierenden Barcodes. |
deviceContext |
Mit dem Objekt verknüpfter Gerätekontext. |
heroImage |
Optionales Bannerbild, das auf der Vorderseite der Karte angezeigt wird. Ist keins vorhanden, wird, sofern vorhanden, das Hero-Image des Kurses angezeigt. Wenn das Hero-Image des Kurses ebenfalls nicht vorhanden ist, wird nichts angezeigt. |
groupingInfo |
Informationen, die steuern, wie Karten/Tickets gruppiert werden. |
passConstraints |
Übergeben Sie Einschränkungen für das Objekt. Umfasst das Einschränken von NFC- und Screenshot-Verhalten. |
PassengerType
Enums | |
---|---|
PASSENGER_TYPE_UNSPECIFIED |
|
SINGLE_PASSENGER |
|
singlePassenger |
Altes Alias für |
MULTIPLE_PASSENGERS |
|
multiplePassengers |
Altes Alias für |
TicketStatus
Enums | |
---|---|
TICKET_STATUS_UNSPECIFIED |
|
USED |
|
used |
Altes Alias für |
REFUNDED |
|
refunded |
Altes Alias für |
EXCHANGED |
|
exchanged |
Altes Alias für |
ConcessionCategory
Enums | |
---|---|
CONCESSION_CATEGORY_UNSPECIFIED |
|
ADULT |
|
adult |
Altes Alias für |
CHILD |
|
child |
Altes Alias für |
SENIOR |
|
senior |
Altes Alias für |
TicketRestrictions
JSON-Darstellung |
---|
{ "routeRestrictions": { object ( |
Felder | |
---|---|
routeRestrictions |
Einschränkungen für Routen, die befahren werden können. Das könnte z. B. der String „Reservierte CrossCountry-Züge“ sein. |
routeRestrictionsDetails |
Weitere Details zu den |
timeRestrictions |
Einschränkungen hinsichtlich der Zeiten, zu denen dieses Ticket verwendet werden kann. |
otherRestrictions |
Zusätzliche Einschränkungen, die nicht unter die Kategorien „Route“ oder „Zeit“ fallen. |
PurchaseDetails
JSON-Darstellung |
---|
{
"purchaseReceiptNumber": string,
"purchaseDateTime": string,
"accountId": string,
"confirmationCode": string,
"ticketCost": {
object ( |
Felder | |
---|---|
purchaseReceiptNumber |
Belegnummer/-Kennung zur Nachverfolgung des Ticketkaufs über die Person, über die das Ticket verkauft wurde. |
purchaseDateTime |
Datum und Uhrzeit des Ticketkaufs. Datum/Uhrzeit im erweiterten ISO 8601-Format mit oder ohne Offset. Die Zeit kann bis auf die Nanosekunde genau angegeben werden. Offsets können sekundengenau angegeben werden (obwohl Offset-Sekunden nicht Teil von ISO 8601 sind). Beispiel:
Ohne Offset-Informationen sind einige Rich-Funktionen möglicherweise nicht verfügbar. |
accountId |
ID des Kontos, über das das Ticket gekauft wurde. |
confirmationCode |
Der Bestätigungscode für den Kauf. Dieser kann für mehrere Tickets gleich sein und wird verwendet, um Tickets zu gruppieren. |
ticketCost |
Die Kosten des Tickets. |
TicketCost
JSON-Darstellung |
---|
{ "faceValue": { object ( |
Felder | |
---|---|
faceValue |
Der Nennwert des Tickets. |
purchasePrice |
Der tatsächliche Kaufpreis des Tickets nach Abzug von Steuern und/oder Rabatten. |
discountMessage |
Eine Meldung, in der alle Arten von Rabatten beschrieben werden, die angewendet wurden. |
TicketLeg
JSON-Darstellung |
---|
{ "originStationCode": string, "originName": { object ( |
Felder | |
---|---|
originStationCode |
Der Code der Startstation. Dies ist erforderlich, wenn |
originName |
Der Name der Startstation. Dies ist erforderlich, wenn |
destinationStationCode |
Der Code der Zielhaltestelle. |
destinationName |
Der Name des Ziels. |
departureDateTime |
Datum und Uhrzeit der Abreise. Dies ist erforderlich, wenn für das Verkehrsobjekt kein Gültigkeitszeitintervall festgelegt ist. Datum/Uhrzeit im erweiterten ISO 8601-Format mit oder ohne Offset. Die Zeit kann bis auf die Nanosekunde genau angegeben werden. Offsets können sekundengenau angegeben werden (obwohl Offset-Sekunden nicht Teil von ISO 8601 sind). Beispiel:
Der Teil der Datums-/Uhrzeitangabe ohne Offset wird als „lokales Datum/die lokale Uhrzeit“ betrachtet. Dabei sollte es sich um das örtliche Datum und die lokale Uhrzeit an der Startstation handeln. Wenn die Abfahrt beispielsweise um die 20. Stunde am 5. Juni 2018 an der Startstation erfolgt, sollte der lokale Datums-/Uhrzeitteil Ohne Offset-Informationen sind einige Rich-Funktionen möglicherweise nicht verfügbar. |
arrivalDateTime |
Datum und Uhrzeit Ihrer Ankunft. Datum/Uhrzeit im erweiterten ISO 8601-Format mit oder ohne Offset. Die Zeit kann bis auf die Nanosekunde genau angegeben werden. Offsets können sekundengenau angegeben werden (obwohl Offset-Sekunden nicht Teil von ISO 8601 sind). Beispiel:
Der Teil der Datums-/Uhrzeitangabe ohne Offset wird als „lokales Datum/die lokale Uhrzeit“ betrachtet. Dabei sollte es sich um das örtliche Datum und die Ortszeit an der Zielstation handeln. Wenn die Veranstaltung beispielsweise um die 20. Stunde am 5. Juni 2018 an der Zielstation stattfindet, sollte der lokale Datums-/Uhrzeitteil Ohne Offset-Informationen sind einige Rich-Funktionen möglicherweise nicht verfügbar. |
fareName |
Kurze Beschreibung/Name des Fahrpreises für diese Fahrtstrecke. z. B. „Jederzeit Einmalgebrauch“. |
carriage |
Der Name/die Nummer des Zugs oder Schiffs, die der Fahrgast für das Einsteigen benötigt. |
platform |
Bahnsteig oder Gate, an dem der Fahrgast einsteigen kann. |
zone |
Die Zone des Einstiegs auf dem Bahnsteig. |
ticketSeat |
Der für den Passagier bzw. die Passagiere reservierte Sitzplatz. Wenn mehr als ein Platz angegeben werden soll, verwenden Sie stattdessen das Feld |
ticketSeats[] |
Der für den Passagier bzw. die Passagiere reservierte Sitzplatz. Wenn nur ein Sitz angegeben werden soll, verwenden Sie stattdessen das Feld |
transitOperatorName |
Der Name des Verkehrsunternehmens, das diesen Abschnitt einer Fahrt durchführt. |
transitTerminusName |
Endhaltestelle oder Ziel des Zugs/Busses usw. |
TicketSeat
JSON-Darstellung |
---|
{ "fareClass": enum ( |
Felder | |
---|---|
fareClass |
Die Preisklasse des lizenzierten Sitzplatzes. |
customFareClass |
Eine kundenspezifische Preisklasse, die verwendet wird, wenn keine |
coach |
Die Kennung des Zugwaggons oder Reisebusses, in dem sich der fahrkartenpflichtige Sitzplatz befindet. z. B. „10“ |
seat |
Die ID, wo sich der kostenpflichtige Sitzplatz befindet. z. B. „42“. Wenn es keine bestimmte Kennung gibt, verwenden Sie stattdessen |
seatAssignment |
Die Sitzbelegung des Passagiers. z. B. „kein bestimmter Sitzplatz“. Zu verwenden, wenn in |
FareClass
Enums | |
---|---|
FARE_CLASS_UNSPECIFIED |
|
ECONOMY |
|
economy |
Altes Alias für |
FIRST |
|
first |
Altes Alias für |
BUSINESS |
|
business |
Altes Alias für |
TripType
Enums | |
---|---|
TRIP_TYPE_UNSPECIFIED |
|
ROUND_TRIP |
|
roundTrip |
Altes Alias für |
ONE_WAY |
|
oneWay |
Altes Alias für |
ActivationStatus
Der Aktivierungsstatus des Objekts. Dieses Feld enthält den Aktivierungsstatus, sofern dieser die Aktivierung unterstützt.
JSON-Darstellung |
---|
{
"state": enum ( |
Felder | |
---|---|
state |
|
Status
Enums | |
---|---|
UNKNOWN_STATE |
|
NOT_ACTIVATED |
Nicht aktiviert, das ist der Standardstatus |
not_activated |
Altes Alias für |
ACTIVATED |
Aktiviert |
activated |
Altes Alias für |
DeviceContext
Mit dem Objekt verknüpfter Gerätekontext.
JSON-Darstellung |
---|
{ "deviceToken": string } |
Felder | |
---|---|
deviceToken |
Wenn festgelegt, werden Einlösungsinformationen nur bei Aktivierung des Objekts an das angegebene Gerät zurückgegeben. Sie sollte nicht als stabile Kennung zum Nachverfolgen des Geräts eines Nutzers verwendet werden. Sie kann sich bei verschiedenen Karten/Tickets für dasselbe Gerät oder sogar bei verschiedenen Aktivierungen für dasselbe Gerät ändern. Bei dieser Einstellung müssen Anrufer auch hasLinkedDevice für das zu aktivierende Objekt festlegen. |
Methoden |
|
---|---|
|
Fügt dem Transitobjekt, auf das die angegebene Objekt-ID verweist, eine Nachricht hinzu. |
|
Gibt das Verkehrsobjekt mit der angegebenen Objekt-ID zurück |
|
Fügt ein Verkehrsobjekt mit der angegebenen ID und Eigenschaften ein. |
|
Gibt eine Liste aller Verkehrsobjekte für eine bestimmte Aussteller-ID zurück. |
|
Aktualisiert das Verkehrsobjekt, auf das die angegebene Objekt-ID verweist. |
|
Aktualisiert das Verkehrsobjekt, auf das die angegebene Objekt-ID verweist. |