- 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 de l'identifiant unique du titre de transport dans le système de l'opérateur de transports en commun. |
passengerType |
le nombre de passagers ; |
passengerNames |
Nom(s) des passagers auxquels le billet est attribué. Le champ |
tripId |
Cet ID permet de regrouper les billets si l'utilisateur a enregistré plusieurs billets pour le même trajet. |
ticketStatus |
État du billet. 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 réduction du billet. |
customConcessionCategory |
Catégorie de concession personnalisée à utiliser lorsque |
ticketRestrictions |
Informations sur les restrictions liées à l'utilisation de ce billet. Par exemple, les jours de la semaine où elle doit être utilisée ou les itinéraires autorisés. |
purchaseDetails |
Détails de l'achat de ce billet. |
ticketLeg |
Un seul segment de billet contient des informations sur le départ et l'arrivée, ainsi que sur l'embarquement et les sièges. Si vous devez spécifier plusieurs segments, utilisez plutôt le champ |
ticketLegs[] |
Chaque billet peut contenir une ou plusieurs sections. Chaque segment contient des informations sur le départ et l'arrivée, ainsi que sur l'embarquement et les sièges. Si vous ne souhaitez spécifier qu'un seul trajet, utilisez plutôt le champ |
hexBackgroundColor |
Couleur d'arrière-plan de la fiche. Si cette couleur d'arrière-plan 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 au format 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 l'adresse 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, où 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, des points, des traits d'union ou des tirets. |
classId |
Obligatoire. Classe associée à cet objet. La classe doit être du même type que cet objet, doit déjà exister et doit être approuvée. Les ID de classe doivent respecter le format issuer ID.identifier, où 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 manière 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 qui lui sont associés. Le nombre maximal de ces champs est de 10. |
validTimeInterval |
Période pendant laquelle cet objet sera |
locations[] |
Remarque: Il n'est actuellement pas possible d'utiliser ce champ pour déclencher des notifications géo. |
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 de niveau de classe |
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, en l'associant à son appareil. Destiné à certains partenaires. Pour en savoir plus, contactez l'assistance. |
disableExpirationNotification |
Indique si les notifications doivent être supprimées explicitement. Si ce champ est défini sur "True", les notifications d'expiration envoyées à l'utilisateur sont supprimées, quel que soit le champ Pour le moment, cette option ne peut être définie que pour les offres. |
infoModuleData |
Obsolète. Utilisez plutôt textModulesData. |
imageModulesData[] |
Données du module d'image. Le nombre maximal de ces champs affichés est de 1 au niveau de l'objet et de 1 au niveau de l'objet de classe. |
textModulesData[] |
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. |
linksModuleData |
Données du module de liens. Si des données de module de liens sont également définies sur le cours, les deux s'affichent. |
appLinkData |
Lien vers une application ou un site Web facultatif qui s'affiche sous forme de bouton sur le recto du pass. Si AppLinkData est fourni pour la classe correspondante, seul l'objet AppLinkData s'affiche. |
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 sur le recto de la fiche. Si aucune image n'est présente, l'image héros de la classe, le cas échéant, s'affiche. Si l'image héros du cours n'est pas non plus présente, rien ne s'affiche. |
groupingInfo |
Information qui gère le regroupement des cartes. |
passConstraints |
Transmettez les contraintes de l'objet. Inclut la limitation des comportements NFC et des captures d'écran. |
saveRestrictions |
Restrictions concernant l'objet qui doivent être validées avant que l'utilisateur ne tente d'enregistrer la carte. Notez que ces restrictions ne s'appliquent qu'aux heures d'enregistrement. Si les restrictions ont changé après qu'un utilisateur a enregistré la carte, les nouvelles restrictions ne s'appliquent pas à une carte déjà enregistrée. |
linkedObjectIds[] |
Les linkedObjectIds sont une liste d'autres objets tels que des billets pour des événements, des cartes de fidélité, des offres, des cartes génériques, des cartes cadeaux, des titres de transport et des cartes d'embarquement qui doivent être automatiquement associés à cet objet de transport en commun. Si un utilisateur a enregistré cette carte de transport en commun, ces linkedObjectIds sont automatiquement transmis à son portefeuille (sauf s'il a désactivé le paramètre permettant de recevoir ces cartes associées). Assurez-vous que les objets présents dans linkedObjectIds sont déjà insérés. Sinon, les appels échoueront. Une fois associés, les objets ne peuvent plus être dissociés. Vous ne pouvez pas associer d'objets appartenant à un autre émetteur. Le nombre d'objets pouvant être associés à un même objet est limité. Une fois la limite atteinte, les nouveaux objets associés de l'appel sont ignorés sans notification. Les ID d'objet doivent respecter le format issuer ID.identifier, où le premier est émis par Google et le second est choisi par vous. |
notifyPreference |
Indique si les mises à jour de champ de cet objet doivent déclencher des notifications. Si la valeur est NOTIFY, nous tenterons de déclencher une notification de mise à jour de champ auprès des utilisateurs. Ces notifications ne sont envoyées aux utilisateurs que si le champ figure sur 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[] |
Données du module avec valeur ajoutée facultative. Dix au maximum sur l'objet. |
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 possibles. Il peut s'agir, par exemple, de la chaîne "Trains CrossCountry réservés uniquement". |
routeRestrictionsDetails |
Plus d'informations sur le |
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 l'organisme qui l'a vendu. |
purchaseDateTime |
Date/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 avancées peuvent ne pas être disponibles. |
accountId |
ID du compte utilisé pour acheter le billet. |
confirmationCode |
Code de confirmation de l'achat. Il peut s'agir de la même valeur pour plusieurs demandes différentes. Il permet de regrouper les demandes. |
ticketCost |
Coût du billet. |
TicketCost
Représentation JSON |
---|
{ "faceValue": { object ( |
Champs | |
---|---|
faceValue |
Valeur faciale du billet. |
purchasePrice |
Prix d'achat réel du billet, après taxes et/ou remises. |
discountMessage |
Message décrivant tout type de remise appliquée. |
TicketLeg
Représentation JSON |
---|
{ "originStationCode": string, "originName": { object ( |
Champs | |
---|---|
originStationCode |
Code de la station de départ. Cet attribut est obligatoire si |
originName |
Nom de la station de départ. Cet attribut est obligatoire si |
destinationStationCode |
Code de la station de destination. |
destinationName |
Nom de la destination. |
departureDateTime |
Date/Heure de départ Ce paramètre est obligatoire si aucun intervalle de validité n'est défini sur l'objet de transport 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/heure locale de la gare de départ. Par exemple, si le départ a lieu à 20h00 le 5 juin 2018 à la gare de départ, la partie date/heure locale doit être Sans informations de décalage, certaines fonctionnalités avancées peuvent ne pas être disponibles. |
arrivalDateTime |
Date/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/heure locale de la borne de destination. Par exemple, si l'événement se produit à 20h le 5 juin 2018 à la gare de destination, la partie date/heure locale doit être Sans informations de décalage, certaines fonctionnalités avancées peuvent ne pas être disponibles. |
fareName |
Brève description/nom du tarif pour cet itinéraire. (par exemple, "Utilisation unique à tout moment"). |
carriage |
Nom/numéro du train ou du bateau que le passager doit prendre. |
platform |
Plate-forme ou porte où le passager peut monter dans la voiture. |
zone |
Zone d'embarquement sur la plate-forme. |
ticketSeat |
Siège réservé pour le ou les passagers. Si vous devez spécifier plusieurs sièges, utilisez plutôt le champ |
ticketSeats[] |
Siège réservé pour le ou les passagers. Si vous ne souhaitez spécifier qu'un seul siège, utilisez plutôt le champ |
transitOperatorName |
Nom de l'opérateur de transports en commun qui gère cette partie du trajet. |
transitTerminusName |
Gare terminus ou destination du train/bus/etc. |
TicketSeat
Représentation JSON |
---|
{ "fareClass": enum ( |
Champs | |
---|---|
fareClass |
Classe tarifaire du siège pour lequel le billet a été émis. |
customFareClass |
Classe tarifaire personnalisée à utiliser si aucun |
coach |
Identifiant du wagon dans lequel se trouve le siège du billet. par exemple, "10" |
seat |
Identifiant de l'emplacement du siège pour lequel le billet a été émis. par exemple, "42". Si aucun identifiant spécifique n'est défini, utilisez plutôt |
seatAssignment |
Siège attribué au passager. par exemple, "Aucun siège spécifique". À utiliser lorsqu'aucun identifiant spécifique n'est à 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 si la valeur est compatible avec l'activation.
Représentation JSON |
---|
{
"state": enum ( |
Champs | |
---|---|
state |
|
État
Enums | |
---|---|
UNKNOWN_STATE |
|
NOT_ACTIVATED |
"Non activé" (é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é. Cette chaîne ne doit pas être utilisée comme identifiant stable pour suivre l'appareil d'un utilisateur. Elle peut varier pour les différents billets d'un même appareil, voire pour différentes activations sur un même appareil. Lorsque le champ est défini, les appelants doivent également définir hasLinkedDevice sur l'objet qui est 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 associé à l'ID d'objet donné. |
|
Insère un objet de transports en commun avec l'ID et les propriétés donnés. |
|
Renvoie la liste de tous les objets de transport 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é. |