REST Resource: transitclass

Risorsa: TransitClass

Rappresentazione JSON 
{
  "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)
    }
  ]
}
Campi
transitOperatorName

object (LocalizedString)

Il nome dell'operatore di trasporto pubblico.
transitType

enum (TransitType)

Obbligatorio. Il tipo di trasporto pubblico rappresentato da questa classe, ad esempio "bus".
watermark

object (Image)

Immagine della filigrana da visualizzare sul dispositivo dell'utente.
languageOverride

string

Se questo campo è presente, i biglietti del trasporto pubblico mostrati sul dispositivo di un utente saranno sempre in questa lingua. Rappresenta il tag lingua BCP 47. I valori di esempio sono "en-US", "en-GB", "de" o "de-AT".
customTransitTerminusNameLabel

object (LocalizedString)

Un'etichetta personalizzata da utilizzare per il valore del nome del terminal di transito (transitObject.ticketLeg.transitTerminusName).
customTicketNumberLabel

object (LocalizedString)

Un'etichetta personalizzata da utilizzare per il valore del numero di biglietto (transitObject.ticketNumber).
customRouteRestrictionsLabel

object (LocalizedString)

Un'etichetta personalizzata da utilizzare per il valore delle limitazioni di percorso (transitObject.ticketRestrictions.routeRestrictions).
customRouteRestrictionsDetailsLabel

object (LocalizedString)

Un'etichetta personalizzata da utilizzare per il valore dei dettagli delle limitazioni del percorso (transitObject.ticketRestrictions.routeRestrictionsDetails).
customTimeRestrictionsLabel

object (LocalizedString)

Un'etichetta personalizzata da utilizzare per il valore dei dettagli delle limitazioni temporali (transitObject.ticketRestrictions.timeRestrictions).
customOtherRestrictionsLabel

object (LocalizedString)

Un'etichetta personalizzata da utilizzare per l'altro valore delle limitazioni (transitObject.ticketRestrictions.otherRestrictions).
customPurchaseReceiptNumberLabel

object (LocalizedString)

Un'etichetta personalizzata da utilizzare per il valore del numero della ricevuta di acquisto (transitObject.purchaseDetails.purchaseReceiptNumber).
customConfirmationCodeLabel

object (LocalizedString)

Un'etichetta personalizzata da utilizzare per il valore del codice di conferma (transitObject.purchaseDetails.confirmationCode).
customPurchaseFaceValueLabel

object (LocalizedString)

Un'etichetta personalizzata da utilizzare per il valore nominale di acquisto (transitObject.purchaseDetails.ticketCost.faceValue).
customPurchasePriceLabel

object (LocalizedString)

Un'etichetta personalizzata da utilizzare per il valore del prezzo di acquisto (transitObject.purchaseDetails.ticketCost.purchasePrice).
customDiscountMessageLabel

object (LocalizedString)

Un'etichetta personalizzata da utilizzare per il valore del messaggio di sconto per il trasporto pubblico (transitObject.purchaseDetails.ticketCost.discountMessage).
customCarriageLabel

object (LocalizedString)

Un'etichetta personalizzata da utilizzare per il valore del carrello (transitObject.ticketLeg.carriage).
customSeatLabel

object (LocalizedString)

Un'etichetta personalizzata da utilizzare per il valore della posizione del posto (transitObject.ticketLeg.ticketSeat.seat).
customCoachLabel

object (LocalizedString)

Un'etichetta personalizzata da utilizzare per il valore del Coach (transitObject.ticketLeg.ticketSeat.coach).
customPlatformLabel

object (LocalizedString)

Un'etichetta personalizzata da utilizzare per il valore della piattaforma di imbarco (transitObject.ticketLeg.platform).
customZoneLabel

object (LocalizedString)

Un'etichetta personalizzata da utilizzare per il valore della zona di imbarco (transitObject.ticketLeg.zone).
customFareClassLabel

object (LocalizedString)

Un'etichetta personalizzata da utilizzare per il valore della classe tariffaria (transitObject.ticketLeg.ticketSeat.fareClass).
customConcessionCategoryLabel

object (LocalizedString)

Un'etichetta personalizzata da utilizzare per il valore della categoria della concessione per il trasporto pubblico (transitObject.concessionCategory).
customFareNameLabel

object (LocalizedString)

Un'etichetta personalizzata da utilizzare per il valore del nome della tariffa del trasporto pubblico (transitObject.ticketLeg.fareName).
classTemplateInfo

object (ClassTemplateInfo)

Informazioni sul modello relative alla visualizzazione del corso. Se non viene impostato, Google utilizzerà un insieme predefinito di campi da visualizzare.
enableSingleLegItinerary

boolean

Consente di controllare la visualizzazione dell'itinerario di una sola tappa per questa lezione. Per impostazione predefinita, viene visualizzato un itinerario solo per le corse con più tappe.
id

string

Obbligatorio. L'identificatore univoco di una classe. Questo ID deve essere univoco in tutte le classi di un emittente. Questo valore deve seguire il formato issuer ID.identifier: il primo viene emesso da Google, mentre il secondo è scelto da te. Il tuo identificatore univoco deve includere solo caratteri alfanumerici, ".", "_" o "-".
version
(deprecated)

string (int64 format)

Deprecato
issuerName

string

Obbligatorio. Il nome dell'emittente. La lunghezza massima consigliata è di 20 caratteri per garantire che la stringa completa venga visualizzata su schermi più piccoli.
messages[]

object (Message)

Un array di messaggi visualizzati nell'app. Tutti gli utenti di questo oggetto riceveranno i messaggi associati. Il numero massimo di questi campi è 10.
allowMultipleUsersPerObject
(deprecated)

boolean

Deprecato. Usa invece il criterio multipleDevicesAndHoldersAllowedStatus.
homepageUri

object (Uri)

L'URI della home page della tua applicazione. Il completamento dell'URI in questo campo ha lo stesso comportamento della compilazione di un URI in linksModuleData (quando viene eseguito il rendering di un oggetto, viene mostrato un link alla home page in quella che in genere verrebbe considerata la sezione linksModuleData dell'oggetto).
locations[]
(deprecated)

object (LatLongPoint)

Nota: al momento questo campo non è supportato per attivare le notifiche geografiche.
reviewStatus

enum (ReviewStatus)

Obbligatorio. Lo stato del corso. Questo campo può essere impostato su draft o underReview utilizzando le chiamate API insert, patch o update. Una volta cambiato lo stato della revisione da draft, non è possibile tornare a draft.

Devi mantenere questo campo su draft quando il corso è in fase di sviluppo. Non è possibile utilizzare una classe draft per creare alcun oggetto.

Devi impostare questo campo su underReview quando ritieni che il corso sia pronto per l'uso. La piattaforma imposterà automaticamente questo campo su approved e potrà essere utilizzato immediatamente per creare o eseguire la migrazione di oggetti.

Quando aggiorni un corso già approved, devi continuare a impostare questo campo su underReview.
review

object (Review)

I commenti della revisione impostati dalla piattaforma quando un corso è contrassegnato come approved o rejected.
infoModuleData
(deprecated)

object (InfoModuleData)

Deprecato. Utilizza invece textModulesData.
imageModulesData[]

object (ImageModuleData)

Dati del modulo immagine. Il numero massimo di questi campi visualizzati è 1 a livello di oggetto e 1 a livello di oggetto della classe.
textModulesData[]

object (TextModuleData)

Dati del modulo di testo. Se i dati dei moduli di testo sono definiti anche per il corso, verranno visualizzati entrambi. Il numero massimo di questi campi visualizzati è 10 dall'oggetto e 10 dalla classe.
redemptionIssuers[]

string (int64 format)

Identifica quali emittenti possono riscattare la tessera tramite Smart Tap. Gli emittenti che hanno emesso i rimborsi sono identificati tramite l'ID emittente. Gli emittenti dell'utilizzo devono avere configurato almeno un tasto Smart Tap.

Anche i campi enableSmartTap e smartTapRedemptionLevel a livello di oggetto devono essere configurati correttamente affinché una tessera supporti Smart Tap.
countryCode

string

Codice paese utilizzato per mostrare il paese della carta (quando l'utente non si trova in quel paese) e per mostrare contenuti localizzati quando i contenuti non sono disponibili nella lingua dell'utente.
heroImage

object (Image)

Immagine del banner facoltativa visualizzata sulla parte anteriore della scheda. Se non è presente, non verrà visualizzato nulla. L'immagine verrà visualizzata con una larghezza al 100%.
wordMark
(deprecated)

object (Image)

Deprecato.
enableSmartTap

boolean

Indica se questa classe supporta il tocco intelligente. Anche i campi redemptionIssuers e smartTapRedemptionLevel a livello di oggetto devono essere configurati correttamente affinché una tessera supporti il tocco intelligente.
hexBackgroundColor

string

Il colore di sfondo della scheda. Se non è impostato, viene utilizzato il colore dominante dell'immagine hero e, se non è impostata alcuna immagine hero, viene utilizzato il colore dominante del logo. Il formato è #rrggbb, dove rrggbb è una tripletta RGB esadecimale, ad esempio #ffcc00. Puoi anche utilizzare la versione abbreviata della terzina RGB che è il numero rgb, ad esempio #fc0.
localizedIssuerName

object (LocalizedString)

Stringhe tradotte per il valore IssuerName. La lunghezza massima consigliata è di 20 caratteri per garantire che la stringa completa venga visualizzata su schermi più piccoli.
multipleDevicesAndHoldersAllowedStatus

enum (MultipleDevicesAndHoldersAllowedStatus)

Indica se più utenti e dispositivi salveranno lo stesso oggetto facendo riferimento a questa classe.
callbackOptions

object (CallbackOptions)

Opzioni di callback da utilizzare per richiamare l'emittente a ogni salvataggio/eliminazione di un oggetto per questa classe da parte dell'utente finale. Tutti gli oggetti di questa classe sono idonei per il callback.
securityAnimation

object (SecurityAnimation)

Informazioni facoltative sull'animazione di sicurezza. Se questa opzione è impostata, verrà visualizzata un'animazione di sicurezza nei dettagli della tessera.
activationOptions

object (ActivationOptions)

Opzioni di attivazione per un biglietto attivabile.
viewUnlockRequirement

enum (ViewUnlockRequirement)

Visualizza le opzioni relative ai requisiti di sblocco per il biglietto del trasporto pubblico.
notifyPreference

enum (NotificationSettingsForUpdates)

Indica se gli aggiornamenti dei campi per questa classe devono attivare le notifiche. Se impostato su NOTIFY, si proverà ad attivare una notifica di aggiornamento dei campi per gli utenti. Queste notifiche verranno inviate agli utenti solo se il campo fa parte di una lista consentita. Se impostato su DO_NOT_NOTIFY o NOTIFICATION_SETTINGS_UNSPECIFIED, non verrà attivata alcuna notifica. Questa impostazione è temporanea e deve essere configurata con ogni richiesta PATCH o UPDATE, altrimenti non verrà attivata alcuna notifica.
valueAddedModuleData[]

object (ValueAddedModuleData)

Dati facoltativi del modulo sul valore aggiunto. Massimo dieci per corso. Per un passaggio ne verranno visualizzati solo dieci, dando la priorità a quelli dell'oggetto.

TransitType

Enum
TRANSIT_TYPE_UNSPECIFIED
BUS
bus

Alias precedente per BUS. Deprecato.
RAIL
rail

Alias precedente per RAIL. Deprecato.
TRAM
tram

Alias precedente per TRAM. Deprecato.
FERRY
ferry

Alias precedente per FERRY. Deprecato.
OTHER
other

Alias precedente per OTHER. Deprecato.

ActivationOptions

ActivationOptions per il corso

Rappresentazione JSON 
{
  "activationUrl": string,
  "allowReactivation": boolean
}
Campi
activationUrl

string

URL HTTPS che supporta la semantica REST. Verrà utilizzato per richiedere l'attivazione dai partner per un determinato valore, attivata dagli utenti.
allowReactivation

boolean

Indica se consentire agli utenti di effettuare la chiamata di attivazione da un dispositivo diverso. In questo modo, il client può visualizzare il pulsante di attivazione abilitato anche se il valore activationStatus è ACTIVATED, ma il dispositivo richiesto è diverso da quello corrente.

Metodi

addmessage

 Aggiunge un messaggio alla classe di transito a cui fa riferimento l'ID classe specificato.

get

 Restituisce la classe di trasporto pubblico con l'ID classe specificato.

insert

 Inserisce una classe di transito con l'ID e le proprietà specificati.

list

 Restituisce un elenco di tutte le classi di trasporto pubblico per un determinato ID emittente.

patch

 Aggiorna la classe di trasporto pubblico a cui fa riferimento l'ID classe specificato.

update

 Aggiorna la classe di transito a cui fa riferimento l'ID classe specificato.