REST Resource: transitobject

Ressource: TransitObject

JSON-Darstellung
{
  "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)
  }
}
Felder
classReference

object (TransitClass)

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

ticketNumber

string

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

passengerType

enum (PassengerType)

Die Anzahl der Passagiere.

passengerNames

string

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

tripId

string

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

ticketStatus

enum (TicketStatus)

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

customTicketStatus

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.

concessionCategory

enum (ConcessionCategory)

Die Ermäßigungskategorie für das Ticket.

customConcessionCategory

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.

ticketRestrictions

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.

purchaseDetails

object (PurchaseDetails)

Kaufdetails für dieses Ticket.

ticketLeg

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.

ticketLegs[]

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.

hexBackgroundColor

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.

tripType

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.

id

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.

classId

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.

version
(deprecated)

string (int64 format)

Verworfen

state

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 .

barcode

object (Barcode)

Typ und Wert des Barcodes.

messages[]

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.

validTimeInterval

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.

locations[]

object (LatLongPoint)

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

hasUsers

boolean

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

smartTapRedemptionValue

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.

hasLinkedDevice

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.

disableExpirationNotification

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.

infoModuleData

object (InfoModuleData)

Verworfen. Verwenden Sie stattdessen textModulesData.

imageModulesData[]

object (ImageModuleData)

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

textModulesData[]

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.

activationStatus

object (ActivationStatus)

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

rotatingBarcode

object (RotatingBarcode)

Typ und Wert des rotierenden Barcodes.

deviceContext

object (DeviceContext)

Gerätekontext, der dem Objekt zugeordnet ist.

heroImage

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.

groupingInfo

object (GroupingInfo)

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

passConstraints

object (PassConstraints)

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

saveRestrictions

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.

PassengerType

Enums
PASSENGER_TYPE_UNSPECIFIED
SINGLE_PASSENGER
singlePassenger

Alter Alias für SINGLE_PASSENGER. Verworfen.

MULTIPLE_PASSENGERS
multiplePassengers

Alter Alias für MULTIPLE_PASSENGERS. Verworfen.

TicketStatus

Enums
TICKET_STATUS_UNSPECIFIED
USED
used

Alter Alias für USED. Verworfen.

REFUNDED
refunded

Alter Alias für REFUNDED. Verworfen.

EXCHANGED
exchanged

Alter Alias für EXCHANGED. Verworfen.

ConcessionCategory

Enums
CONCESSION_CATEGORY_UNSPECIFIED
ADULT
adult

Alter Alias für ADULT. Verworfen.

CHILD
child

Alter Alias für CHILD. Verworfen.

SENIOR
senior

Alter Alias für SENIOR. Verworfen.

TicketRestrictions

JSON-Darstellung
{
  "routeRestrictions": {
    object (LocalizedString)
  },
  "routeRestrictionsDetails": {
    object (LocalizedString)
  },
  "timeRestrictions": {
    object (LocalizedString)
  },
  "otherRestrictions": {
    object (LocalizedString)
  }
}
Felder
routeRestrictions

object (LocalizedString)

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

routeRestrictionsDetails

object (LocalizedString)

Weitere Informationen zu den routeRestrictions oben.

timeRestrictions

object (LocalizedString)

Einschränkungen für die Nutzungszeiten dieses Tickets.

otherRestrictions

object (LocalizedString)

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

PurchaseDetails

JSON-Darstellung
{
  "purchaseReceiptNumber": string,
  "purchaseDateTime": string,
  "accountId": string,
  "confirmationCode": string,
  "ticketCost": {
    object (TicketCost)
  }
}
Felder
purchaseReceiptNumber

string

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

purchaseDateTime

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.

accountId

string

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

confirmationCode

string

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

ticketCost

object (TicketCost)

Der Preis des Tickets.

TicketCost

JSON-Darstellung
{
  "faceValue": {
    object (Money)
  },
  "purchasePrice": {
    object (Money)
  },
  "discountMessage": {
    object (LocalizedString)
  }
}
Felder
faceValue

object (Money)

Der Nennbetrag des Tickets.

purchasePrice

object (Money)

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

discountMessage

object (LocalizedString)

Eine Nachricht, in der alle angewendeten Rabatte beschrieben werden.

TicketLeg

JSON-Darstellung
{
  "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)
  }
}
Felder
originStationCode

string

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

originName

object (LocalizedString)

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

destinationStationCode

string

Code der Zielhaltestelle.

destinationName

object (LocalizedString)

Der Name des Ziels.

departureDateTime

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.

arrivalDateTime

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.

fareName

object (LocalizedString)

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

carriage

string

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

platform

string

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

zone

string

Der Einstiegsbereich innerhalb des Bahnsteigs.

ticketSeat

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.

ticketSeats[]

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.

transitOperatorName

object (LocalizedString)

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

transitTerminusName

object (LocalizedString)

Endhaltestelle oder Ziel von Zug/Bus usw.

TicketSeat

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

enum (FareClass)

Die Preisklasse des Ticketplatzes.

customFareClass

object (LocalizedString)

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

coach

string

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

seat

string

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

seatAssignment

object (LocalizedString)

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

FareClass

Enums
FARE_CLASS_UNSPECIFIED
ECONOMY
economy

Alter Alias für ECONOMY. Verworfen.

FIRST
first

Alter Alias für FIRST. Verworfen.

BUSINESS
business

Alter Alias für BUSINESS. Verworfen.

TripType

Enums
TRIP_TYPE_UNSPECIFIED
ROUND_TRIP
roundTrip

Alter Alias für ROUND_TRIP. Verworfen.

ONE_WAY
oneWay

Alter Alias für ONE_WAY. Verworfen.

ActivationStatus

Der Aktivierungsstatus des Objekts. Dieses Feld enthält den Aktivierungsstatus, wenn das Wert die Aktivierung unterstützt.

JSON-Darstellung
{
  "state": enum (State)
}
Felder
state

enum (State)

Status

Enums
UNKNOWN_STATE
NOT_ACTIVATED Nicht aktiviert (Standardstatus)
not_activated

Alter Alias für NOT_ACTIVATED. Verworfen.

ACTIVATED Aktiviert
activated

Alter Alias für ACTIVATED. Verworfen.

DeviceContext

Gerätekontext, der dem Objekt zugeordnet ist.

JSON-Darstellung
{
  "deviceToken": string
}
Felder
deviceToken

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.

Methoden

addmessage

Fügt dem Verkehrsobjekt, auf das die angegebene Objekt-ID verweist, eine Nachricht hinzu.

get

Gibt das Verkehrsobjekt mit der angegebenen Objekt-ID zurück.

insert

Fügt ein Verkehrsobjekt mit der angegebenen ID und den angegebenen Eigenschaften ein.

list

Gibt eine Liste aller Verkehrsobjekte für eine bestimmte Aussteller-ID zurück.

patch

Aktualisiert das Verkehrsobjekt, auf das von der angegebenen Objekt-ID verwiesen wird.

update

Aktualisiert das Verkehrsobjekt, auf das von der angegebenen Objekt-ID verwiesen wird.