REST Resource: transitclass

Ressource: TransitClass

JSON-Darstellung 
{
  "transitOperatorName": {
    object (LocalizedString)
  },
  "logo": {
    object (Image)
  },
  "transitType": enum (TransitType),
  "watermark": {
    object (Image)
  },
  "languageOverride": string,
  "customTransitTerminusNameLabel": {
    object (LocalizedString)
  },
  "customTicketNumberLabel": {
    object (LocalizedString)
  },
  "customRouteRestrictionsLabel": {
    object (LocalizedString)
  },
  "customRouteRestrictionsDetailsLabel": {
    object (LocalizedString)
  },
  "customTimeRestrictionsLabel": {
    object (LocalizedString)
  },
  "customOtherRestrictionsLabel": {
    object (LocalizedString)
  },
  "customPurchaseReceiptNumberLabel": {
    object (LocalizedString)
  },
  "customConfirmationCodeLabel": {
    object (LocalizedString)
  },
  "customPurchaseFaceValueLabel": {
    object (LocalizedString)
  },
  "customPurchasePriceLabel": {
    object (LocalizedString)
  },
  "customDiscountMessageLabel": {
    object (LocalizedString)
  },
  "customCarriageLabel": {
    object (LocalizedString)
  },
  "customSeatLabel": {
    object (LocalizedString)
  },
  "customCoachLabel": {
    object (LocalizedString)
  },
  "customPlatformLabel": {
    object (LocalizedString)
  },
  "customZoneLabel": {
    object (LocalizedString)
  },
  "customFareClassLabel": {
    object (LocalizedString)
  },
  "customConcessionCategoryLabel": {
    object (LocalizedString)
  },
  "customFareNameLabel": {
    object (LocalizedString)
  },
  "classTemplateInfo": {
    object (ClassTemplateInfo)
  },
  "enableSingleLegItinerary": boolean,
  "id": string,
  "version": string,
  "issuerName": string,
  "messages": [
    {
      object (Message)
    }
  ],
  "allowMultipleUsersPerObject": boolean,
  "homepageUri": {
    object (Uri)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "reviewStatus": enum (ReviewStatus),
  "review": {
    object (Review)
  },
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "redemptionIssuers": [
    string
  ],
  "countryCode": string,
  "heroImage": {
    object (Image)
  },
  "wordMark": {
    object (Image)
  },
  "enableSmartTap": boolean,
  "hexBackgroundColor": string,
  "localizedIssuerName": {
    object (LocalizedString)
  },
  "multipleDevicesAndHoldersAllowedStatus": enum (MultipleDevicesAndHoldersAllowedStatus),
  "callbackOptions": {
    object (CallbackOptions)
  },
  "securityAnimation": {
    object (SecurityAnimation)
  },
  "activationOptions": {
    object (ActivationOptions)
  },
  "viewUnlockRequirement": enum (ViewUnlockRequirement),
  "wideLogo": {
    object (Image)
  },
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "appLinkData": {
    object (AppLinkData)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
Felder
transitOperatorName

object (LocalizedString)

Der Name des Verkehrsunternehmens.
transitType

enum (TransitType)

Erforderlich. Die Art des öffentlichen Verkehrs, die diese Klasse darstellt, z. B. „Bus“.
watermark

object (Image)

Wasserzeichenbild, das auf dem Gerät des Nutzers angezeigt wird.
languageOverride

string

Wenn dieses Feld vorhanden ist, werden Fahrkarten, die auf dem Gerät eines Nutzers angezeigt werden, immer in dieser Sprache angezeigt. Stellt das Sprachentag BCP 47 dar. Beispielwerte sind „en-US“, „en-GB“, „de“ oder „de-AT“.
customTransitTerminusNameLabel

object (LocalizedString)

Ein benutzerdefiniertes Label, das für den Namen des Endhaltestellens (transitObject.ticketLeg.transitTerminusName) verwendet werden soll.
customTicketNumberLabel

object (LocalizedString)

Ein benutzerdefiniertes Label für den Wert der Ticketnummer (transitObject.ticketNumber).
customRouteRestrictionsLabel

object (LocalizedString)

Ein benutzerdefiniertes Label, das für den Wert „Einschränkungen der Route“ (transitObject.ticketRestrictions.routeRestrictions) verwendet werden soll.
customRouteRestrictionsDetailsLabel

object (LocalizedString)

Ein benutzerdefiniertes Label für den Wert „Details zu Einschränkungen der Route“ (transitObject.ticketRestrictions.routeRestrictionsDetails).
customTimeRestrictionsLabel

object (LocalizedString)

Ein benutzerdefiniertes Label für den Wert der Details zur Zeitbeschränkung (transitObject.ticketRestrictions.timeRestrictions).
customOtherRestrictionsLabel

object (LocalizedString)

Ein benutzerdefiniertes Label für den anderen Einschränkungswert (transitObject.ticketRestrictions.otherRestrictions).
customPurchaseReceiptNumberLabel

object (LocalizedString)

Ein benutzerdefiniertes Label für den Wert der Kaufbelegnummer (transitObject.purchaseDetails.purchaseReceiptNumber).
customConfirmationCodeLabel

object (LocalizedString)

Ein benutzerdefiniertes Label für den Wert des Bestätigungscodes (transitObject.purchaseDetails.confirmationCode).
customPurchaseFaceValueLabel

object (LocalizedString)

Ein benutzerdefiniertes Label für den Nennwert des Kaufs (transitObject.purchaseDetails.ticketCost.faceValue).
customPurchasePriceLabel

object (LocalizedString)

Ein benutzerdefiniertes Label, das für den Kaufpreiswert (transitObject.purchaseDetails.ticketCost.purchasePrice) verwendet werden soll.
customDiscountMessageLabel

object (LocalizedString)

Ein benutzerdefiniertes Label, das für den Nachrichtenwert für den Rabatt für öffentliche Verkehrsmittel (transitObject.purchaseDetails.ticketCost.discountMessage) verwendet werden soll.
customCarriageLabel

object (LocalizedString)

Ein benutzerdefiniertes Label für den Wagenwert (transitObject.ticketLeg.carriage).
customSeatLabel

object (LocalizedString)

Ein benutzerdefiniertes Label für den Wert „Sitzplatz“ (transitObject.ticketLeg.ticketSeat.seat).
customCoachLabel

object (LocalizedString)

Ein benutzerdefiniertes Label, das für den Wert „Trainer“ (transitObject.ticketLeg.ticketSeat.coach) verwendet werden soll.
customPlatformLabel

object (LocalizedString)

Ein benutzerdefiniertes Label für den Wert der Boardingplattform (transitObject.ticketLeg.platform).
customZoneLabel

object (LocalizedString)

Ein benutzerdefiniertes Label für den Wert der Einstiegszone (transitObject.ticketLeg.zone).
customFareClassLabel

object (LocalizedString)

Ein benutzerdefiniertes Label für den Wert der Preisklasse (transitObject.ticketLeg.ticketSeat.fareClass).
customConcessionCategoryLabel

object (LocalizedString)

Ein benutzerdefiniertes Label für den Wert der Konzessionskategorie für öffentliche Verkehrsmittel (transitObject.concessionCategory).
customFareNameLabel

object (LocalizedString)

Ein benutzerdefiniertes Label, das für den Wert des Namens des Fahrpreises (transitObject.ticketLeg.fareName) verwendet werden soll.
classTemplateInfo

object (ClassTemplateInfo)

Vorlageninformationen dazu, wie der Kurs angezeigt werden soll. Wenn die Richtlinie nicht konfiguriert ist, greift Google auf die Standardfelder zurück, die angezeigt werden sollen.
enableSingleLegItinerary

boolean

Steuert die Anzeige des Reiseplans mit einem Abschnitt für diese Klasse. Standardmäßig wird ein Reiseplan nur für Fahrten mit mehreren Abschnitten angezeigt.
id

string

Erforderlich. Die eindeutige Kennung einer Klasse. Diese ID muss für alle Klassen eines Ausstellers eindeutig sein. Dieser Wert muss das Format issuer ID haben.identifier, wobei von Google ausgegeben und von dir ausgewählt wird. Die eindeutige Kennung darf nur alphanumerische Zeichen sowie „.“, „_“ oder „-“ enthalten.
version
(deprecated)

string (int64 format)

Verworfen
issuerName

string

Erforderlich. Der Name des Ausstellers. Die empfohlene maximale Länge ist 20 Zeichen, damit der vollständige String auf kleineren Displays angezeigt wird.
messages[]

object (Message)

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

boolean

Verworfen. Verwenden Sie stattdessen multipleDevicesAndHoldersAllowedStatus.
homepageUri

object (Uri)

Der URI der Startseite Ihrer Anwendung. Wenn Sie den URI in dieses Feld einfügen, wird genau dasselbe Verhalten wie beim Einfügen eines URI in „linksModuleData“ ausgelöst. Wenn ein Objekt gerendert wird, wird im Bereich „linksModuleData“ des Objekts ein Link zur Startseite angezeigt.
locations[]
(deprecated)

object (LatLongPoint)

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

enum (ReviewStatus)

Erforderlich. Der Status des Kurses. Dieses Feld kann mit den API-Aufrufen „insert“, „patch“ oder „update“ auf „draft“ oder „underReview“ gesetzt werden. Nachdem der Überprüfungsstatus von draft geändert wurde, kann er nicht mehr in draft geändert werden.

Wenn der Kurs noch in der Entwicklungsphase ist, sollte dieses Feld auf draft gesetzt bleiben. Mit einer draft-Klasse können keine Objekte erstellt werden.

Legen Sie dieses Feld auf underReview fest, wenn Sie der Meinung sind, dass der Kurs einsatzbereit ist. Dieses Feld wird von der Plattform automatisch auf approved gesetzt und kann sofort zum Erstellen oder Migrieren von Objekten verwendet werden.

Wenn Sie eine bereits vorhandene approved-Klasse aktualisieren, sollten Sie dieses Feld weiterhin auf underReview setzen.
review

object (Review)

Die von der Plattform festgelegten Rezensionskommentare, wenn ein Kurs mit approved oder rejected gekennzeichnet ist.
infoModuleData
(deprecated)

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. Es werden maximal 10 Felder des Objekts und 10 Felder der Klasse angezeigt.
redemptionIssuers[]

string (int64 format)

Gibt an, welche Einlösungsaussteller die Karte bzw. das Ticket über Smart-Bonus einlösen können. Einlösungsaussteller werden anhand ihrer Aussteller-ID identifiziert. Für Aussteller von Gutscheinen muss mindestens ein Smart Tap-Schlüssel konfiguriert sein.

Die Felder enableSmartTap und smartTapRedemptionLevel auf Objektebene müssen ebenfalls richtig eingerichtet sein, damit eine Karte/ein Ticket Smart-Bonus unterstützt.
countryCode

string

Ländercode, mit dem das Land der Karte angezeigt wird (wenn sich der Nutzer nicht in diesem Land befindet) sowie der lokalisierte Inhalt, wenn der Inhalt nicht für die Sprache des Nutzers verfügbar ist.
heroImage

object (Image)

Optionales Bannerbild, das auf der Vorderseite der Karte angezeigt wird. Ist keine vorhanden, wird nichts angezeigt. Das Bild wird mit einer Breite von 100% angezeigt.
wordMark
(deprecated)

object (Image)

Verworfen.
enableSmartTap

boolean

Gibt an, ob diese Klasse Smart-Bonus unterstützt. Die Felder redemptionIssuers und smartTapRedemptionLevel auf Objektebene müssen ebenfalls richtig eingerichtet sein, damit eine Karte/ein Ticket Smart-Bonus unterstützt.
hexBackgroundColor

string

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

object (LocalizedString)

Übersetzte Strings für den Ausstellernamen. Die empfohlene maximale Länge ist 20 Zeichen, damit der vollständige String auf kleineren Bildschirmen angezeigt wird.
multipleDevicesAndHoldersAllowedStatus

enum (MultipleDevicesAndHoldersAllowedStatus)

Gibt an, ob mehrere Nutzer und Geräte dasselbe Objekt speichern, das auf diese Klasse verweist.
callbackOptions

object (CallbackOptions)

Callback-Optionen, die verwendet werden sollen, um den Aussteller beim Speichern/Löschen eines Objekts für diese Klasse durch den Endnutzer zurückzurufen. Alle Objekte dieser Klasse können den Rückruf erhalten.
securityAnimation

object (SecurityAnimation)

Optionale Informationen zur Sicherheitsanimation. Wenn diese Option festgelegt ist, wird eine Sicherheitsanimation für die Details der Karte/des Tickets gerendert.
activationOptions

object (ActivationOptions)

Aktivierungsoptionen für ein aktivierbares Ticket.
viewUnlockRequirement

enum (ViewUnlockRequirement)

Optionen für „Entsperrung erforderlich“ für die Fahrkarte ansehen.
notifyPreference

enum (NotificationSettingsForUpdates)

Gibt an, ob Feldaktualisierungen für diese Klasse 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 temporär und muss bei jeder PATCH- oder UPDATE-Anfrage festgelegt werden. Andernfalls wird keine Benachrichtigung ausgelöst.
valueAddedModuleData[]

object (ValueAddedModuleData)

Optionale Daten zum Mehrwertmodul. Höchstens zehn pro Kurs. Für eine Karte bzw. ein Ticket werden nur zehn angezeigt, wobei die aus dem Objekt priorisiert werden.

TransitType

Enums
TRANSIT_TYPE_UNSPECIFIED
BUS
bus

Alter Alias für BUS. Verworfen.
RAIL
rail

Alter Alias für RAIL. Verworfen.
TRAM
tram

Alter Alias für TRAM. Verworfen.
FERRY
ferry

Alter Alias für FERRY. Verworfen.
OTHER
other

Alter Alias für OTHER. Verworfen.

ActivationOptions

ActivationOptions für die Klasse

JSON-Darstellung 
{
  "activationUrl": string,
  "allowReactivation": boolean
}
Felder
activationUrl

string

HTTPS-URL, die REST-Semantik unterstützt. Wird verwendet, um eine Aktivierungsanfrage für einen bestimmten Wert zu stellen, der von den Nutzern ausgelöst wird.
allowReactivation

boolean

Markierung, mit der Nutzer einen Aktivierungsaufruf von einem anderen Gerät aus tätigen können. Dadurch kann der Kunde die Aktivierungsschaltfläche aktiviert rendern, auch wenn der Aktivierungsstatus AKTIVIERT lautet, das angeforderte Gerät aber nicht das aktuelle Gerät ist.

Methoden

addmessage

 Fügt der Verkehrsklasse, auf die von der angegebenen Klassen-ID verwiesen wird, eine Nachricht hinzu.

get

 Gibt die ÖPNV-Klasse mit der angegebenen Klassen-ID zurück.

insert

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

list

 Gibt eine Liste aller Fahrkarten-/Ticketklassen für eine bestimmte Aussteller-ID zurück.

patch

 Aktualisiert die Mobilitätsklasse, auf die durch die angegebene Klassen-ID verwiesen wird.

update

 Aktualisiert die Verkehrsklasse, auf die von der angegebenen Klassen-ID verwiesen wird.