REST Resource: transitclass

Ressource: TransitClass

Représentation 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)
    }
  ]
}
Champs
transitOperatorName

object (LocalizedString)

Nom de l'opérateur de transports en commun.
transitType

enum (TransitType)

Obligatoire. Type de transport représenté par cette classe (par exemple, "bus").
watermark

object (Image)

Image du filigrane à afficher sur l'appareil de l'utilisateur.
languageOverride

string

Si ce champ est présent, les billets de transport en commun diffusés sur l'appareil d'un utilisateur seront toujours dans cette langue. Représente l'étiquette de langue BCP 47. Exemples de valeurs : "en-US", "en-GB", "de" ou "de-AT".
customTransitTerminusNameLabel

object (LocalizedString)

Étiquette personnalisée à utiliser pour la valeur du nom du terminus de la ligne de transports en commun (transitObject.ticketLeg.transitTerminusName).
customTicketNumberLabel

object (LocalizedString)

Libellé personnalisé à utiliser pour la valeur du numéro de demande (transitObject.ticketNumber).
customRouteRestrictionsLabel

object (LocalizedString)

Étiquette personnalisée à utiliser pour la valeur des restrictions de routage (transitObject.ticketRestrictions.routeRestrictions).
customRouteRestrictionsDetailsLabel

object (LocalizedString)

Libellé personnalisé à utiliser pour la valeur des détails des restrictions d'itinéraire (transitObject.ticketRestrictions.routeRestrictionsDetails).
customTimeRestrictionsLabel

object (LocalizedString)

Étiquette personnalisée à utiliser pour la valeur des détails des restrictions de temps (transitObject.ticketRestrictions.timeRestrictions).
customOtherRestrictionsLabel

object (LocalizedString)

Libellé personnalisé à utiliser pour la valeur "other restrictions" (transitObject.ticketRestrictions.otherRestrictions).
customPurchaseReceiptNumberLabel

object (LocalizedString)

Libellé personnalisé à utiliser pour la valeur du numéro du reçu d'achat (transitObject.purchaseDetails.purchaseReceiptNumber).
customConfirmationCodeLabel

object (LocalizedString)

Libellé personnalisé à utiliser pour la valeur du code de confirmation (transitObject.purchaseDetails.confirmationCode).
customPurchaseFaceValueLabel

object (LocalizedString)

Étiquette personnalisée à utiliser pour la valeur nominale de l'achat (transitObject.purchaseDetails.ticketCost.faceValue).
customPurchasePriceLabel

object (LocalizedString)

Étiquette personnalisée à utiliser pour la valeur du prix d'achat (transitObject.purchaseDetails.ticketCost.purchasePrice).
customDiscountMessageLabel

object (LocalizedString)

Étiquette personnalisée à utiliser pour la valeur du message de remise sur les transports en commun (transitObject.purchaseDetails.ticketCost.discountMessage).
customCarriageLabel

object (LocalizedString)

Étiquette personnalisée à utiliser pour la valeur chariot (transitObject.ticketLeg.carriage).
customSeatLabel

object (LocalizedString)

Étiquette personnalisée à utiliser pour la valeur de l'emplacement du siège (transitObject.ticketLeg.ticketSeat.seat).
customCoachLabel

object (LocalizedString)

Étiquette personnalisée à utiliser pour la valeur de l'assistant (transitObject.ticketLeg.ticketSeat.coach).
customPlatformLabel

object (LocalizedString)

Étiquette personnalisée à utiliser pour la valeur de la plate-forme d'embarquement (transitObject.ticketLeg.platform).
customZoneLabel

object (LocalizedString)

Libellé personnalisé à utiliser pour la valeur de la zone d'embarquement (transitObject.ticketLeg.zone).
customFareClassLabel

object (LocalizedString)

Étiquette personnalisée à utiliser pour la valeur de la classe tarifaire (transitObject.ticketLeg.ticketSeat.fareClass).
customConcessionCategoryLabel

object (LocalizedString)

Libellé personnalisé à utiliser pour la valeur de la catégorie de concession de transports en commun (transitObject.concessionCategory).
customFareNameLabel

object (LocalizedString)

Libellé personnalisé à utiliser pour la valeur du nom du tarif de transport en commun (transitObject.ticketLeg.fareName).
classTemplateInfo

object (ClassTemplateInfo)

Informations de modèle sur la manière dont la classe doit s'afficher. Si cette règle n'est pas configurée, Google utilise un ensemble de champs par défaut à afficher.
enableSingleLegItinerary

boolean

Contrôle l'affichage de l'itinéraire direct pour cette classe. Par défaut, un itinéraire ne s'affiche que pour les trajets avec plusieurs étapes.
id

string

Obligatoire. Identifiant unique d'un cours. Cet ID doit être unique dans toutes les classes d'un émetteur. Cette valeur doit respecter le format issuer ID.identifier, où le premier est émis par Google et le second est choisi par vous. Votre identifiant unique ne doit contenir que des caractères alphanumériques, des points, des traits de soulignement ou des tirets.
version
(deprecated)

string (int64 format)

Obsolète
issuerName

string

Obligatoire. Nom de l'émetteur. La longueur maximale recommandée est de 20 caractères, afin de garantir que la chaîne s'affiche entièrement sur des écrans de petite taille.
messages[]

object (Message)

Tableau de messages affichés dans l'application. Tous les utilisateurs de cet objet recevront les messages qui lui sont associés. Le nombre maximal de ces champs est de 10.
allowMultipleUsersPerObject
(deprecated)

boolean

Obsolète. Utilisez multipleDevicesAndHoldersAllowedStatus à la place.
homepageUri

object (Uri)

URI de la page d'accueil de votre application. Renseigner l'URI dans ce champ entraîne exactement le même comportement que de renseigner un URI dans linksModuleData (lorsqu'un objet est affiché, un lien vers la page d'accueil s'affiche dans ce qui est généralement considéré comme la section linksModuleData de l'objet).
locations[]
(deprecated)

object (LatLongPoint)

Remarque: Actuellement, ce champ ne permet pas de déclencher des notifications géographiques.
reviewStatus

enum (ReviewStatus)

Obligatoire. État de la classe. Ce champ peut être défini sur draft ou underReview à l'aide des appels d'API insert, patch ou update. Une fois que l'état de l'examen est passé de draft, vous ne pouvez plus le repasser à l'état draft.

Ce champ doit rester défini sur draft lorsque la classe est en cours de développement. Une classe draft ne peut pas être utilisée pour créer un objet.

Vous devez définir ce champ sur underReview lorsque vous pensez que la classe est prête à être utilisée. La plate-forme définira automatiquement ce champ sur approved, et vous pourrez immédiatement l'utiliser pour créer ou migrer des objets.

Lorsque vous mettez à jour une classe déjà approved, vous devez continuer à définir ce champ sur underReview.
review

object (Review)

Commentaires d'évaluation définis par la plate-forme lorsqu'un cours est marqué approved ou rejected.
infoModuleData
(deprecated)

object (InfoModuleData)

Obsolète. Utilisez plutôt textModulesData.
imageModulesData[]

object (ImageModuleData)

Données du module d'image. Le nombre maximal de ces champs affichés est 1 pour le niveau objet et 1 pour le niveau d'objet de classe.
textModulesData[]

object (TextModuleData)

Données du module de texte. Si des données de module de texte sont également définies sur le cours, les deux sont affichées. Le nombre maximal de ces champs affichés est de 10 pour l'objet et de 10 pour la classe.
redemptionIssuers[]

string (int64 format)

Identifie les émetteurs d'offres qui peuvent utiliser la carte via Smart Tap. Les émetteurs d'offres sont identifiés par leur ID. Les émetteurs d'offres doivent avoir configuré au moins une clé Smart Tap.

Les champs enableSmartTap et smartTapRedemptionLevel au niveau de l'objet doivent également être configurés correctement pour qu'une carte soit compatible avec le sans contact avancé.
countryCode

string

Code pays utilisé pour afficher le pays de la fiche (lorsque l'utilisateur ne se trouve pas dans ce pays), ainsi que pour afficher du contenu localisé lorsque celui-ci n'est pas disponible dans la langue de l'utilisateur.
heroImage

object (Image)

Image de bannière facultative affichée sur le recto de la fiche. Si aucun n'est présent, rien ne s'affiche. L'image s'affichera sur 100 % de la largeur.
wordMark
(deprecated)

object (Image)

Obsolète.
enableSmartTap

boolean

Indique si cette classe est compatible avec le Sans contact avancé. Les champs redemptionIssuers et smartTapRedemptionLevel au niveau de l'objet doivent également être configurés correctement pour qu'une carte soit compatible avec le sans contact avancé.
hexBackgroundColor

string

Couleur d'arrière-plan de la fiche. Si cette option n'est pas définie, la couleur dominante de l'image héros est utilisée. Si aucune image héros n'est définie, la couleur dominante du logo est utilisée. Le format est #rrggbb, où rrggbb est un triplet RVB hexadécimal, comme #ffcc00. Vous pouvez également utiliser la version abrégée du triplet RVB (#rgb), telle que #fc0.
localizedIssuerName

object (LocalizedString)

Chaînes traduites pour issuerName. La longueur maximale recommandée est de 20 caractères, afin de garantir que la chaîne s'affiche entièrement sur des écrans de petite taille.
multipleDevicesAndHoldersAllowedStatus

enum (MultipleDevicesAndHoldersAllowedStatus)

Indique si plusieurs utilisateurs et appareils enregistreront le même objet référençant cette classe.
callbackOptions

object (CallbackOptions)

Options de rappel à utiliser pour rappeler l'émetteur à chaque enregistrement/suppression d'un objet de cette classe par l'utilisateur final. Tous les objets de cette classe sont éligibles au rappel.
securityAnimation

object (SecurityAnimation)

Informations facultatives sur l'animation de sécurité. Si cette option est définie, une animation de sécurité s'affiche sur les informations de la carte.
activationOptions

object (ActivationOptions)

Options d'activation d'un titre de transport activable.
viewUnlockRequirement

enum (ViewUnlockRequirement)

Affichez les exigences de déverrouillage pour le titre de transport.
notifyPreference

enum (NotificationSettingsForUpdates)

Indique si les mises à jour de champ de cette classe doivent déclencher des notifications. Si cet indicateur est défini sur NOTIFY, nous essayons de déclencher une notification de mise à jour des champs pour les utilisateurs. Ces notifications ne seront envoyées aux utilisateurs que si le champ fait partie d'une liste d'autorisation. Si la valeur est DO_NOT_NOTIFY ou NOTIFICATION_SETTINGS_UNSPECIFIED, aucune notification ne sera déclenchée. Ce paramètre est éphémère et doit être défini avec chaque requête PATCH ou UPDATE. Sinon, aucune notification ne sera déclenchée.
valueAddedModuleData[]

object (ValueAddedModuleData)

Données facultatives du module à valeur ajoutée. Maximum de 10 pour le cours. Pour une carte, seuls dix s'affichent, en priorité pour ceux de l'objet.

TransitType

Enums
TRANSIT_TYPE_UNSPECIFIED
BUS
bus

Ancien alias de BUS. Obsolète.
RAIL
rail

Ancien alias pour RAIL. Obsolète.
TRAM
tram

Ancien alias de TRAM. Obsolète.
FERRY
ferry

Ancien alias de FERRY. Obsolète.
OTHER
other

Ancien alias pour OTHER. Obsolète.

ActivationOptions

ActivationOptions du cours

Représentation JSON 
{
  "activationUrl": string,
  "allowReactivation": boolean
}
Champs
activationUrl

string

URL HTTPS compatible avec la sémantique REST. Serait utilisée pour demander l'activation des partenaires pour une valeur donnée, déclenchée par les utilisateurs.
allowReactivation

boolean

Indicateur pour autoriser les utilisateurs à passer un appel d'activation à partir d'un autre appareil. Cela permet au client d'activer le bouton d'activation même si activationStatus est ACTIVATED, mais que l'appareil demandé est différent de l'appareil actuel.

Méthodes

addmessage

 Ajoute un message à la classe de transports en commun référencée par l'ID de classe donné.

get

 Renvoie la classe de transports en commun associée à l'ID de classe donné.

insert

 Insère une classe de transports en commun avec l'identifiant et les propriétés indiqués.

list

 Renvoie la liste de toutes les classes de transports en commun pour un ID d'émetteur donné.

patch

 Met à jour la classe de transports en commun référencée par l'ID de classe donné.

update

 Met à jour la classe de transports en commun référencée par l'ID de classe donné.