REST Resource: transitobject

Ressource: TransitObject

Représentation JSON 
{
  "classReference": {
    object (TransitClass)
  },
  "ticketNumber": string,
  "passengerType": enum (PassengerType),
  "passengerNames": string,
  "tripId": string,
  "ticketStatus": enum (TicketStatus),
  "customTicketStatus": {
    object (LocalizedString)
  },
  "concessionCategory": enum (ConcessionCategory),
  "customConcessionCategory": {
    object (LocalizedString)
  },
  "ticketRestrictions": {
    object (TicketRestrictions)
  },
  "purchaseDetails": {
    object (PurchaseDetails)
  },
  "ticketLeg": {
    object (TicketLeg)
  },
  "ticketLegs": [
    {
      object (TicketLeg)
    }
  ],
  "hexBackgroundColor": string,
  "tripType": enum (TripType),
  "id": string,
  "classId": string,
  "version": string,
  "state": enum (State),
  "barcode": {
    object (Barcode)
  },
  "messages": [
    {
      object (Message)
    }
  ],
  "validTimeInterval": {
    object (TimeInterval)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "hasUsers": boolean,
  "smartTapRedemptionValue": string,
  "hasLinkedDevice": boolean,
  "disableExpirationNotification": boolean,
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "appLinkData": {
    object (AppLinkData)
  },
  "activationStatus": {
    object (ActivationStatus)
  },
  "rotatingBarcode": {
    object (RotatingBarcode)
  },
  "deviceContext": {
    object (DeviceContext)
  },
  "heroImage": {
    object (Image)
  },
  "groupingInfo": {
    object (GroupingInfo)
  },
  "passConstraints": {
    object (PassConstraints)
  }
}
Champs
classReference

object (TransitClass)

Copie des champs hérités de la classe parente. Ces champs sont récupérés lors d'une requête GET.
ticketNumber

string

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

enum (PassengerType)

Nombre de passagers.
passengerNames

string

Noms des passagers auxquels le billet est attribué. Le champ passengerType ci-dessus fournit du contexte à Google sur ce champ.
tripId

string

Cet identifiant permet de regrouper les billets si l'utilisateur a enregistré plusieurs billets pour le même trajet.
ticketStatus

enum (TicketStatus)

État de la demande d'assistance. Pour les états qui affectent l'affichage, utilisez plutôt le champ state.
customTicketStatus

object (LocalizedString)

État personnalisé à utiliser pour la valeur de l'état de la demande lorsque ticketStatus n'offre pas l'option appropriée. ticketStatus et customTicketStatus ne peuvent pas être définis.
concessionCategory

enum (ConcessionCategory)

Catégorie de la concession pour le billet.
customConcessionCategory

object (LocalizedString)

Catégorie de service personnalisée à utiliser lorsque concessionCategory ne propose pas la bonne option. concessionCategory et customConcessionCategory ne peuvent pas être définis.
ticketRestrictions

object (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

object (PurchaseDetails)

Détails concernant l'achat de ce billet.
ticketLeg

object (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 places assises. Si plusieurs sections doivent être spécifiées, utilisez plutôt le champ ticketLegs. ticketLeg et ticketLegs ne peuvent pas être définis.
ticketLegs[]

object (TicketLeg)

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 ticketLeg. ticketLeg et ticketLegs ne peuvent pas être définis.
hexBackgroundColor

string

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 #ffcc00. Vous pouvez également utiliser la version abrégée du triplet RVB (#rgb), par exemple #fc0.
tripType

enum (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

string

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

string

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
(deprecated)

string (int64 format)

Obsolète
state

enum (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 inactive est déplacé vers la section "Cartes expirées".
barcode

object (Barcode)

Type et valeur du code-barres.
messages[]

object (Message)

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

object (TimeInterval)

Période pendant laquelle cet objet sera active et pourra être utilisé. L'état d'un objet passe à expired une fois cette période écoulée.
locations[]

object (LatLongPoint)

Remarque: Pour le moment, ce champ ne permet pas de déclencher des notifications géographiques.
hasUsers

boolean

Indique si l'objet a des utilisateurs. Ce champ est défini par la plate-forme.
smartTapRedemptionValue

string

Valeur qui sera transmise à un terminal certifié Smart Tap via NFC pour cet objet. Les champs enableSmartTap et redemptionIssuers au niveau de la classe doivent également être correctement configurés pour que la carte soit compatible avec Smart Tap. Seuls les caractères ASCII sont acceptés.
hasLinkedDevice

boolean

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

boolean

Indique si les notifications doivent être explicitement supprimées. Si ce champ est défini sur "true", quel que soit le champ messages, les notifications d'expiration envoyées à l'utilisateur seront supprimées. Par défaut, ce champ est défini sur "false".

Actuellement, cette option ne peut être définie que pour les offres.
infoModuleData

object (InfoModuleData)

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

object (ImageModuleData)

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[]

object (TextModuleData)

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.
activationStatus

object (ActivationStatus)

État d'activation de l'objet. Obligatoire si activationOptions est défini pour la classe.
rotatingBarcode

object (RotatingBarcode)

Type et valeur du code-barres rotatif.
deviceContext

object (DeviceContext)

Contexte de l'appareil associé à l'objet.
heroImage

object (Image)

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

object (GroupingInfo)

Informations qui contrôlent la façon dont les cartes sont regroupées.
passConstraints

object (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 SINGLE_PASSENGER. Obsolète.
MULTIPLE_PASSENGERS
multiplePassengers

Ancien alias de MULTIPLE_PASSENGERS. Obsolète.

TicketStatus

Enums
TICKET_STATUS_UNSPECIFIED
USED
used

Ancien alias de USED. Obsolète.
REFUNDED
refunded

Ancien alias de REFUNDED. Obsolète.
EXCHANGED
exchanged

Ancien alias de EXCHANGED. Obsolète.

ConcessionCategory

Enums
CONCESSION_CATEGORY_UNSPECIFIED
ADULT
adult

Ancien alias de ADULT. Obsolète.
CHILD
child

Ancien alias de CHILD. Obsolète.
SENIOR
senior

Ancien alias de SENIOR. Obsolète.

TicketRestrictions

Représentation JSON 
{
  "routeRestrictions": {
    object (LocalizedString)
  },
  "routeRestrictionsDetails": {
    object (LocalizedString)
  },
  "timeRestrictions": {
    object (LocalizedString)
  },
  "otherRestrictions": {
    object (LocalizedString)
  }
}
Champs
routeRestrictions

object (LocalizedString)

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

object (LocalizedString)

Plus de détails sur les routeRestrictions ci-dessus.
timeRestrictions

object (LocalizedString)

Restrictions concernant les horaires d'utilisation de ce billet.
otherRestrictions

object (LocalizedString)

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 (TicketCost)
  }
}
Champs
purchaseReceiptNumber

string

Numéro/identifiant du reçu permettant de suivre l'achat du billet via le corps qui l'a vendu.
purchaseDateTime

string

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 :

1985-04-12T23:20:50.52Z correspond à 20 minutes et 50,52 secondes après la 23e heure, le 12 avril 1985, selon le fuseau UTC.

1985-04-12T19:20:50.52-04:00 correspond à 20 minutes et 50,52 secondes après la 19e heure, le 12 avril 1985, 4 heures avant l'UTC (le même instant dans le temps que l'exemple ci-dessus). Si l'événement se trouvait à New York, il s'agirait de l'équivalent de l'heure avancée de l'Est (EDT). N'oubliez pas que le décalage varie en fonction de la période de l'année dans les régions qui appliquent le passage à l'heure d'été.

1985-04-12T19:20:50.52 correspond à 20 minutes et 50,52 secondes après la 19e heure, le 12 avril 1985, sans information de décalage.

Sans informations de décalage, certaines fonctionnalités enrichies risquent de ne pas être disponibles.
accountId

string

Identifiant du compte utilisé pour acheter le billet.
confirmationCode

string

Code de confirmation de l'achat. Il peut être identique pour plusieurs billets différents. Il est utilisé pour regrouper les billets.
ticketCost

object (TicketCost)

Coût du billet.

TicketCost

Représentation JSON 
{
  "faceValue": {
    object (Money)
  },
  "purchasePrice": {
    object (Money)
  },
  "discountMessage": {
    object (LocalizedString)
  }
}
Champs
faceValue

object (Money)

Valeur nominale du billet.
purchasePrice

object (Money)

Prix d'achat réel du billet, après taxes et/ou remises.
discountMessage

object (LocalizedString)

Message décrivant le type de remise appliqué.

TicketLeg

Représentation JSON 
{
  "originStationCode": string,
  "originName": {
    object (LocalizedString)
  },
  "destinationStationCode": string,
  "destinationName": {
    object (LocalizedString)
  },
  "departureDateTime": string,
  "arrivalDateTime": string,
  "fareName": {
    object (LocalizedString)
  },
  "carriage": string,
  "platform": string,
  "zone": string,
  "ticketSeat": {
    object (TicketSeat)
  },
  "ticketSeats": [
    {
      object (TicketSeat)
    }
  ],
  "transitOperatorName": {
    object (LocalizedString)
  },
  "transitTerminusName": {
    object (LocalizedString)
  }
}
Champs
originStationCode

string

Code de la station de départ. Obligatoire si destinationStationCode est présent ou si originName n'est pas présent.
originName

object (LocalizedString)

Nom de la station de départ. Obligatoire si desinationName est présent ou si originStationCode n'est pas présent.
destinationStationCode

string

Code de la station de destination.
destinationName

object (LocalizedString)

Nom de la destination.
departureDateTime

string

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 :

1985-04-12T23:20:50.52Z correspond à 20 minutes et 50,52 secondes après la 23e heure, le 12 avril 1985, selon le fuseau UTC.

1985-04-12T19:20:50.52-04:00 correspond à 20 minutes et 50,52 secondes après la 19e heure, le 12 avril 1985, 4 heures avant l'UTC (le même instant dans le temps que l'exemple ci-dessus). Si l'événement se trouvait à New York, il s'agirait de l'équivalent de l'heure avancée de l'Est (EDT). N'oubliez pas que le décalage varie en fonction de la période de l'année dans les régions qui appliquent le passage à l'heure d'été.

1985-04-12T19:20:50.52 correspond à 20 minutes et 50,52 secondes après la 19e heure, le 12 avril 1985, sans information de décalage.

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 2018-06-05T20:00:00. Si la date/heure locale de la gare de départ est antérieure de quatre heures à l'heure UTC, un décalage de -04:00 peut être ajouté.

Sans informations de décalage, certaines fonctionnalités enrichies risquent de ne pas être disponibles.
arrivalDateTime

string

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 :

1985-04-12T23:20:50.52Z correspond à 20 minutes et 50,52 secondes après la 23e heure, le 12 avril 1985, selon le fuseau UTC.

1985-04-12T19:20:50.52-04:00 correspond à 20 minutes et 50,52 secondes après la 19e heure, le 12 avril 1985, 4 heures avant l'UTC (le même instant dans le temps que l'exemple ci-dessus). Si l'événement se trouvait à New York, il s'agirait de l'équivalent de l'heure avancée de l'Est (EDT). N'oubliez pas que le décalage varie en fonction de la période de l'année dans les régions qui appliquent le passage à l'heure d'été.

1985-04-12T19:20:50.52 correspond à 20 minutes et 50,52 secondes après la 19e heure, le 12 avril 1985, sans information de décalage.

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 2018-06-05T20:00:00. Si la date et l'heure locales de la station de destination sont quatre heures avant l'heure UTC, un décalage de -04:00 peut être ajouté.

Sans informations de décalage, certaines fonctionnalités enrichies risquent de ne pas être disponibles.
fareName

object (LocalizedString)

Brève description/nom du tarif pour cette étape du voyage. (par exemple, "À usage unique à tout moment").
carriage

string

Nom/numéro du train ou du bateau dont le passager doit monter à bord.
platform

string

Quai ou porte où le passager peut monter dans la voiture.
zone

string

Zone d'embarquement au sein du quai.
ticketSeat

object (TicketSeat)

Siège réservé pour le ou les passagers. Si plusieurs places doivent être spécifiées, utilisez plutôt le champ ticketSeats. ticketSeat et ticketSeats ne peuvent pas être définis.
ticketSeats[]

object (TicketSeat)

Siège réservé pour le ou les passagers. Si un seul siège doit être spécifié, utilisez plutôt le champ ticketSeat. ticketSeat et ticketSeats ne peuvent pas être définis.
transitOperatorName

object (LocalizedString)

Nom de l'opérateur de transports en commun qui gère cette section du trajet.
transitTerminusName

object (LocalizedString)

Gare ou destination du train, du bus, etc.

TicketSeat

Représentation JSON 
{
  "fareClass": enum (FareClass),
  "customFareClass": {
    object (LocalizedString)
  },
  "coach": string,
  "seat": string,
  "seatAssignment": {
    object (LocalizedString)
  }
}
Champs
fareClass

enum (FareClass)

Classe tarifaire du siège avec billet.
customFareClass

object (LocalizedString)

Classe tarifaire personnalisée à utiliser si aucune valeur fareClass ne s'applique. fareClass et customFareClass ne peuvent pas être définis.
coach

string

Identifiant du wagon ou de l'autocar dans lequel se trouve le siège acheté. Par exemple : "10"
seat

string

Identifiant de l'emplacement du siège avec billet. Par exemple : "42". En l'absence d'identifiant spécifique, utilisez plutôt seatAssigment.
seatAssignment

object (LocalizedString)

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 seat.

FareClass

Enums
FARE_CLASS_UNSPECIFIED
ECONOMY
economy

Ancien alias de ECONOMY. Obsolète.
FIRST
first

Ancien alias de FIRST. Obsolète.
BUSINESS
business

Ancien alias de BUSINESS. Obsolète.

TripType

Enums
TRIP_TYPE_UNSPECIFIED
ROUND_TRIP
roundTrip

Ancien alias de ROUND_TRIP. Obsolète.
ONE_WAY
oneWay

Ancien alias de ONE_WAY. Obsolète.

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 (State)
}
Champs
state

enum (State)

État

Enums
UNKNOWN_STATE
NOT_ACTIVATED Non activée, il s'agit de l'état par défaut
not_activated

Ancien alias de NOT_ACTIVATED. Obsolète.
ACTIVATED Activation
activated

Ancien alias de ACTIVATED. Obsolète.

DeviceContext

Contexte de l'appareil associé à l'objet.

Représentation JSON 
{
  "deviceToken": string
}
Champs
deviceToken

string

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

addmessage

 Ajoute un message à l'objet de transports en commun référencé par l'ID d'objet donné.

get

 Renvoie l'objet de transports en commun avec l'ID d'objet donné.

insert

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

list

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

patch

 Met à jour l'objet de transports en commun référencé par l'ID d'objet donné.

update

 Met à jour l'objet de transports en commun référencé par l'ID d'objet donné.