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)
  },
  "appLinkData": {
    object (AppLinkData)
  }
}
Felder
transitOperatorName

object (LocalizedString)

Der Name des Betreibers.
transitType

enum (TransitType)

Erforderlich. Der Typ des öffentlichen Verkehrsmittels, das diese Klasse repräsentiert, z. B. „Bus“.
watermark

object (Image)

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

string

Wenn dieses Feld vorhanden ist, werden Tickets für öffentliche Verkehrsmittel, die an das Gerät eines Nutzers gesendet werden, immer in dieser Sprache angezeigt. Stellt das Sprachtag 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 für den Wert der Routenbeschränkung (transitObject.ticketRestrictions.routeRestrictions).
customRouteRestrictionsDetailsLabel

object (LocalizedString)

Ein benutzerdefiniertes Label für den Wert für die Details der Routenbeschränkung (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 für den Kaufpreiswert (transitObject.purchaseDetails.ticketCost.purchasePrice).
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 der Sitzposition (transitObject.ticketLeg.ticketSeat.seat).
customCoachLabel

object (LocalizedString)

Ein benutzerdefiniertes Label für den Coach-Wert (transitObject.ticketLeg.ticketSeat.coach).
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 für den Wert des Namens des Fahrpreises (transitObject.ticketLeg.fareName).
classTemplateInfo

object (ClassTemplateInfo)

Vorlageninformationen darüber, wie die Klasse 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 Etappen 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 Ersteres von Google ausgestellt und Letzteres von Ihnen ausgewählt wird. Die eindeutige Kennung darf nur alphanumerische Zeichen sowie „.“, „_“ oder „-“ enthalten.
version
(deprecated)

string (int64 format)

Verworfen
issuerName

string

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

boolean

Verworfen. Verwenden Sie stattdessen multipleDevicesAndHoldersAllowedStatus.
homepageUri

object (Uri)

Der URI der Startseite Ihrer Anwendung. Das Ausfüllen des URI in diesem Feld führt zu demselben Verhalten wie das Ausfüllen eines URI in linksModuleData (wenn ein Objekt gerendert wird, wird ein Link zur Startseite in dem dargestellt, was man normalerweise als linkModuleData-Abschnitt des Objekts bezeichnen würde).
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 zum Einfügen, Patchen oder Aktualisieren auf draft oder underReview festgelegt werden. Nachdem der Überprüfungsstatus von draft geändert wurde, kann er nicht mehr in 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 eines Objekts 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 es kann sofort zum Erstellen oder Migrieren von Objekten verwendet werden.

Wenn Sie eine bereits 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 als approved oder rejected markiert wird.
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. Die maximale Anzahl der angezeigten Felder beträgt 10 vom -Objekt und 10 aus der Klasse.
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. Einlösungsaussteller müssen mindestens einen Smart-Bonus-Schlüssel konfiguriert haben.

Die Felder „enableSmartTap“ und „smartTapRedemptionLevel“ auf Objektebene müssen ebenfalls korrekt eingerichtet sein, damit Smart-Bonus von Karten/Tickets unterstützt wird.
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 korrekt eingerichtet sein, damit Smart-Bonus von Karten/Tickets unterstützt wird.
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.
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 sind für den Callback berechtigt.
securityAnimation

object (SecurityAnimation)

Optionale Informationen zur Sicherheitsanimation. Wenn diese Richtlinie konfiguriert ist, wird bei den Details der Karte / des Tickets eine Sicherheitsanimation gerendert.
activationOptions

object (ActivationOptions)

Aktivierungsoptionen für ein zu aktivierendes Ticket.
viewUnlockRequirement

enum (ViewUnlockRequirement)

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

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 Verkehrsklasse 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 Verkehrsklassen für eine bestimmte Aussteller-ID zurück.

patch

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

update

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