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)
  }
}
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 pubblicati 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 ticket (transitObject.ticketNumber).
customRouteRestrictionsLabel

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

Un'etichetta personalizzata da utilizzare per il valore dei dettagli dei limiti di tempo (transitObject.ticketRestrictions.timeRestrictions).
customOtherRestrictionsLabel

object (LocalizedString)

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

object (LocalizedString)

Un'etichetta personalizzata da utilizzare per il valore del numero di 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 dell'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 utenza (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 su come deve essere visualizzato il corso. Se il criterio non viene configurato, Google utilizzerà un insieme predefinito di campi da visualizzare.
enableSingleLegItinerary

boolean

Controlla la visualizzazione dell'itinerario di un solo tratto per questa classe. Per impostazione predefinita, un itinerario viene visualizzato solo per le corse con più tappe.
id

string

obbligatorio. L'identificatore univoco di una classe. Questo ID deve essere univoco per tutti i corsi di un emittente. Questo valore deve essere nel formato issuer ID.identifier, dove la prima è rilasciata da Google e la seconda è scelta da te. L'identificatore univoco deve includere solo caratteri alfanumerici, ".", "_" o "-".
version
(deprecated)

string (int64 format)

Deprecata
issuerName

string

obbligatorio. Il nome dell'emittente. La lunghezza massima consigliata è di 20 caratteri per garantire che l'intera stringa 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 dell'applicazione. Il completamento dell'URI in questo campo comporta lo stesso comportamento di un URI in linksModuleData (quando viene visualizzato un oggetto, viene mostrato un link alla home page in quella che solitamente viene considerata la sezione linksModuleData dell'oggetto).
locations[]

object (LatLongPoint)

Nota: questo campo non è attualmente 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 di inserimento, patch o aggiornamento. Una volta che lo stato della revisione passa da draft, non può essere reimpostato su draft.

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

Imposta 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 migrare gli oggetti.

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

object (Review)

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

object (InfoModuleData)

Deprecato. Usa 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 classe.
textModulesData[]

object (TextModuleData)

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

string (int64 format)

Identifica quali emittenti di promozioni possono utilizzare la tessera tramite Smart Tap. Gli emittenti di rimborsi sono identificati in base al loro ID emittente. Gli emittenti di promozioni devono avere almeno una chiave Smart Tap configurata.

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

string

Codice paese utilizzato per visualizzare il paese della scheda (quando l'utente non si trova in quel paese) e per visualizzare contenuti localizzati quando 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 al 100% di larghezza.
wordMark
(deprecated)

object (Image)

Deprecato.
enableSmartTap

boolean

Identifica se questo corso supporta Smart Tap. Anche i campi redemptionIssuers e smartTapRedemptionLevel a livello di oggetto devono essere configurati correttamente affinché una tessera supporti la funzionalità Smart Tap.
hexBackgroundColor

string

Il colore di sfondo della scheda. Se non viene 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 usare la versione abbreviata della terzina RGB, che è #rgb, ad esempio #fc0.
localizedIssuerName

object (LocalizedString)

Stringhe tradotte per l'emittenteName. La lunghezza massima consigliata è di 20 caratteri per garantire che l'intera stringa venga visualizzata su schermi più piccoli.
multipleDevicesAndHoldersAllowedStatus

enum (MultipleDevicesAndHoldersAllowedStatus)

Identifica se più utenti e dispositivi salveranno lo stesso oggetto con 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 impostazione è impostata, verrà visualizzata un'animazione di sicurezza nei dettagli del pass.
activationOptions

object (ActivationOptions)

Opzioni di attivazione per un ticket attivabile.
viewUnlockRequirement

enum (ViewUnlockRequirement)

Visualizza le opzioni dei requisiti di sblocco per il biglietto per il trasporto pubblico.

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 ai partner per un dato valore, attivato dagli utenti.
allowReactivation

boolean

Segnala per consentire agli utenti di effettuare la chiamata di attivazione da un altro dispositivo. In questo modo il client può rendere abilitato il pulsante di attivazione anche se lo stato di activationStatus è ATTIVATO, ma il dispositivo richiesto è diverso dal dispositivo corrente.

Metodi

addmessage

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

get

 Restituisce la classe del trasporto pubblico con l'ID della classe specificato.

insert

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

list

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

patch

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

update

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