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

object (LocalizedString)

Der Name des Verkehrsunternehmens.
transitType

enum (TransitType)

Erforderlich. Der Typ von öffentlichen Verkehrsmitteln, 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 ausgeliefert werden, immer in dieser Sprache angezeigt. Stellt das Sprach-Tag BCP 47 dar. Beispielwerte sind „en-US“, „en-GB“, „de“ oder „de-AT“.
customTransitTerminusNameLabel

object (LocalizedString)

Ein benutzerdefiniertes Label, das für den Namen der Endhaltestelle des öffentlichen Verkehrsmittels verwendet werden soll (transitObject.ticketLeg.transitTerminusName).
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 für Routeneinschränkungen (transitObject.ticketRestrictions.routeRestrictions) verwendet werden soll.
customRouteRestrictionsDetailsLabel

object (LocalizedString)

Ein benutzerdefiniertes Label, das für den Wert der Routeneinschränkungen verwendet wird (transitObject.ticketRestrictions.routeRestrictionsDetails).
customTimeRestrictionsLabel

object (LocalizedString)

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

object (LocalizedString)

Ein benutzerdefiniertes Label, das für den anderen Einschränkungswert (transitObject.ticketRestrictions.otherRestrictions) verwendet werden soll.
customPurchaseReceiptNumberLabel

object (LocalizedString)

Ein benutzerdefiniertes Label, das für den Wert der Kaufbelegnummer (transitObject.purchaseDetails.purchaseReceiptNumber) verwendet werden soll.
customConfirmationCodeLabel

object (LocalizedString)

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

object (LocalizedString)

Ein benutzerdefiniertes Label, das für den Nennwert des Kaufs verwendet werden soll (transitObject.purchaseDetails.ticketCost.faceValue).
customPurchasePriceLabel

object (LocalizedString)

Ein benutzerdefiniertes Label für den Kaufpreiswert (transitObject.purchaseDetails.ticketCost.purchasePrice).
customDiscountMessageLabel

object (LocalizedString)

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

object (LocalizedString)

Ein benutzerdefiniertes Label, das für den Zeilenwert (transitObject.ticketLeg.carriage) verwendet werden soll.
customSeatLabel

object (LocalizedString)

Ein benutzerdefiniertes Label, das für den Wert der Sitzplatzposition verwendet werden soll (transitObject.ticketLeg.ticketSeat.seat).
customCoachLabel

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

Ein benutzerdefiniertes Label, das für den Wert der Boardingzone (transitObject.ticketLeg.zone) verwendet werden soll.
customFareClassLabel

object (LocalizedString)

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

object (LocalizedString)

Ein benutzerdefiniertes Label, das für den Wert der Kategorie für öffentliche Verkehrsmittel (transitObject.concessionCategory) verwendet werden soll.
customFareNameLabel

object (LocalizedString)

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

object (ClassTemplateInfo)

Vorlageninformationen dazu, wie die Klasse angezeigt werden soll. Wenn die Richtlinie nicht konfiguriert ist, verwendet Google einen Standardsatz von Feldern, die angezeigt werden sollen.
enableSingleLegItinerary

boolean

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

string

Erforderlich. Die eindeutige Kennung für eine Klasse. Diese ID muss für alle Klassen 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. Ihre eindeutige Kennung darf nur alphanumerische Zeichen, „.“, „_“ oder „-“ enthalten.
version
(deprecated)

string (int64 format)

Eingestellte Funktionen
issuerName

string

Erforderlich. Der Ausstellername. Die empfohlene maximale Länge ist 20 Zeichen, damit der vollständige String auf kleineren Displays angezeigt wird.
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.
allowMultipleUsersPerObject
(deprecated)

boolean

Veraltet. Verwenden Sie stattdessen multipleDevicesAndHoldersAllowedStatus.
homepageUri

object (Uri)

URI der Startseite Ihrer Anwendung. Das Ausfüllen des URI in dieses Feld führt genau zu dem gleichen Verhalten wie das Ausfüllen eines URI in „linksModuleData“. Beim Rendern eines Objekts wird ein Link zur Startseite angezeigt, was normalerweise als LinksModuleData-Abschnitt des Objekts angesehen wird.
locations[]

object (LatLongPoint)

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

enum (ReviewStatus)

Erforderlich. Der Status des Kurses. Dieses Feld kann mithilfe der API-Aufrufe „Insert“, „Patch“ oder „Update“ auf draft oder underReview festgelegt werden. Wenn der Überprüfungsstatus von „draft“ geändert wird, kann er nicht mehr zu „draft“ geändert werden.

Sie sollten dieses Feld auf draft belassen, wenn sich die Klasse in der Entwicklung befindet. Eine draft-Klasse kann nicht zum Erstellen von Objekten verwendet werden.

Sie sollten dieses Feld auf underReview setzen, wenn Sie der Meinung sind, dass der Kurs einsatzbereit ist. Die Plattform setzt dieses Feld automatisch auf approved und kann sofort zum Erstellen oder Migrieren von Objekten verwendet werden.

Wenn Sie einen bereits approved-Kurs aktualisieren, sollten Sie dieses Feld auf underReview setzen.
review

object (Review)

Die Kommentare, die von der Plattform eingestellt werden, wenn ein Kurs mit approved oder rejected markiert ist.
infoModuleData
(deprecated)

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.
redemptionIssuers[]

string (int64 format)

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

Die Felder enableSmartTap und smartTapRedemptionLevel auf Objektebene müssen ebenfalls korrekt eingerichtet sein, damit Karten/Tickets Smart-Bonus unterstützen.
countryCode

string

Der Ländercode wird verwendet, um das Land der Karte anzuzeigen (wenn der Nutzer sich nicht in diesem Land befindet) sowie um lokalisierte Inhalte anzuzeigen, wenn diese für die Sprache des Nutzers nicht verfügbar sind.
heroImage

object (Image)

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

object (Image)

Veraltet.
enableSmartTap

boolean

Gibt an, ob diese Klasse Smart-Bonus unterstützt. Die Felder redemptionIssuers und smartTapRedemptionLevel auf Objektebene müssen ebenfalls korrekt eingerichtet sein, damit Karten/Tickets Smart-Bonus unterstützen.
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.
localizedIssuerName

object (LocalizedString)

Übersetzte Strings für den Ausstellername. 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 und auf diese Klasse verweisen.
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 kommen für den Callback infrage.
securityAnimation

object (SecurityAnimation)

Optionale Informationen zur Sicherheitsanimation. Wenn dies festgelegt ist, wird eine Sicherheitsanimation in den Details der Karte / des Tickets gerendert.
activationOptions

object (ActivationOptions)

Aktivierungsoptionen für ein Ticket, das aktiviert werden kann.
viewUnlockRequirement

enum (ViewUnlockRequirement)

Optionen für Entsperranforderung für die Fahrkarte ansehen.

TransitType

Enums
TRANSIT_TYPE_UNSPECIFIED
BUS
bus

Altes Alias für BUS. Veraltet.
RAIL
rail

Altes Alias für RAIL. Veraltet.
TRAM
tram

Altes Alias für TRAM. Veraltet.
FERRY
ferry

Altes Alias für FERRY. Veraltet.
OTHER
other

Altes Alias für OTHER. Veraltet.

ActivationOptions

ActivationOptions für die Klasse

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

string

HTTPS-URL, die REST-Semantik unterstützt. Würde verwendet, um Aktivierungsanfragen von Partnern für einen bestimmten Wert zu verlangen, der von den Nutzern ausgelöst wird.
allowReactivation

boolean

Flag, das Nutzern ermöglicht, einen Aktivierungsaufruf von einem anderen Gerät aus durchzuführen. So kann der Client die Aktivierungsschaltfläche auch dann als aktiviert rendern, wenn der Aktivierungsstatus AKTIVIERT ist, das angeforderte Gerät jedoch nicht das aktuelle Gerät ist.

Methoden

addmessage

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

get

 Gibt die Verkehrsklasse mit der angegebenen Klassen-ID zurück.

insert

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

list

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

patch

 Aktualisiert die Verkehrsklasse, auf die die angegebene Klassen-ID verweist.

update

 Aktualisiert die Verkehrsklasse, auf die die angegebene Klassen-ID verweist.