- Ressource: TransitObject
- PassengerType
- TicketStatus
- ConcessionCategory
- TicketRestrictions
- PurchaseDetails
- TicketCost
- TicketLeg
- TicketSeat
- FareClass
- TripType
- ActivationStatus
- État
- DeviceContext
- Méthodes
Ressource: TransitObject
Représentation JSON |
---|
{ "classReference": { object ( |
Champs | |
---|---|
classReference |
Copie des champs hérités de la classe parente. Ces champs sont récupérés lors d'une requête GET. |
ticketNumber |
Numéro du billet. Il s'agit d'un identifiant unique associé au titre de transport dans le système de l'opérateur de transports en commun. |
passengerType |
Nombre de passagers. |
passengerNames |
Noms des passagers auxquels le billet est attribué. Le champ |
tripId |
Cet identifiant permet de regrouper les billets si l'utilisateur a enregistré plusieurs billets pour le même trajet. |
ticketStatus |
État de la demande d'assistance. Pour les états qui affectent l'affichage, utilisez plutôt le champ |
customTicketStatus |
État personnalisé à utiliser pour la valeur de l'état de la demande lorsque |
concessionCategory |
Catégorie de la concession pour le billet. |
customConcessionCategory |
Catégorie de service personnalisée à utiliser lorsque |
ticketRestrictions |
Informations sur les types de restrictions appliquées à l'utilisation de ce titre de transport. Par exemple, les jours de la semaine où il doit être emprunté ou les itinéraires qu'il est possible d'emprunter. |
purchaseDetails |
Détails concernant l'achat de ce billet. |
ticketLeg |
Un tronçon de ticket unique contient des informations sur les départs et les arrivées, ainsi que sur l'embarquement et les sièges. Si plusieurs sections doivent être spécifiées, utilisez plutôt le champ |
ticketLegs[] |
Chaque billet peut contenir une ou plusieurs étapes. Chaque section contient des informations sur le départ et l'arrivée, ainsi que sur l'embarquement et les sièges. Si une seule section doit être spécifiée, utilisez plutôt le champ |
hexBackgroundColor |
Couleur d'arrière-plan de la carte. Si cette couleur n'est pas définie, la couleur dominante de l'image héros est utilisée. En l'absence d'image héros, la couleur dominante du logo est utilisée. Le format est #rrggbb, où rrggbb est un triplet RVB hexadécimal, tel que |
tripType |
Obligatoire. Type de trajet représenté par cet objet Transport. Permet de déterminer le titre de la carte et/ou le symbole à utiliser entre le point de départ et la destination. |
id |
Obligatoire. Identifiant unique d'un objet. Cet ID doit être unique parmi tous les objets d'un émetteur. Cette valeur doit respecter le format issuer ID.identifier, lorsque le premier est émis par Google et le second est choisi par vous. L'identifiant unique ne doit contenir que des caractères alphanumériques, ainsi que les caractères ".", "_" ou "-". |
classId |
Obligatoire. Classe associée à cet objet. La classe doit être du même type que cet objet, doit déjà exister et être approuvée. Les ID de classe doivent respecter le format issuer ID.identifier, lorsque le premier est émis par Google et le second est choisi par vous. |
version |
Obsolète |
state |
Obligatoire. État de l'objet. Ce champ permet de déterminer la façon dont un objet s'affiche dans l'application. Par exemple, un objet |
barcode |
Type et valeur du code-barres. |
messages[] |
Tableau de messages affichés dans l'application. Tous les utilisateurs de cet objet recevront les messages associés. Le nombre maximal de ces champs est 10. |
validTimeInterval |
Période pendant laquelle cet objet sera |
locations[] |
Remarque: Pour le moment, ce champ ne permet pas de déclencher des notifications géographiques. |
hasUsers |
Indique si l'objet a des utilisateurs. Ce champ est défini par la plate-forme. |
smartTapRedemptionValue |
Valeur qui sera transmise à un terminal certifié Smart Tap via NFC pour cet objet. Les champs |
hasLinkedDevice |
Indique si cet objet est actuellement associé à un seul appareil. Ce champ est défini par la plate-forme lorsqu'un utilisateur enregistre l'objet pour l'associer à son appareil. Destiné à certains partenaires. Pour plus d'informations, contactez l'assistance. |
disableExpirationNotification |
Indique si les notifications doivent être explicitement supprimées. Si ce champ est défini sur "true", quel que soit le champ Actuellement, cette option ne peut être définie que pour les offres. |
infoModuleData |
Obsolète. Utilisez plutôt textModulesData. |
imageModulesData[] |
Données de module d'image. Le nombre maximal de champs affichés pour l'objet de classe est limité à un pour le niveau de l'objet et un au niveau de l'objet de classe. |
textModulesData[] |
Données des modules de texte. Si des données de module de texte sont également définies sur la classe, les deux seront affichées. Le nombre maximal de ces champs affichés est de 10 pour l'objet et 10 pour la classe. |
linksModuleData |
Données du module de liens. Si les données du module de liens sont également définies dans la classe, les deux seront affichées. |
appLinkData |
Lien facultatif vers l'application ou le site Web qui s'affiche sous la forme d'un bouton sur le devant de la carte. Si AppLinkData est fourni pour la classe correspondante, seul l'objet AppLinkData sera affiché. |
activationStatus |
État d'activation de l'objet. Obligatoire si |
rotatingBarcode |
Type et valeur du code-barres rotatif. |
deviceContext |
Contexte de l'appareil associé à l'objet. |
heroImage |
Image de bannière facultative affichée au recto de la fiche. Si aucun n'est présent, l'image héros du cours s'affiche, le cas échéant. Si l'image héros de la classe n'est pas non plus présente, rien ne s'affichera. |
groupingInfo |
Informations qui contrôlent la façon dont les cartes sont regroupées. |
passConstraints |
Transmettez des contraintes pour l'objet. Cela inclut la limitation des comportements liés à la technologie NFC et aux captures d'écran. |
PassengerType
Enums | |
---|---|
PASSENGER_TYPE_UNSPECIFIED |
|
SINGLE_PASSENGER |
|
singlePassenger |
Ancien alias de |
MULTIPLE_PASSENGERS |
|
multiplePassengers |
Ancien alias de |
TicketStatus
Enums | |
---|---|
TICKET_STATUS_UNSPECIFIED |
|
USED |
|
used |
Ancien alias de |
REFUNDED |
|
refunded |
Ancien alias de |
EXCHANGED |
|
exchanged |
Ancien alias de |
ConcessionCategory
Enums | |
---|---|
CONCESSION_CATEGORY_UNSPECIFIED |
|
ADULT |
|
adult |
Ancien alias de |
CHILD |
|
child |
Ancien alias de |
SENIOR |
|
senior |
Ancien alias de |
TicketRestrictions
Représentation JSON |
---|
{ "routeRestrictions": { object ( |
Champs | |
---|---|
routeRestrictions |
Restrictions concernant les itinéraires pouvant être empruntés. Par exemple, il peut s'agir de la chaîne "Trains de fond réservés uniquement". |
routeRestrictionsDetails |
Plus de détails sur les |
timeRestrictions |
Restrictions concernant les horaires d'utilisation de ce billet. |
otherRestrictions |
Restrictions supplémentaires qui ne relèvent pas des catégories "itinéraire" ou "heure". |
PurchaseDetails
Représentation JSON |
---|
{
"purchaseReceiptNumber": string,
"purchaseDateTime": string,
"accountId": string,
"confirmationCode": string,
"ticketCost": {
object ( |
Champs | |
---|---|
purchaseReceiptNumber |
Numéro/identifiant du reçu permettant de suivre l'achat du billet via le corps qui l'a vendu. |
purchaseDateTime |
Date et heure d'achat du billet. Il s'agit d'une date/heure exprimée dans le format étendu de la norme ISO 8601, avec ou sans décalage. L'heure peut être indiquée à la nanoseconde près. Les décalages peuvent être indiqués à la seconde près (même si le décalage des secondes n'est pas prévu par la norme ISO 8601). Exemple :
Sans informations de décalage, certaines fonctionnalités enrichies risquent de ne pas être disponibles. |
accountId |
Identifiant du compte utilisé pour acheter le billet. |
confirmationCode |
Code de confirmation de l'achat. Il peut être identique pour plusieurs billets différents. Il est utilisé pour regrouper les billets. |
ticketCost |
Coût du billet. |
TicketCost
Représentation JSON |
---|
{ "faceValue": { object ( |
Champs | |
---|---|
faceValue |
Valeur nominale du billet. |
purchasePrice |
Prix d'achat réel du billet, après taxes et/ou remises. |
discountMessage |
Message décrivant le type de remise appliqué. |
TicketLeg
Représentation JSON |
---|
{ "originStationCode": string, "originName": { object ( |
Champs | |
---|---|
originStationCode |
Code de la station de départ. Obligatoire si |
originName |
Nom de la station de départ. Obligatoire si |
destinationStationCode |
Code de la station de destination. |
destinationName |
Nom de la destination. |
departureDateTime |
Date et heure de départ. Cet attribut est obligatoire si aucun intervalle de temps de validité n'est défini pour l'objet "Transports en commun". Il s'agit d'une date/heure exprimée dans le format étendu de la norme ISO 8601, avec ou sans décalage. L'heure peut être indiquée à la nanoseconde près. Les décalages peuvent être indiqués à la seconde près (même si le décalage des secondes n'est pas prévu par la norme ISO 8601). Exemple :
La partie de la date/heure sans le décalage est considérée comme la "date/heure locale". Il doit s'agir de la date et de l'heure locales de la gare de départ. Par exemple, si le départ a lieu à la 20e heure le 5 juin 2018 à la gare de départ, la partie date/heure locale doit être Sans informations de décalage, certaines fonctionnalités enrichies risquent de ne pas être disponibles. |
arrivalDateTime |
Date et heure d'arrivée. Il s'agit d'une date/heure exprimée dans le format étendu de la norme ISO 8601, avec ou sans décalage. L'heure peut être indiquée à la nanoseconde près. Les décalages peuvent être indiqués à la seconde près (même si le décalage des secondes n'est pas prévu par la norme ISO 8601). Exemple :
La partie de la date/heure sans le décalage est considérée comme la "date/heure locale". Il doit s'agir de la date et de l'heure locales de la station de destination. Par exemple, si l'événement se produit à la 20e heure le 5 juin 2018 à la station de destination, la partie date/heure locale doit être Sans informations de décalage, certaines fonctionnalités enrichies risquent de ne pas être disponibles. |
fareName |
Brève description/nom du tarif pour cette étape du voyage. (par exemple, "À usage unique à tout moment"). |
carriage |
Nom/numéro du train ou du bateau dont le passager doit monter à bord. |
platform |
Quai ou porte où le passager peut monter dans la voiture. |
zone |
Zone d'embarquement au sein du quai. |
ticketSeat |
Siège réservé pour le ou les passagers. Si plusieurs places doivent être spécifiées, utilisez plutôt le champ |
ticketSeats[] |
Siège réservé pour le ou les passagers. Si un seul siège doit être spécifié, utilisez plutôt le champ |
transitOperatorName |
Nom de l'opérateur de transports en commun qui gère cette section du trajet. |
transitTerminusName |
Gare ou destination du train, du bus, etc. |
TicketSeat
Représentation JSON |
---|
{ "fareClass": enum ( |
Champs | |
---|---|
fareClass |
Classe tarifaire du siège avec billet. |
customFareClass |
Classe tarifaire personnalisée à utiliser si aucune valeur |
coach |
Identifiant du wagon ou de l'autocar dans lequel se trouve le siège acheté. Par exemple : "10" |
seat |
Identifiant de l'emplacement du siège avec billet. Par exemple : "42". En l'absence d'identifiant spécifique, utilisez plutôt |
seatAssignment |
Attribution du siège du passager. Par exemple : "pas de siège spécifique". À utiliser lorsqu'il n'y a pas d'identifiant spécifique à utiliser dans |
FareClass
Enums | |
---|---|
FARE_CLASS_UNSPECIFIED |
|
ECONOMY |
|
economy |
Ancien alias de |
FIRST |
|
first |
Ancien alias de |
BUSINESS |
|
business |
Ancien alias de |
TripType
Enums | |
---|---|
TRIP_TYPE_UNSPECIFIED |
|
ROUND_TRIP |
|
roundTrip |
Ancien alias de |
ONE_WAY |
|
oneWay |
Ancien alias de |
ActivationStatus
État d'activation de l'objet. Ce champ inclut l'état d'activation s'il est pertinent pour l'activation.
Représentation JSON |
---|
{
"state": enum ( |
Champs | |
---|---|
state |
|
État
Enums | |
---|---|
UNKNOWN_STATE |
|
NOT_ACTIVATED |
Non activée, il s'agit de l'état par défaut |
not_activated |
Ancien alias de |
ACTIVATED |
Activation |
activated |
Ancien alias de |
DeviceContext
Contexte de l'appareil associé à l'objet.
Représentation JSON |
---|
{ "deviceToken": string } |
Champs | |
---|---|
deviceToken |
Si ce champ est défini, les informations d'utilisation ne sont renvoyées qu'à l'appareil en question une fois l'objet activé. Il ne doit pas être utilisé comme identifiant stable pour suivre l'appareil d'un utilisateur. Elle peut varier d'une carte à l'autre d'un même appareil, voire lors des différentes activations d'un même appareil. Lorsque ce paramètre est défini, les appelants doivent également définir hasLinkedDevice sur l'objet en cours d'activation. |
Méthodes |
|
---|---|
|
Ajoute un message à l'objet de transports en commun référencé par l'ID d'objet donné. |
|
Renvoie l'objet de transports en commun avec l'ID d'objet donné. |
|
Insère un objet de transports en commun avec l'identifiant et les propriétés indiqués. |
|
Renvoie la liste de tous les objets de transports en commun pour un ID d'émetteur donné. |
|
Met à jour l'objet de transports en commun référencé par l'ID d'objet donné. |
|
Met à jour l'objet de transports en commun référencé par l'ID d'objet donné. |