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)
    }
  ],
  "merchantLocations": [
    {
      object (MerchantLocation)
    }
  ]
}
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 werden soll.
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: „en-US“, „en-GB“, „de“ oder „de-AT“.
customTransitTerminusNameLabel

object (LocalizedString)

Ein benutzerdefiniertes Label, das für den Wert „Name der Endstation des Verkehrsmittels“ (transitObject.ticketLeg.transitTerminusName) verwendet werden soll.
customTicketNumberLabel

object (LocalizedString)

Ein benutzerdefiniertes Label, das für den Wert der Ticketnummer (transitObject.ticketNumber) verwendet werden soll.
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 Zeiteinschränkungen (transitObject.ticketRestrictions.timeRestrictions).
customOtherRestrictionsLabel

object (LocalizedString)

Ein benutzerdefiniertes Label, das für den Wert „Sonstige Einschränkungen“ (transitObject.ticketRestrictions.otherRestrictions) verwendet werden soll.
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 für den Wert der Mitteilung zum öffentlichen Nahverkehrsrabatt (transitObject.purchaseDetails.ticketCost.discountMessage).
customCarriageLabel

object (LocalizedString)

Ein benutzerdefiniertes Label, das für den Wagenwert (transitObject.ticketLeg.carriage) verwendet werden soll.
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 Einstiegsplattform (transitObject.ticketLeg.platform).
customZoneLabel

object (LocalizedString)

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

object (LocalizedString)

Ein benutzerdefiniertes Label, das für den Wert der Preisklasse (transitObject.ticketLeg.ticketSeat.fareClass) verwendet werden soll.
customConcessionCategoryLabel

object (LocalizedString)

Ein benutzerdefiniertes Label für den Wert der Kategorie für die ÖPNV-Berechtigung (transitObject.concessionCategory).
customFareNameLabel

object (LocalizedString)

Ein benutzerdefiniertes Label für den Wert „Name des öffentlichen Nahverkehrstarifs“ (transitObject.ticketLeg.fareName).
classTemplateInfo

object (ClassTemplateInfo)

Vorlageninformationen dazu, wie der Kurs angezeigt werden soll. Wenn diese Einstellung nicht festgelegt ist, verwendet Google standardmäßig einen Satz von Feldern, die angezeigt werden sollen.
enableSingleLegItinerary

boolean

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

string

Erforderlich. Die eindeutige Kennung für einen Kurs. Diese ID muss für alle Klassen 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.
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. Sobald der Status der Überprüfung von draft geändert wurde, kann er nicht mehr zu draft zurückgesetzt werden.

Wenn der Kurs noch in der Entwicklungsphase ist, sollte dieses Feld auf draft 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 Rezensionskommentare, die von der Plattform festgelegt werden, wenn ein Kurs mit approved oder rejected gekennzeichnet ist.
infoModuleData
(deprecated)

object (InfoModuleData)

Verworfen. Verwenden Sie stattdessen „textModulesData“.
imageModulesData[]

object (ImageModuleData)

Daten des Bildmoduls. Maximal werden ein Feld auf Objektebene und ein Feld auf Klassenobjektebene angezeigt.
textModulesData[]

object (TextModuleData)

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

Der Ländercode, der zum Anzeigen des Landes der Karte verwendet wird, wenn sich der Nutzer nicht in diesem Land befindet, sowie zum Anzeigen lokalisierter Inhalte, wenn Inhalte nicht in der Sprache des Nutzers verfügbar sind.
heroImage

object (Image)

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

object (Image)

Verworfen.
enableSmartTap

boolean

Gibt an, ob diese Klasse Smart Tap 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 ist, z. B. #ffcc00. Du kannst auch die Kurzversion des RGB-Triplets (#rgb) verwenden, z. B. #fc0.
localizedIssuerName

object (LocalizedString)

Übersetzte Strings für den „issuerName“. Die empfohlene maximale Länge ist 20 Zeichen, damit der vollständige String auf kleineren Displays 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, mit denen der Aussteller bei jedem Speichern/Löschen eines Objekts für diese Klasse durch den Endnutzer zurückgerufen wird. 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 die Freischaltanforderungen für das Fahrkartenticket 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 „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. Maximal zehn pro Kurs. Bei einer Karte/einem Ticket werden nur zehn angezeigt, wobei die Karten/Tickets des Objekts priorisiert werden.
merchantLocations[]

object (MerchantLocation)

Händlerstandorte Ein Kurs kann maximal zehn Teilnehmer haben. Alle zusätzlichen Standorte, die über die 10 hinausgehen, werden abgelehnt. An diesen Orten wird eine Benachrichtigung ausgelöst, wenn ein Nutzer sich in einem von Google festgelegten Umkreis um den Punkt befindet. Dieses Feld ersetzt das eingestellte Feld „LatLongPoints“.

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 den Kurs

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

string

HTTPS-URL, die REST-Semantik unterstützt. Wird verwendet, um die Aktivierung von Partnern für ein bestimmtes Präsent anzufordern, das von Nutzern ausgelöst wird.
allowReactivation

boolean

Mit dieser Markierung können Nutzer den Aktivierungsanruf von einem anderen Gerät aus starten. So kann der Client die Schaltfläche „Aktivieren“ auch dann anzeigen, wenn der Aktivierungsstatus „AKTIVIERT“ ist, sich das angeforderte Gerät aber vom aktuellen Gerät unterscheidet.

Methoden

addmessage

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

get

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

insert

 Fügt eine öffentliche Verkehrsmittelklasse mit der angegebenen ID und den angegebenen Properties 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 Mobilitätsklasse, auf die durch die angegebene Klassen-ID verwiesen wird.