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)
    }
  ],
  "merchantLocations": [
    {
      object (MerchantLocation)
    }
  ]
}
Campi
transitOperatorName

object (LocalizedString)

Il nome dell'operatore dei trasporti pubblici.
transitType

enum (TransitType)

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

object (Image)

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

string

Se questo campo è presente, i biglietti del trasporto pubblico inviati al dispositivo di un utente saranno sempre in questa lingua. Rappresenta il tag lingua BCP 47. Alcuni 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 capolinea dei trasporti pubblici (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 di orario (transitObject.ticketRestrictions.timeRestrictions).
customOtherRestrictionsLabel

object (LocalizedString)

Un'etichetta personalizzata da utilizzare per il valore Altre restrizioni (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 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 di trasporto (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 dell'allenatore (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

Controlla la visualizzazione dell'itinerario con un solo scalo per questa classe. Per impostazione predefinita, un itinerario viene visualizzato solo per i viaggi con più tappe.
id

string

Obbligatorio. L'identificatore univoco di un corso. Questo ID deve essere univoco per tutte le classi di un emittente. Questo valore deve seguire il formato issuer ID.identifier, dove il primo è emesso da Google e il secondo è scelto da te. L'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. Utilizza invece multipleDevicesAndHoldersAllowedStatus.
homepageUri

object (Uri)

L'URI della home page dell'applicazione. Se compili l'URI in questo campo, il comportamento è esattamente lo stesso di quello che si ottiene compilando un URI in linksModuleData (quando viene visualizzato un oggetto, viene mostrato un link alla home page nella 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 modificato lo stato della revisione da draft, non è possibile ripristinare draft.

Quando il corso è in fase di sviluppo, devi mantenere questo campo su draft. 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 recensione 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 nel corso 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 gli emittenti di coupon che possono utilizzare la tessera tramite Smart Tap. Gli emittenti dei premi sono identificati dal relativo ID emittente. Gli emittenti di premi devono avere configurato almeno una chiave Smart Tap.

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

string

Codice paese utilizzato per visualizzare il paese della scheda (se l'utente non si trova in quel paese) e per visualizzare i 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% della larghezza.
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 tripletta RGB, ovvero #rgb, ad esempio #fc0.
localizedIssuerName

object (LocalizedString)

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

enum (MultipleDevicesAndHoldersAllowedStatus)

Identifica se più utenti e dispositivi salveranno lo stesso oggetto che fa riferimento a questa classe.
callbackOptions

object (CallbackOptions)

Opzioni di callback da utilizzare per richiamare l'emittente per 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 per il requisito di sblocco del biglietto del trasporto pubblico.
notifyPreference

enum (NotificationSettingsForUpdates)

Indica se gli aggiornamenti dei campi di questa classe devono attivare o meno le notifiche. Se impostato su NOTIFY, tenteremo di attivare una notifica di aggiornamento del campo 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 impostata con ogni richiesta PATCH o UPDATE, altrimenti non verrà attivata una notifica.
valueAddedModuleData[]

object (ValueAddedModuleData)

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

object (MerchantLocation)

Sedi dei commercianti. Il corso può contenere un massimo di dieci studenti. Eventuali altri MerchantLocations aggiunti oltre i 10 verranno rifiutati. Queste località attiveranno una notifica quando un utente entra nel raggio di un punto impostato da Google. Questo campo sostituisce LatLongPoints deprecato.

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 da parte dei partner per un determinato valore attivato 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 trasporto pubblico 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 trasporto pubblico 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 trasporto pubblico a cui fa riferimento l'ID classe specificato.