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)
  }
}
Felder
classReference

object (TransitClass)

Eine Kopie der übernommenen Felder der übergeordneten Klasse. Diese Felder werden bei einem GET 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 passengerType-Feld soll Google Kontext zu diesem Feld zur Verfügung stellen.
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. Sowohl ticketStatus als auch customTicketStatus dürfen nicht festgelegt sein.
concessionCategory

enum (ConcessionCategory)

Die Ermäßigungskategorie des Tickets.
customConcessionCategory

object (LocalizedString)

Eine benutzerdefinierte Ermäßigungskategorie, die verwendet werden soll, wenn concessionCategory nicht die richtige Option bietet. Sowohl concessionCategory als auch customConcessionCategory dürfen nicht festgelegt sein.
ticketRestrictions

object (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

object (PurchaseDetails)

Details zum Kauf dieses Tickets.
ticketLeg

object (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. Sowohl ticketLeg als auch ticketLegs dürfen nicht festgelegt sein.
ticketLegs[]

object (TicketLeg)

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 ticketLeg. Sowohl ticketLeg als auch ticketLegs dürfen nicht 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 #rgb verwenden, 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 zu bestimmen, 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, bei denen ersteres von Google ausgestellt und Letzteres von Ihnen ausgewählt wird. Die eindeutige Kennung darf nur alphanumerische Zeichen, „.“, „_“ oder „-“ enthalten.
classId

string

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
(deprecated)

string (int64 format)

Eingestellte Funktionen
state

enum (State)

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

object (Barcode)

Typ und Wert des Barcodes.
messages[]

object (Message)

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

object (TimeInterval)

Der Zeitraum, in dem dieses Objekt active ist, und kann verwendet werden. Nach Ablauf dieses Zeitraums ändert sich der Status eines Objekts in expired.
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 mit seinem Gerät verknüpft. Zur Verwendung durch ausgewählte Partner vorgesehen. Weitere Informationen erhalten Sie beim Support.
disableExpirationNotification

boolean

Gibt an, ob Benachrichtigungen explizit unterdrückt werden sollen. Wenn dieses Feld unabhängig vom Feld messages auf „true“ gesetzt ist, werden Ablaufbenachrichtigungen an den Nutzer unterdrückt. Die Standardeinstellung für dieses Feld ist „false“.

Derzeit kann dies nur für Angebote festgelegt werden.
infoModuleData

object (InfoModuleData)

Veraltet. Verwende stattdessen „textModulesData“.
imageModulesData[]

object (ImageModuleData)

Bildmoduldaten. Es werden maximal 1 Feld auf Objektebene und 1 Feld auf Klassenobjektebene angezeigt.
textModulesData[]

object (TextModuleData)

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.
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)

Mit dem Objekt verknüpfter Gerätekontext.
heroImage

object (Image)

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

object (GroupingInfo)

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

object (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 SINGLE_PASSENGER. Veraltet.
MULTIPLE_PASSENGERS
multiplePassengers

Altes Alias für MULTIPLE_PASSENGERS. Veraltet.

TicketStatus

Enums
TICKET_STATUS_UNSPECIFIED
USED
used

Altes Alias für USED. Veraltet.
REFUNDED
refunded

Altes Alias für REFUNDED. Veraltet.
EXCHANGED
exchanged

Altes Alias für EXCHANGED. Veraltet.

ConcessionCategory

Enums
CONCESSION_CATEGORY_UNSPECIFIED
ADULT
adult

Altes Alias für ADULT. Veraltet.
CHILD
child

Altes Alias für CHILD. Veraltet.
SENIOR
senior

Altes Alias für SENIOR. Veraltet.

TicketRestrictions

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

object (LocalizedString)

Einschränkungen für Routen, die befahren werden können. Das könnte z. B. der String „Reservierte CrossCountry-Züge“ sein.
routeRestrictionsDetails

object (LocalizedString)

Weitere Details zu den routeRestrictions.
timeRestrictions

object (LocalizedString)

Einschränkungen hinsichtlich der Zeiten, zu denen dieses Ticket verwendet werden kann.
otherRestrictions

object (LocalizedString)

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 (TicketCost)
  }
}
Felder
purchaseReceiptNumber

string

Belegnummer/-Kennung zur Nachverfolgung des Ticketkaufs über die Person, über die das Ticket verkauft wurde.
purchaseDateTime

string

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:

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 obigen Beispiel). In New York entspräche dies der Eastern Daylight Time (EDT). Der Offset variiert je nach Jahreszeit in Regionen, in denen die Sommerzeit gilt.

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

Ohne Offset-Informationen sind einige Rich-Funktionen möglicherweise nicht verfügbar.
accountId

string

ID des Kontos, über das das Ticket gekauft wurde.
confirmationCode

string

Der Bestätigungscode für den Kauf. Dieser kann für mehrere Tickets gleich sein und wird verwendet, um Tickets zu gruppieren.
ticketCost

object (TicketCost)

Die Kosten des Tickets.

TicketCost

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

object (Money)

Der Nennwert des Tickets.
purchasePrice

object (Money)

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

object (LocalizedString)

Eine Meldung, in der alle Arten von Rabatten beschrieben werden, die angewendet wurden.

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 Startstation. Dies ist erforderlich, wenn destinationStationCode oder originName nicht vorhanden ist.
originName

object (LocalizedString)

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

string

Der Code der Zielhaltestelle.
destinationName

object (LocalizedString)

Der Name des Ziels.
departureDateTime

string

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:

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 obigen Beispiel). In New York entspräche dies der Eastern Daylight Time (EDT). Der Offset variiert je nach Jahreszeit in Regionen, in denen die Sommerzeit gilt.

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

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 2018-06-05T20:00:00 sein. Wenn das lokale Datum und die lokale Uhrzeit an der Startstation 4 Stunden vor der UTC liegen, wird möglicherweise ein Offset von -04:00 angehängt.

Ohne Offset-Informationen sind einige Rich-Funktionen möglicherweise nicht verfügbar.
arrivalDateTime

string

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:

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 obigen Beispiel). In New York entspräche dies der Eastern Daylight Time (EDT). Der Offset variiert je nach Jahreszeit in Regionen, in denen die Sommerzeit gilt.

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

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 2018-06-05T20:00:00 lauten. Wenn das lokale Datum und die lokale Uhrzeit an der Zielstation 4 Stunden vor der UTC liegen, wird möglicherweise ein Offset von -04:00 angehängt.

Ohne Offset-Informationen sind einige Rich-Funktionen möglicherweise nicht verfügbar.
fareName

object (LocalizedString)

Kurze Beschreibung/Name des Fahrpreises für diese Fahrtstrecke. z. B. „Jederzeit Einmalgebrauch“.
carriage

string

Der Name/die Nummer des Zugs oder Schiffs, die der Fahrgast für das Einsteigen benötigt.
platform

string

Bahnsteig oder Gate, an dem der Fahrgast einsteigen kann.
zone

string

Die Zone des Einstiegs auf dem Bahnsteig.
ticketSeat

object (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. Sowohl ticketSeat als auch ticketSeats dürfen nicht festgelegt sein.
ticketSeats[]

object (TicketSeat)

Der für den Passagier bzw. die Passagiere reservierte Sitzplatz. Wenn nur ein Sitz angegeben werden soll, verwenden Sie stattdessen das Feld ticketSeat. Sowohl ticketSeat als auch ticketSeats dürfen nicht festgelegt sein.
transitOperatorName

object (LocalizedString)

Der Name des Verkehrsunternehmens, das diesen Abschnitt einer Fahrt durchführt.
transitTerminusName

object (LocalizedString)

Endhaltestelle oder Ziel des Zugs/Busses usw.

TicketSeat

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

enum (FareClass)

Die Preisklasse des lizenzierten Sitzplatzes.
customFareClass

object (LocalizedString)

Eine kundenspezifische Preisklasse, die verwendet wird, wenn keine fareClass zutrifft. Sowohl fareClass als auch customFareClass dürfen nicht festgelegt sein.
coach

string

Die Kennung des Zugwaggons oder Reisebusses, in dem sich der fahrkartenpflichtige Sitzplatz befindet. z. B. „10“
seat

string

Die ID, wo sich der kostenpflichtige Sitzplatz befindet. z. B. „42“. Wenn es keine bestimmte Kennung gibt, verwenden Sie stattdessen seatAssigment.
seatAssignment

object (LocalizedString)

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

FareClass

Enums
FARE_CLASS_UNSPECIFIED
ECONOMY
economy

Altes Alias für ECONOMY. Veraltet.
FIRST
first

Altes Alias für FIRST. Veraltet.
BUSINESS
business

Altes Alias für BUSINESS. Veraltet.

TripType

Enums
TRIP_TYPE_UNSPECIFIED
ROUND_TRIP
roundTrip

Altes Alias für ROUND_TRIP. Veraltet.
ONE_WAY
oneWay

Altes Alias für ONE_WAY. Veraltet.

ActivationStatus

Der Aktivierungsstatus des Objekts. Dieses Feld enthält den Aktivierungsstatus, sofern dieser die Aktivierung unterstützt.

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

enum (State)

Status

Enums
UNKNOWN_STATE
NOT_ACTIVATED Nicht aktiviert, das ist der Standardstatus
not_activated

Altes Alias für NOT_ACTIVATED. Veraltet.
ACTIVATED Aktiviert
activated

Altes Alias für ACTIVATED. Veraltet.

DeviceContext

Mit dem Objekt verknüpfter Gerätekontext.

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

string

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

addmessage

 Fügt dem Transitobjekt, 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 Eigenschaften ein.

list

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

patch

 Aktualisiert das Verkehrsobjekt, auf das die angegebene Objekt-ID verweist.

update

 Aktualisiert das Verkehrsobjekt, auf das die angegebene Objekt-ID verweist.