- Ressource: TransitObject
- PassengerType
- TicketStatus
- ConcessionCategory
- TicketRestrictions
- PurchaseDetails
- TicketCost
- TicketLeg
- TicketSeat
- FareClass
- TripType
- ActivationStatus
- Bundesland
- DeviceContext
- Methoden
Ressource: TransitObject
JSON-Darstellung |
---|
{ "classReference": { object ( |
Felder | |
---|---|
class |
Eine Kopie der übernommenen Felder der übergeordneten Klasse. Diese Felder werden während einer GET-Anfrage abgerufen. |
ticket |
Die Nummer des Tickets. Dies ist eine eindeutige Kennung für das Ticket im System des Verkehrsunternehmens. |
passenger |
Die Anzahl der Passagiere. |
passenger |
Die Namen der Passagiere, denen das Ticket zugewiesen ist. Das obige Feld |
trip |
Diese ID wird verwendet, um Tickets zu gruppieren, wenn der Nutzer mehrere Tickets für dieselbe Fahrt gespeichert hat. |
ticket |
Der Status des Tickets. Verwenden Sie für Status, die sich auf die Anzeige auswirken, stattdessen das Feld |
custom |
Ein benutzerdefinierter Status, der für den Ticketstatuswert verwendet wird, wenn |
concession |
Die Ermäßigungskategorie für das Ticket. |
custom |
Eine benutzerdefinierte Kulanzzusage, die verwendet werden soll, wenn |
ticket |
Informationen zu den Einschränkungen bei der Verwendung dieses Tickets. z. B. welche Wochentage er verwendet werden muss oder welche Routen verwendet werden dürfen. |
purchase |
Details zum Kauf dieses Tickets. |
ticket |
Eine Einzelfahrkarte enthält Abfahrts- und Ankunftsinformationen sowie Informationen zu Einstieg und Sitzplatz. Wenn mehr als ein Abschnitt angegeben werden soll, verwenden Sie stattdessen das Feld |
ticket |
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 |
hex |
Die Hintergrundfarbe der Karte. 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. |
trip |
Erforderlich. Die Art der Fahrt, die dieses Verkehrsobjekt darstellt. Wird verwendet, um den Titel der Karte bzw. das Ticket und/oder das Symbol festzulegen, 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 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. |
class |
Erforderlich. Die mit diesem Objekt verknüpfte Klasse. Die Klasse muss denselben Typ wie dieses Objekt haben, bereits vorhanden und genehmigt sein. Klassen-IDs müssen das Format issuer ID haben.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. Beispielsweise wird ein |
barcode |
Der Typ und Wert des Barcodes. |
messages[] |
Ein Array von Meldungen, die in der App angezeigt werden. Alle Nutzer dieses Objekts erhalten die zugehörigen Nachrichten. Die maximale Anzahl dieser Felder ist 10. |
valid |
Der Zeitraum, in dem dieses Objekt |
locations[] |
Hinweis: Dieses Feld wird derzeit nicht zum Auslösen von Geo-Benachrichtigungen unterstützt. |
has |
Gibt an, ob das Objekt Nutzer hat. Dieses Feld wird von der Plattform festgelegt. |
smart |
Der Wert, der für dieses Objekt über NFC an ein Smart-Bonus-zertifiziertes Terminal übertragen wird. Die Felder |
has |
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 es mit seinem Gerät verknüpft. Zur Verwendung durch ausgewählte Partner vorgesehen. Weitere Informationen erhalten Sie vom Support. |
disable |
Gibt an, ob Benachrichtigungen ausdrücklich unterdrückt werden sollen. Wenn dieses Feld auf „wahr“ gesetzt ist, werden unabhängig vom Feld Diese Option kann derzeit nur für Angebote festgelegt werden. |
info |
Verworfen. Verwenden Sie stattdessen textModulesData. |
image |
Bildmoduldaten. Maximal werden ein Feld auf Objektebene und ein Feld auf Klassenobjektebene angezeigt. |
text |
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. |
links |
Linkmoduldaten. Wenn Linkmoduldaten ebenfalls für die Klasse definiert sind, werden beide angezeigt. |
app |
Optionaler App- oder Websitelink, der als Schaltfläche auf der Vorderseite der Karte bzw. des Tickets angezeigt wird. Wenn für die entsprechende Klasse „AppLinkData“ angegeben ist, wird nur das Objekt „AppLinkData“ angezeigt. |
activation |
Der Aktivierungsstatus für das Objekt. Erforderlich, wenn für die Klasse |
rotating |
Der Typ und Wert des rotierenden Barcodes. |
device |
Dem Objekt zugeordneter Gerätekontext. |
hero |
Optionales Bannerbild, das auf der Vorderseite der Karte angezeigt wird. Ist keins vorhanden, wird das Hero-Image der Klasse angezeigt, sofern vorhanden. Wenn auch kein Hero-Image des Kurses vorhanden ist, wird nichts angezeigt. |
grouping |
Informationen, die steuern, wie Karten/Tickets gruppiert werden. |
pass |
Übergeben Sie die Einschränkungen für das Objekt. Dazu gehört auch die Einschränkung des NFC- und Screenshot-Verhaltens. |
save |
Einschränkungen für das Objekt, das überprüft werden muss, bevor der Nutzer versucht, die Karte bzw. das Ticket zu speichern. Diese Einschränkungen werden nur beim Speichern angewendet. Wenn sich die Einschränkungen ändern, nachdem ein Nutzer die Karte bzw. das Ticket gespeichert hat, werden die neuen Einschränkungen nicht auf bereits gespeicherte Karten/Tickets angewendet. |
linked |
verknüpfteObjectIds sind eine Liste weiterer Objekte wie Veranstaltungstickets, Treuepunkte, Angebote, generische, Geschenkkarten, öffentliche Verkehrsmittel und Bordkarten, die automatisch an dieses Verkehrsobjekt angehängt werden sollen. Wenn ein Nutzer diese Fahrkarte gespeichert hat, werden diese verknüpften ObjectIds automatisch an das Wallet des Nutzers gesendet, es sei denn, er hat die Einstellung zum Empfangen verknüpfter Karten/Tickets deaktiviert. Achten Sie darauf, dass Objekte, die in „linkedObjectIds“ vorhanden sind, bereits eingefügt wurden. Andernfalls schlagen Aufrufe fehl. Nach der Verknüpfung kann die Verknüpfung der verknüpften Objekte nicht mehr aufgehoben 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 das Format issuer ID haben.identifier, wobei von Google ausgegeben und von dir ausgewählt wird. |
notify |
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 die Richtlinie auf DO_NOT_NOTIFY oder NOTIFICATION_SETTINGS_UNSPECIFIED festgelegt ist, wird keine Benachrichtigung ausgelöst. Diese Einstellung ist sitzungsspezifisch und muss bei jeder PATCH- oder UPDATE-Anfrage festgelegt werden. Andernfalls wird keine Benachrichtigung ausgelöst. |
value |
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 | |
---|---|
route |
Einschränkungen für befahrbare Routen Dies kann beispielsweise der String "Reservierte Cross-Country-Züge" sein. |
route |
Weitere Informationen zu |
time |
Einschränkungen für die Nutzungszeiten dieses Tickets. |
other |
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 | |
---|---|
purchase |
Belegnummer/-kennzeichnung, um den Ticketkauf über den Ticketverkäufer zu verfolgen. |
purchase |
Das Kaufdatum und die -uhrzeit des Tickets. 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, auch wenn Offset-Sekunden nicht in ISO 8601 enthalten sind. Beispiel:
Ohne Offset-Informationen sind einige erweiterte Funktionen möglicherweise nicht verfügbar. |
account |
ID des Kontos, das für den Kauf des Tickets verwendet wurde. |
confirmation |
Der Bestätigungscode für den Kauf. Sie kann für mehrere verschiedene Tickets identisch sein und wird verwendet, um Tickets zu gruppieren. |
ticket |
Der Preis des Tickets. |
TicketCost
JSON-Darstellung |
---|
{ "faceValue": { object ( |
Felder | |
---|---|
face |
Der Nennwert des Tickets. |
purchase |
Der tatsächliche Kaufpreis des Tickets nach Abzug von Steuern und/oder Rabatten. |
discount |
Eine Nachricht, in der alle angewendeten Rabatte beschrieben werden. |
TicketLeg
JSON-Darstellung |
---|
{ "originStationCode": string, "originName": { object ( |
Felder | |
---|---|
origin |
Der Code der Starthaltestelle. Erforderlich, wenn |
origin |
Der Name der Startstation. Erforderlich, wenn |
destination |
Der Code der Zielhaltestelle. |
destination |
Der Name des Ziels. |
departure |
Datum und Uhrzeit der Abreise. Dies ist erforderlich, wenn für das Transit-Objekt kein Gültigkeitszeitintervall 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 sekundengenau angegeben werden, auch wenn 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 Versatzinformationen sind einige Rich-Funktionen möglicherweise nicht verfügbar. |
arrival |
Datum und Uhrzeit der 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 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 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 Versatzinformationen sind einige Rich-Funktionen möglicherweise nicht verfügbar. |
fare |
Kurze Beschreibung/Name des Preises für diesen Streckenabschnitt. Beispiel: „Einmal verwenden – jederzeit“. |
carriage |
Name/Nummer des Zugs oder Schiffes, an dem der Passanten 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. |
ticket |
Der reservierte Sitzplatz für die Passagiere. Wenn mehr als ein Sitzplatz angegeben werden soll, verwenden Sie stattdessen das Feld |
ticket |
Der für den/die Passagier(e) reservierte Sitzplatz. Wenn nur ein Sitzplatz angegeben werden soll, verwenden Sie stattdessen das Feld |
transit |
Der Name des Betreibers, der diesen Abschnitt einer Fahrt durchführt. |
transit |
Endhaltestelle oder Ziel von Zug/Bus usw. |
TicketSeat
JSON-Darstellung |
---|
{ "fareClass": enum ( |
Felder | |
---|---|
fare |
Die Preisklasse des Sitzplatzes, für den ein Ticket gekauft wurde. |
custom |
Eine benutzerdefinierte Preisklasse, die verwendet wird, wenn keine |
coach |
Die Kennung des Wagens, in dem sich der Sitz befindet. z. B. „10“ |
seat |
Die Kennung des Sitzplatzes. z. B. „42“. Wenn es keine spezifische Kennung gibt, verwenden Sie stattdessen |
seat |
Die Sitzzuweisung des Passagiers. z. B. „Kein bestimmter Sitzplatz“ Zu verwenden, wenn keine spezifische Kennung 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, wenn das Wert die 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 dem Objekt zugeordnet ist.
JSON-Darstellung |
---|
{ "deviceToken": string } |
Felder | |
---|---|
device |
Wenn festgelegt, werden Einlösungsinformationen nur bei Aktivierung des Objekts an das angegebene Gerät zurückgegeben. Sie sollte nicht als stabile Kennung zur Verfolgung des Nutzergeräts verwendet werden. Es kann bei den verschiedenen Karten/Tickets für dasselbe Gerät oder sogar bei verschiedenen Aktivierungen für dasselbe Gerät variieren. Wenn diese Option festgelegt ist, müssen Aufrufer „hasLinkedDevice“ für das zu aktivierende Objekt festlegen. |
Methoden |
|
---|---|
|
Fügt dem Verkehrsobjekt, auf das von der angegebenen Objekt-ID verwiesen wird, eine Nachricht hinzu. |
|
Gibt das Verkehrsobjekt mit der angegebenen Objekt-ID zurück. |
|
Fügt ein Verkehrsobjekt mit der angegebenen ID und den angegebenen Eigenschaften ein. |
|
Gibt eine Liste aller Verkehrsobjekte 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. |