- 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-Vorgang abgerufen. |
ticketNumber |
Die Ticketnummer. Dies ist eine eindeutige Kennung für das Ticket im System des Verkehrsunternehmens. |
passengerType |
Die Anzahl der Passagiere. |
passengerNames |
Der Name bzw. die Namen der Fahrgäste, denen das Ticket zugewiesen ist. Das Feld |
tripId |
Anhand dieser ID werden Tickets gruppiert, 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 Ticketstatus verwendet werden soll, wenn |
concessionCategory |
Die Ermäßigungskategorie für das Ticket. |
customConcessionCategory |
Eine benutzerdefinierte Kulanzzusage, die verwendet werden soll, wenn |
ticketRestrictions |
Informationen zu den Einschränkungen bei der Verwendung dieses Tickets. Beispielsweise, an welchen Wochentagen sie verwendet werden muss oder welche Routen zulässig sind. |
purchaseDetails |
Details zum Kauf dieses Tickets. |
ticketLeg |
Ein einzelner Flugabschnitt enthält Abflug- und Ankunftsinformationen sowie Informationen zum Einsteigen und zum Sitzplatz. Wenn mehr als ein Abschnitt angegeben werden soll, verwenden Sie stattdessen das Feld |
ticketLegs[] |
Jedes Ticket kann einen oder mehrere Abschnitte enthalten. Jeder Abschnitt enthält Informationen zu Abfahrt und Ankunft sowie zu Ein- und Ausstieg und Sitzplatz. Wenn nur ein Abschnitt angegeben werden soll, verwenden Sie stattdessen das Feld |
hexBackgroundColor |
Die Hintergrundfarbe der Karte bzw. des Tickets. Falls 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 ist, z. B. |
tripType |
Erforderlich. Die Art der Fahrt, die dieses Verkehrsobjekt darstellt. Legt den Titel der Karte/des Tickets und/oder das Symbol zwischen Startpunkt und Ziel fest. |
id |
Erforderlich. Die eindeutige Kennung für ein Objekt. Diese ID muss für alle Objekte eines Ausstellers eindeutig sein. Dieser Wert sollte das Format issuer ID haben.identifier, wobei von Google ausgegeben und von dir ausgewählt wird. Die eindeutige Kennung darf nur alphanumerische Zeichen, „.“ (Punkt), „_“ (Unterstrich) oder „-“ (Bindestriche) enthalten. |
classId |
Erforderlich. Die Klasse, die mit diesem Objekt verknüpft ist. Die Klasse muss vom selben Typ wie dieses Objekt sein, bereits vorhanden und genehmigt sein. Klassen-IDs müssen dem Format issuer ID entsprechen.identifier, wobei von Google ausgegeben und von dir ausgewählt wird. |
version |
Verworfen |
state |
Erforderlich. Der Status des Objekts. Mit diesem Feld wird festgelegt, wie ein Objekt in der App angezeigt wird. Ein |
barcode |
Der Typ und Wert des Barcodes. |
messages[] |
Eine Reihe von Nachrichten, die in der App angezeigt werden. Alle Nutzer dieses Objekts erhalten die zugehörigen Nachrichten. Die maximale Anzahl dieser Felder ist 10. |
validTimeInterval |
Der Zeitraum, in dem dieses Objekt |
locations[] |
Hinweis: Dieses Feld wird derzeit nicht zum Auslösen von 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 |
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. Nur für ausgewählte Partner bestimmt. Weitere Informationen erhalten Sie vom Support. |
disableExpirationNotification |
Gibt an, ob Benachrichtigungen ausdrücklich unterdrückt werden sollen. Wenn dieses Feld auf „wahr“ gesetzt ist, werden unabhängig vom Feld Derzeit kann dies nur für Angebote festgelegt werden. |
infoModuleData |
Verworfen. Verwenden Sie stattdessen „textModulesData“. |
imageModulesData[] |
Daten des Bildmoduls. Maximal werden ein Feld auf Objektebene und ein Feld auf Klassenobjektebene angezeigt. |
textModulesData[] |
Textmoduldaten. Wenn für den Kurs auch Textmoduldaten definiert sind, werden beide angezeigt. Es werden maximal 10 Felder des Objekts und 10 Felder der Klasse angezeigt. |
linksModuleData |
Linkmoduldaten. Wenn für den Kurs auch Linkmoduldaten definiert sind, werden beide angezeigt. |
appLinkData |
Optionaler Link zu einer App oder Website, der auf der Vorderseite der Karte bzw. des Tickets als Schaltfläche angezeigt wird. Wenn für die entsprechende Klasse „AppLinkData“ angegeben ist, wird nur das Objekt „AppLinkData“ angezeigt. |
activationStatus |
Der Aktivierungsstatus für das Objekt. Erforderlich, wenn für die Klasse |
rotatingBarcode |
Der Typ und Wert des rotierenden Barcodes. |
deviceContext |
Gerätekontext, der mit dem Objekt verknüpft ist. |
heroImage |
Optionales Bannerbild, das auf der Vorderseite der Karte angezeigt wird. Ist keins vorhanden, wird das Hero-Image der Klasse angezeigt, sofern vorhanden. Wenn auch das Hero-Image des Kurses nicht vorhanden ist, wird nichts angezeigt. |
groupingInfo |
Informationen, die steuern, wie Karten/Tickets gruppiert werden. |
passConstraints |
Einschränkungen für Karten/Tickets für das Objekt. Dazu gehört auch die Einschränkung des NFC- und Screenshot-Verhaltens. |
saveRestrictions |
Einschränkungen für das Objekt, die überprüft werden müssen, bevor der Nutzer versucht, die Karte bzw. das Ticket zu speichern. Diese Einschränkungen gelten nur während der Speicherzeit. Wenn sich die Einschränkungen ändern, nachdem ein Nutzer die Karte bzw. das Ticket gespeichert hat, werden die neuen Einschränkungen nicht auf eine bereits gespeicherte Karte bzw. ein bereits gespeichertes Ticket angewendet. |
linkedObjectIds[] |
„linkedObjectIds“ ist eine Liste anderer Objekte wie Veranstaltungstickets, Kundenkarten, Angebote, generische Karten/Tickets, Geschenkkarten, Fahrkarten und Bordkarten, die automatisch mit diesem Mobilitätsobjekt verknüpft werden sollen. Wenn ein Nutzer diese Fahrkarten gespeichert hat, werden diese verknüpften ObjectIds automatisch an die Wallet des Nutzers gesendet, es sei denn, er hat die Einstellung deaktiviert, um solche verknüpften Karten zu erhalten. Achten Sie darauf, dass Objekte, die in „linkedObjectIds“ vorhanden sind, bereits eingefügt wurden. Andernfalls schlagen Aufrufe fehl. Verknüpfte Objekte können nicht mehr getrennt werden. Sie können keine Objekte verknüpfen, die einem anderen Aussteller gehören. Die Anzahl der Objekte, die mit einem einzelnen Objekt verknüpft werden können, ist begrenzt. Wenn das Limit erreicht ist, werden neue verknüpfte Objekte im Anruf stumm ignoriert. Objekt-IDs müssen dem Format issuer ID entsprechen.identifier, wobei von Google ausgegeben und von dir ausgewählt wird. |
notifyPreference |
Gibt an, ob Feldaktualisierungen für dieses Objekt Benachrichtigungen auslösen sollen. Wenn diese Option auf NOTIFY gesetzt ist, versuchen wir, eine Benachrichtigung über die Aktualisierung eines Felds an die Nutzer auszulösen. Diese Benachrichtigungen werden nur an Nutzer gesendet, wenn das Feld auf einer Zulassungsliste steht. Wenn „DO_NOT_NOTIFY“ oder „NOTIFICATION_SETTINGS_UNSPECIFIED“ festgelegt ist, wird keine Benachrichtigung ausgelöst. Diese Einstellung ist temporär und muss bei jeder PATCH- oder UPDATE-Anfrage festgelegt werden. Andernfalls wird keine Benachrichtigung ausgelöst. |
valueAddedModuleData[] |
Optionale Daten zum Mehrwertmodul. Maximal zehn für das Objekt. |
PassengerType
Enums | |
---|---|
PASSENGER_TYPE_UNSPECIFIED |
|
SINGLE_PASSENGER |
|
singlePassenger |
Alter Alias für |
MULTIPLE_PASSENGERS |
|
multiplePassengers |
Alter Alias für |
TicketStatus
Enums | |
---|---|
TICKET_STATUS_UNSPECIFIED |
|
USED |
|
used |
Alter Alias für |
REFUNDED |
|
refunded |
Alter Alias für |
EXCHANGED |
|
exchanged |
Alter Alias für |
ConcessionCategory
Enums | |
---|---|
CONCESSION_CATEGORY_UNSPECIFIED |
|
ADULT |
|
adult |
Alter Alias für |
CHILD |
|
child |
Alter Alias für |
SENIOR |
|
senior |
Alter Alias für |
TicketRestrictions
JSON-Darstellung |
---|
{ "routeRestrictions": { object ( |
Felder | |
---|---|
routeRestrictions |
Einschränkungen für befahrbare Routen Das kann beispielsweise der String „Nur reservierte CrossCountry-Züge“ sein. |
routeRestrictionsDetails |
Weitere Informationen zu |
timeRestrictions |
Einschränkungen hinsichtlich der Häufigkeit, mit der dieses Ticket verwendet werden kann. |
otherRestrictions |
Zusätzliche Einschränkungen, die nicht in die Kategorien „Route“ oder „Uhrzeit“ fallen. |
PurchaseDetails
JSON-Darstellung |
---|
{
"purchaseReceiptNumber": string,
"purchaseDateTime": string,
"accountId": string,
"confirmationCode": string,
"ticketCost": {
object ( |
Felder | |
---|---|
purchaseReceiptNumber |
Belegnummer/-kennzeichnung, um den Ticketkauf über den Verkäufer zu verfolgen. |
purchaseDateTime |
Das Kaufdatum und die -uhrzeit des Tickets. Datum/Uhrzeit im erweiterten ISO 8601-Format mit oder ohne Offset. Die Uhrzeit kann bis auf die Nanosekunde genau angegeben werden. Offsets können bis auf die Sekunde genau angegeben werden (obwohl Offset-Sekunden nicht in ISO 8601 enthalten sind). Beispiel:
Ohne Offset-Informationen sind einige erweiterte Funktionen möglicherweise nicht verfügbar. |
accountId |
ID des Kontos, mit dem das Ticket gekauft wurde. |
confirmationCode |
Der Bestätigungscode für den Kauf. Dieser kann für mehrere verschiedene Tickets identisch sein und wird verwendet, um Tickets zu gruppieren. |
ticketCost |
Der Preis 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 Nachricht, in der alle angewendeten Rabatte beschrieben werden. |
TicketLeg
JSON-Darstellung |
---|
{ "originStationCode": string, "originName": { object ( |
Felder | |
---|---|
originStationCode |
Der Code der Starthaltestelle. Erforderlich, wenn |
originName |
Der Name der Startstation. 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 öffentliche Verkehrsmittelobjekt kein Gültigkeitszeitraum festgelegt ist. Datum/Uhrzeit im erweiterten ISO 8601-Format mit oder ohne Offset. Die Uhrzeit kann bis auf die Nanosekunde genau angegeben werden. Offsets können bis auf die Sekunde genau angegeben werden (obwohl Offset-Sekunden nicht in ISO 8601 enthalten sind). Beispiel:
Der Teil des Datums/der Uhrzeit ohne den Zeitunterschied wird als „lokales Datum/lokale Uhrzeit“ bezeichnet. Das sollte das lokale Datum und die lokale Uhrzeit der Startstation sein. Wenn die Abfahrt beispielsweise am 5. Juni 2018 um 20 Uhr am Startbahnhof erfolgt, sollte der Teil für Datum und Uhrzeit in der Ortszeit Ohne Offset-Informationen sind einige erweiterte Funktionen möglicherweise nicht verfügbar. |
arrivalDateTime |
Datum und Uhrzeit der Ankunft. Datum/Uhrzeit im erweiterten ISO 8601-Format mit oder ohne Offset. Die Uhrzeit kann bis auf die Nanosekunde genau angegeben werden. Offsets können bis auf die Sekunde genau angegeben werden (obwohl Offset-Sekunden nicht in ISO 8601 enthalten sind). Beispiel:
Der Teil des Datums/der Uhrzeit ohne den Zeitunterschied wird als „lokales Datum/lokale Uhrzeit“ bezeichnet. Dies sollte das lokale Datum und die lokale Uhrzeit der Zielstation sein. Wenn das Ereignis beispielsweise am 5. Juni 2018 um 20:00 Uhr an der Zielstation stattfindet, sollte der Teil mit Datum und Uhrzeit in lokaler Zeit Ohne Offset-Informationen sind einige erweiterte Funktionen möglicherweise nicht verfügbar. |
fareName |
Kurze Beschreibung/Name des Fahrpreises für diesen Streckenabschnitt. Beispiel: „Einmal verwenden – jederzeit“. |
carriage |
Der Name oder die Nummer des Zuges oder Schiffs, in den bzw. das der Fahrgast einsteigen muss. |
platform |
Der Bahnsteig oder das Tor, an dem der Fahrgast in den Wagen einsteigen kann. |
zone |
Die Zone für das Einsteigen auf dem Bahnsteig. |
ticketSeat |
Der reservierte Sitzplatz für die Passagiere. Wenn mehr als ein Sitzplatz angegeben werden soll, verwenden Sie stattdessen das Feld |
ticketSeats[] |
Der reservierte Sitzplatz für die Passagiere. Wenn nur ein Sitzplatz angegeben werden soll, verwenden Sie stattdessen das Feld |
transitOperatorName |
Der Name des Verkehrsunternehmens, das diesen Abschnitt einer Fahrt durchführt. |
transitTerminusName |
Endstation oder Ziel des Zuges/Busses usw. |
TicketSeat
JSON-Darstellung |
---|
{ "fareClass": enum ( |
Felder | |
---|---|
fareClass |
Die Preisklasse des Sitzplatzes, für den ein Ticket gekauft wurde. |
customFareClass |
Eine benutzerdefinierte Preisklasse, die verwendet wird, wenn keine |
coach |
Die Kennung des Waggons, in dem sich der Sitzplatz befindet. z. B. „10“ |
seat |
Die Kennung des Standorts des Sitzplatzes, für den das Ticket gilt. z. B. „42“. Wenn keine bestimmte Kennung vorhanden ist, verwenden Sie stattdessen |
seatAssignment |
Die Sitzplatzzuweisung des Fahrgastes. z. B. „Kein bestimmter Sitzplatz“ Wird verwendet, wenn in |
FareClass
Enums | |
---|---|
FARE_CLASS_UNSPECIFIED |
|
ECONOMY |
|
economy |
Alter Alias für |
FIRST |
|
first |
Alter Alias für |
BUSINESS |
|
business |
Alter Alias für |
TripType
Enums | |
---|---|
TRIP_TYPE_UNSPECIFIED |
|
ROUND_TRIP |
|
roundTrip |
Alter Alias für |
ONE_WAY |
|
oneWay |
Alter Alias für |
ActivationStatus
Der Aktivierungsstatus des Objekts. Dieses Feld enthält den Aktivierungsstatus, sofern das Asset eine Aktivierung unterstützt.
JSON-Darstellung |
---|
{
"state": enum ( |
Felder | |
---|---|
state |
|
Status
Enums | |
---|---|
UNKNOWN_STATE |
|
NOT_ACTIVATED |
Nicht aktiviert (Standardstatus) |
not_activated |
Alter Alias für |
ACTIVATED |
Aktiviert |
activated |
Alter Alias für |
DeviceContext
Gerätekontext, der mit dem Objekt verknüpft ist.
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 verwendet werden, um das Gerät eines Nutzers nachzuverfolgen. Es kann bei den verschiedenen Karten/Tickets für dasselbe Gerät oder sogar bei verschiedenen Aktivierungen für dasselbe Gerät variieren. Bei dieser Einstellung müssen Aufrufer „hasLinkedDevice“ für das zu aktivierende Objekt festlegen. |
Methoden |
|
---|---|
|
Fügt dem Verkehrsobjekt, auf das durch die angegebene Objekt-ID verwiesen wird, eine Nachricht hinzu. |
|
Gibt das Verkehrsobjekt mit der angegebenen Objekt-ID zurück. |
|
Ein Verkehrsobjekt mit der angegebenen ID und den angegebenen Eigenschaften wird eingefügt. |
|
Gibt eine Liste aller Mobilitätsobjekte für eine bestimmte Aussteller-ID zurück. |
|
Aktualisiert das Verkehrsobjekt, auf das durch die angegebene Objekt-ID verwiesen wird. |
|
Aktualisiert das Verkehrsobjekt, auf das durch die angegebene Objekt-ID verwiesen wird. |