REST Resource: transitobject

{
  "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)
  }
}

object (TransitClass)

Eine Kopie der übernommenen Felder der übergeordneten Klasse. Diese Felder werden während einer GET-Anfrage abgerufen.

string

Die Nummer des Tickets. Dies ist eine eindeutige Kennung für das Ticket im System des Verkehrsunternehmens.

enum (PassengerType)

Die Anzahl der Passagiere.

string

Die Namen der Passagiere, denen das Ticket zugewiesen ist. Das obige Feld passengerType soll Google Kontext zu diesem Feld liefern.

string

Diese ID wird verwendet, um Tickets zu gruppieren, wenn der Nutzer mehrere Tickets für dieselbe Fahrt gespeichert hat.

enum (TicketStatus)

Der Status des Tickets. Verwenden Sie für Status, die sich auf die Anzeige auswirken, stattdessen das Feld state.

object (LocalizedString)

Ein benutzerdefinierter Status, der für den Ticketstatuswert verwendet wird, wenn ticketStatus nicht die richtige Option bietet. ticketStatus und customTicketStatus dürfen nicht gleichzeitig festgelegt sein.

enum (ConcessionCategory)

Die Ermäßigungskategorie für das Ticket.

object (LocalizedString)

Eine benutzerdefinierte Konzessionskategorie, die verwendet werden soll, wenn concessionCategory nicht die richtige Option bietet. concessionCategory und customConcessionCategory dürfen nicht gleichzeitig festgelegt sein.

object (TicketRestrictions)

Informationen zu den Einschränkungen bei der Nutzung dieses Tickets. z. B. welche Wochentage er verwendet werden muss oder welche Routen verwendet werden dürfen.

object (PurchaseDetails)

Kaufdetails für dieses Ticket.

object (TicketLeg)

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 ticketLegs. ticketLeg und ticketLegs dürfen nicht gleichzeitig festgelegt sein.

object (TicketLeg)

Jedes Ticket kann einen oder mehrere Streckenabschnitte umfassen. Für jeden Abschnitt gibt es Abfahrts- und Ankunftsinformationen sowie Informationen zu Boarding und Sitzplatz. Wenn nur ein Abschnitt angegeben werden soll, verwenden Sie stattdessen das Feld ticketLeg. ticketLeg und ticketLegs dürfen nicht gleichzeitig festgelegt sein.

string

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 #ffcc00 ist. Du kannst auch die Kurzversion des RGB-Triplets verwenden (#rgb), z. B. #fc0.

enum (TripType)

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.

string

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, wobei Ersteres von Google ausgestellt und Letzteres von Ihnen ausgewählt wird. Die eindeutige Kennung sollte nur alphanumerische Zeichen sowie „.“, „_“ oder „-“ enthalten.

string

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 Ersteres von Google ausgestellt und Letzteres von Ihnen ausgewählt wird.

string (int64 format)

Verworfen

enum (State)

Erforderlich. Der Status des Objekts. Mit diesem Feld wird festgelegt, wie ein Objekt in der App angezeigt wird. Beispielsweise wird ein inactive-Objekt in den Ordner „Abgelaufene Karten/Tickets“ verschoben .

object (Barcode)

Typ und Wert des Barcodes.

object (Message)

Ein Array von Mitteilungen, die in der App angezeigt werden. Alle Nutzer dieses Objekts erhalten die zugehörigen Nachrichten. Die maximale Anzahl dieser Felder ist 10.

object (TimeInterval)

Der Zeitraum, in dem dieses Objekt active ist und das Objekt verwendet werden kann. Der Status eines Objekts wird nach Ablauf dieses Zeitraums in expired geändert.

object (LatLongPoint)

Hinweis: Dieses Feld wird derzeit nicht zum Auslösen von Geo-Benachrichtigungen unterstützt.

boolean

Gibt an, ob das Objekt Nutzer hat. Dieses Feld wird von der Plattform festgelegt.

string

Der Wert, der für dieses Objekt über NFC an ein Smart-Bonus-zertifiziertes Terminal übertragen wird. Die Felder auf Klassenebene enableSmartTap und redemptionIssuers müssen ebenfalls korrekt eingerichtet sein, damit die Karte bzw. das Ticket Smart-Bonus unterstützt. Es werden nur ASCII-Zeichen unterstützt.

boolean

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.

boolean

Gibt an, ob Benachrichtigungen explizit unterdrückt werden sollen. Wenn dieses Feld auf „true“ gesetzt ist, werden Benachrichtigungen zu Ablaufdaten an den Nutzer unabhängig vom Feld messages unterdrückt. Standardmäßig ist dieses Feld auf „false“ gesetzt.

Diese Option kann derzeit nur für Angebote festgelegt werden.

object (InfoModuleData)

Verworfen. Verwenden Sie stattdessen textModulesData.

object (ImageModuleData)

Bildmoduldaten. Es werden maximal ein Feld aus der Objektebene und eines auf der Klassenobjektebene angezeigt.

object (TextModuleData)

Textmoduldaten. Wenn auch Textmoduldaten für die Klasse definiert sind, werden beide angezeigt. Die maximale Anzahl der angezeigten Felder beträgt 10 vom Objekt und 10 aus der Klasse.

object (LinksModuleData)

Linkmoduldaten. Wenn Linkmoduldaten ebenfalls für die Klasse definiert sind, werden beide angezeigt.

object (AppLinkData)

Optionaler App- oder Websitelink, der als Schaltfläche auf der Vorderseite der Karte bzw. des Tickets angezeigt wird. Wenn AppLinkData für das entsprechende Klassenobjekt bereitgestellt wird, wird nur das AppLinkData-Objekt angezeigt.

object (ActivationStatus)

Der Aktivierungsstatus für das Objekt. Erforderlich, wenn für die Klasse activationOptions festgelegt ist.

object (RotatingBarcode)

Typ und Wert des rotierenden Barcodes.

object (DeviceContext)

Gerätekontext, der dem Objekt zugeordnet ist.

object (Image)

Optionales Bannerbild, das auf der Vorderseite der Karte angezeigt wird Ist keins vorhanden, wird gegebenenfalls das Hero-Image des Kurses angezeigt. Wenn auch kein Hero-Image des Kurses vorhanden ist, wird nichts angezeigt.

object (GroupingInfo)

Informationen, die steuern, wie Karten/Tickets gruppiert werden.

object (PassConstraints)

Übergeben Sie die Einschränkungen für das Objekt. Dazu gehört auch das Einschränken des Verhaltens von NFC- und Screenshot-Daten.

object (SaveRestrictions)

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.

{
  "routeRestrictions": {
    object (LocalizedString)
  },
  "routeRestrictionsDetails": {
    object (LocalizedString)
  },
  "timeRestrictions": {
    object (LocalizedString)
  },
  "otherRestrictions": {
    object (LocalizedString)
  }
}

object (LocalizedString)

Beschränkungen für mögliche Routen Dies kann beispielsweise der String "Reservierte Cross-Country-Züge" sein.

object (LocalizedString)

Weitere Informationen zu den routeRestrictions oben.

object (LocalizedString)

Einschränkungen für die Nutzungszeiten dieses Tickets.

object (LocalizedString)

Zusätzliche Einschränkungen, die nicht unter die „Route“ fallen oder „Uhrzeit“ Kategorien.

{
  "purchaseReceiptNumber": string,
  "purchaseDateTime": string,
  "accountId": string,
  "confirmationCode": string,
  "ticketCost": {
    object (TicketCost)
  }
}

string

Belegnummer/-ID zur Nachverfolgung des Ticketkaufs über die Stelle, die das Ticket verkauft hat

string

Datum und Uhrzeit des Kaufs 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:

1985-04-12T23:20:50.52Z entspricht 20 Minuten und 50, 52 Sekunden nach der 23. Stunde am 12. April 1985 in UTC.

1985-04-12T19:20:50.52-04:00 entspricht 20 Minuten und 50, 52 Sekunden nach der 19. Stunde am 12. April 1985, 4 Stunden vor UTC (gleicher Zeitpunkt wie im Beispiel oben). Würde der Termin in New York stattfinden, wäre dies die Entsprechung in Eastern Daylight Time (EDT). Der Offset variiert je nach Jahreszeit in Regionen, in denen Sommerzeit gilt.

1985-04-12T19:20:50.52 entspricht 20 Minuten und 50, 52 Sekunden nach der 19. Stunde am 12. April 1985 ohne Offset-Informationen.

Ohne Versatzinformationen sind einige Rich-Funktionen möglicherweise nicht verfügbar.

string

ID des Kontos, das für den Kauf des Tickets verwendet wurde.

string

Der Bestätigungscode für den Kauf. Sie kann für mehrere verschiedene Tickets identisch sein und wird verwendet, um Tickets zu gruppieren.

object (TicketCost)

Der Preis des Tickets.

{
  "faceValue": {
    object (Money)
  },
  "purchasePrice": {
    object (Money)
  },
  "discountMessage": {
    object (LocalizedString)
  }
}

object (Money)

Der Nennbetrag des Tickets.

object (Money)

Der tatsächliche Kaufpreis des Tickets nach Abzug von Steuern und/oder Rabatten.

object (LocalizedString)

Eine Nachricht, in der alle angewendeten Rabatte beschrieben werden.

{
  "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)
  }
}

string

Der Code der Starthaltestelle. Dies ist erforderlich, wenn destinationStationCode oder originName nicht vorhanden ist.

object (LocalizedString)

Der Name der Starthaltestelle. Dies ist erforderlich, wenn desinationName oder originStationCode nicht vorhanden ist.

string

Code der Zielhaltestelle.

object (LocalizedString)

Der Name des Ziels.

string

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 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:

1985-04-12T23:20:50.52Z entspricht 20 Minuten und 50, 52 Sekunden nach der 23. Stunde am 12. April 1985 in UTC.

1985-04-12T19:20:50.52-04:00 entspricht 20 Minuten und 50, 52 Sekunden nach der 19. Stunde am 12. April 1985, 4 Stunden vor UTC (gleicher Zeitpunkt wie im Beispiel oben). Würde der Termin in New York stattfinden, wäre dies die Entsprechung in Eastern Daylight Time (EDT). Der Offset variiert je nach Jahreszeit in Regionen, in denen Sommerzeit gilt.

1985-04-12T19:20:50.52 entspricht 20 Minuten und 50, 52 Sekunden nach der 19. Stunde am 12. April 1985 ohne Offset-Informationen.

Der Teil der Datums-/Uhrzeitangabe ohne Versatz wird als "lokales Datum/die lokale Uhrzeit" betrachtet. Dies sollte das lokale Datum und die lokale Uhrzeit an der Starthaltestelle sein. Wenn die Abfahrt beispielsweise am 5. Juni 2018 in der 20. Stunde am Startbahnhof stattfindet, sollte der lokale Datums-/Uhrzeitteil 2018-06-05T20:00:00 lauten. Wenn das lokale Datum bzw. die lokale Uhrzeit an der Startstation 4 Stunden vor der UTC liegt, kann ein Offset von -04:00 angehängt werden.

Ohne Versatzinformationen sind einige Rich-Funktionen möglicherweise nicht verfügbar.

string

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 sekundengenau angegeben werden, auch wenn Offset-Sekunden nicht in ISO 8601 enthalten sind.

Beispiel:

1985-04-12T23:20:50.52Z entspricht 20 Minuten und 50, 52 Sekunden nach der 23. Stunde am 12. April 1985 in UTC.

1985-04-12T19:20:50.52-04:00 entspricht 20 Minuten und 50, 52 Sekunden nach der 19. Stunde am 12. April 1985, 4 Stunden vor UTC (gleicher Zeitpunkt wie im Beispiel oben). Würde der Termin in New York stattfinden, wäre dies die Entsprechung in Eastern Daylight Time (EDT). Der Offset variiert je nach Jahreszeit in Regionen, in denen Sommerzeit gilt.

1985-04-12T19:20:50.52 entspricht 20 Minuten und 50, 52 Sekunden nach der 19. Stunde am 12. April 1985 ohne Offset-Informationen.

Der Teil der Datums-/Uhrzeitangabe ohne Versatz wird als "lokales Datum/die lokale Uhrzeit" betrachtet. Dies sollte das lokale Datum und die lokale Uhrzeit an der Zielhaltestelle sein. Wenn die Veranstaltung beispielsweise um die 20. Stunde des 5. Juni 2018 an der Zielstation stattfindet, sollte der lokale Datums-/Uhrzeitteil 2018-06-05T20:00:00 lauten. Wenn das lokale Datum bzw. die lokale Uhrzeit an der Zielstation 4 Stunden vor der UTC liegt, kann ein Offset von -04:00 angehängt werden.

Ohne Versatzinformationen sind einige Rich-Funktionen möglicherweise nicht verfügbar.

object (LocalizedString)

Kurze Beschreibung/Name des Preises für diesen Streckenabschnitt. z. B. „Anytime Single Use“ (Jederzeitige Einzelnutzung)

string

Name/Nummer des Zugs oder Schiffes, an dem der Passanten einsteigen muss.

string

Der Bahnsteig oder das Gate, an dem der Fahrgast zusteigen kann.

string

Der Einstiegsbereich innerhalb des Bahnsteigs.

object (TicketSeat)

Der für den/die Passagier(e) reservierte Sitzplatz. Wenn mehr als ein Sitzplatz angegeben werden soll, verwenden Sie stattdessen das Feld ticketSeats. ticketSeat und ticketSeats dürfen nicht gleichzeitig festgelegt sein.

object (TicketSeat)

Der für den/die Passagier(e) reservierte Sitzplatz. Wenn nur ein Sitzplatz angegeben werden soll, verwenden Sie stattdessen das Feld ticketSeat. ticketSeat und ticketSeats dürfen nicht gleichzeitig festgelegt sein.

object (LocalizedString)

Der Name des Betreibers, der diesen Abschnitt einer Fahrt durchführt.

object (LocalizedString)

Endhaltestelle oder Ziel von Zug/Bus usw.

{
  "fareClass": enum (FareClass),
  "customFareClass": {
    object (LocalizedString)
  },
  "coach": string,
  "seat": string,
  "seatAssignment": {
    object (LocalizedString)
  }
}

enum (FareClass)

Die Preisklasse des Ticketplatzes.

object (LocalizedString)

Eine eigene Preisklasse, die verwendet wird, wenn keine fareClass zutrifft. fareClass und customFareClass dürfen nicht gleichzeitig festgelegt sein.

string

Die Kennung des Zugwaggons oder Waggons, in dem sich der Fahrkartenplatz befindet. z. B. „10“

string

Die Kennung des Sitzplatzes. z. B. „42“. Wenn es keine spezifische Kennung gibt, verwenden Sie stattdessen seatAssigment.

object (LocalizedString)

Die Sitzplatzzuweisung des Passagiers. z. B. „kein bestimmter Sitzplatz“. Zu verwenden, wenn keine spezifische Kennung in seat vorhanden ist.

{
  "state": enum (State)
}

enum (State)

{
  "deviceToken": string
}

string

Wenn festgelegt, werden Einlösungsinformationen nur bei Aktivierung des Objekts an das angegebene Gerät zurückgegeben. Er sollte nicht als stabile Kennung zur Verfolgung des Nutzergeräts 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. Wenn diese Option festgelegt ist, müssen Aufrufer für das zu aktivierende Objekt auch „hasLinkedDevice“ festlegen.