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)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  },
  "linkedObjectIds": [
    string
  ],
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
Champs
classReference

object (TransitClass)

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

string

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

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 du billet. Pour les états qui affectent l'affichage, utilisez plutôt le champ state.
customTicketStatus

object (LocalizedString)

État personnalisé à utiliser pour la valeur d'état de la demande lorsque ticketStatus ne propose pas l'option appropriée. ticketStatus et customTicketStatus ne doivent pas être définis en même temps.
concessionCategory

enum (ConcessionCategory)

Catégorie de réduction du billet.
customConcessionCategory

object (LocalizedString)

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

object (TicketRestrictions)

Informations sur le type de restrictions d'utilisation de ce titre de transport. Par exemple, les jours de la semaine où elle doit être utilisée ou les itinéraires autorisés.
purchaseDetails

object (PurchaseDetails)

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

object (TicketLeg)

Une section de billet unique contient des informations sur les départs et les arrivées, ainsi que des informations sur l'embarquement et les places. Si vous devez spécifier plusieurs segments, utilisez plutôt le champ ticketLegs. ticketLeg et ticketLegs ne doivent pas être définis en même temps.
ticketLegs[]

object (TicketLeg)

Chaque billet peut comporter 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 une seule section doit être spécifiée, utilisez plutôt le champ ticketLeg. ticketLeg et ticketLegs ne doivent pas être définis en même temps.
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 au format hexadécimal, tel que #ffcc00. Vous pouvez également utiliser la version abrégée du triplet RVB (#rgb), telle que #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 l'adresse 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, où le premier est émis par Google et le deuxième est choisi par vous. L'identifiant unique ne doit contenir que des caractères alphanumériques, ainsi que des symboles ".", "_" 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 doit être approuvée.

Les ID de classe doivent respecter le format issuer ID.identifier, où le premier est émis par Google et le deuxième 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 manière dont un objet s'affiche dans l'application. Par exemple, un objet inactive est déplacé dans 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 qui lui sont associés. Le nombre maximal de ces champs est de 10.
validTimeInterval

object (TimeInterval)

Période pendant laquelle cet objet sera active. L'objet peut être utilisé. L'état d'un objet passera à expired une fois cette période écoulée.
locations[]
(deprecated)

object (LatLongPoint)

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

boolean

Indique si l'objet comporte 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, en l'associant à son appareil. Destiné à certains partenaires. Pour en savoir plus, contactez l'assistance.
disableExpirationNotification

boolean

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 messages. Par défaut, ce champ est défini sur "false".

Pour le moment, 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 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[]

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.
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 qui s'affiche au recto de la carte. Si aucune n'est présente, l'image héros de la classe, le cas échéant, sera affichée. Si l'image héros du cours n'est pas non plus présente, rien ne s'affiche.
groupingInfo

object (GroupingInfo)

Informations qui contrôlent la manière dont les cartes sont regroupées.
passConstraints

object (PassConstraints)

Transmettez des contraintes pour l'objet. y compris la limitation du NFC et les comportements des captures d'écran.
saveRestrictions

object (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'au moment de l'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[]

string

Les objets linkedObjectIds sont une liste d'autres objets (billet pour un événement, carte de fidélité, offre, générique, carte cadeau, carte de transport et carte d'embarquement, par exemple) qui doivent être automatiquement associés à cet objet Transports en commun. Si un utilisateur a enregistré cette carte de transport en commun, ces linkedObjectIds sont automatiquement transférés vers son portefeuille (sauf s'il a désactivé le paramètre permettant de recevoir ces cartes associées).

Vérifiez que les objets présents dans linkedObjectIds sont déjà insérés. Dans le cas contraire, 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 seul objet est limité. Une fois la limite atteinte, les nouveaux objets associés dans l'appel sont ignorés sans notification.

Les ID des objets doivent respecter le format issuer ID.identifier, où le premier est émis par Google et le second est choisi par vous.
notifyPreference

enum (NotificationSettingsForUpdates)

Indique si les mises à jour des champs de cet objet doivent déclencher ou non 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 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 du module avec valeur ajoutée facultative. 10 maximum sur l'objet.

PassengerType

Enums
PASSENGER_TYPE_UNSPECIFIED
SINGLE_PASSENGER
singlePassenger

Ancien alias pour SINGLE_PASSENGER. Obsolète.
MULTIPLE_PASSENGERS
multiplePassengers

Ancien alias pour MULTIPLE_PASSENGERS. Obsolète.

TicketStatus

Enums
TICKET_STATUS_UNSPECIFIED
USED
used

Ancien alias pour 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 pour 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 possibles. Il peut s'agir, par exemple, de la chaîne "Trains CrossCountry réservés uniquement".
routeRestrictionsDetails

object (LocalizedString)

En savoir plus sur les routeRestrictions ci-dessus.
timeRestrictions

object (LocalizedString)

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

object (LocalizedString)

Restrictions supplémentaires qui n'appartiennent pas aux 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 l'organisme qui l'a vendu.
purchaseDateTime

string

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 spécifiée à la nanoseconde près. Les décalages peuvent être spécifiés avec une précision en secondes (même si les secondes décalées ne font pas partie de 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 déroulait à New York, cela correspondrait à 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 informations de décalage.

Sans informations de décalage, certaines fonctionnalités avancées peuvent ne pas être disponibles.
accountId

string

ID du compte utilisé pour acheter le billet.
confirmationCode

string

Code de confirmation de l'achat. Il peut être identique pour plusieurs billets différents et 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 faciale du billet.
purchasePrice

object (Money)

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

object (LocalizedString)

Message décrivant tout type de remise appliquée.

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. Cette valeur est obligatoire si destinationStationCode est présent ou si originName n'est pas spécifié.
originName

object (LocalizedString)

Nom de la station de départ. Cet attribut est obligatoire si desinationName est présent ou si originStationCode ne l'est pas.
destinationStationCode

string

Code de la station de destination.
destinationName

object (LocalizedString)

Nom de la destination.
departureDateTime

string

Date/Heure de départ Cette valeur est obligatoire si aucun intervalle de temps de validité n'est défini sur l'objet de 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 déroulait à New York, cela correspondrait à 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 informations sur un éventuel décalage.

La partie de la date/heure sans décalage est considérée comme "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 la 20e heure du 5 juin 2018 à la station de départ, la date et l'heure locales doivent être définies sur 2018-06-05T20:00:00. Si la date/heure locale de la station d'origine est 4 heures avant l'heure UTC, un décalage de -04:00 peut être ajouté.

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

string

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 spécifiée à la nanoseconde près. Les décalages peuvent être spécifiés avec une précision en secondes (même si les secondes décalées ne font pas partie de 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 déroulait à New York, cela correspondrait à 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 informations sur un éventuel 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/heure locale de la borne de destination. Par exemple, si l'événement se produit la 20e heure du 5 juin 2018 dans la station de destination, la date/heure locale doit être 2018-06-05T20:00:00. Si la date/heure locale de la borne de destination est 4 heures en avance sur l'heure UTC, un décalage de -04:00 peut être ajouté.

Sans informations de décalage, certaines fonctionnalités avancées peuvent ne pas être disponibles.
fareName

object (LocalizedString)

Brève description/nom du tarif pour cette partie du trajet. (par exemple, "Utilisation unique à tout moment").
carriage

string

Nom/numéro du train ou du navire que le passager doit embarquer.
platform

string

Plate-forme ou portail où le passager peut monter dans la voiture.
zone

string

Zone d'embarquement sur le quai.
ticketSeat

object (TicketSeat)

Siège réservé pour le ou les passagers. Si plusieurs licences utilisateur doivent être spécifiées, utilisez le champ ticketSeats à la place. ticketSeat et ticketSeats ne peuvent pas être définis.
ticketSeats[]

object (TicketSeat)

Siège réservé pour le ou les passagers. Si vous ne devez spécifier qu'un seul siège, utilisez plutôt le champ ticketSeat. ticketSeat et ticketSeats ne doivent pas être définis en même temps.
transitOperatorName

object (LocalizedString)

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

object (LocalizedString)

Gare terminus 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 aucun fareClass ne s'applique. fareClass et customFareClass ne doivent pas être définis en même temps.
coach

string

Identifiant du wagon ou de l'autobus où se trouve le siège avec billet. (ex. : "10"
seat

string

Identifiant de l'emplacement du siège pour lequel le billet a été émis. (ex. : "42". Si aucun identifiant spécifique n'est disponible, utilisez plutôt seatAssigment.
seatAssignment

object (LocalizedString)

Attribution des sièges du passager. (ex. : "Aucun siège spécifique". À utiliser lorsqu'aucun identifiant spécifique n'est à utiliser dans seat.

FareClass

Enums
FARE_CLASS_UNSPECIFIED
ECONOMY
economy

Ancien alias pour ECONOMY. Obsolète.
FIRST
first

Ancien alias pour FIRST. Obsolète.
BUSINESS
business

Ancien alias pour BUSINESS. Obsolète.

TripType

Enums
TRIP_TYPE_UNSPECIFIED
ROUND_TRIP
roundTrip

Ancien alias pour 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 si la valeur est compatible avec l'activation.

Représentation JSON 
{
  "state": enum (State)
}
Champs
state

enum (State)

État

Enums
UNKNOWN_STATE
NOT_ACTIVATED "Non activé" (état par défaut)
not_activated

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

Ancien alias pour ACTIVATED. Obsolète.

DeviceContext

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

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

string

Si cette règle est définie, les informations d'utilisation ne sont renvoyées à l'appareil qu'après l'activation de l'objet. Cette chaîne ne doit pas être utilisée comme identifiant stable pour suivre l'appareil d'un utilisateur. Ce nombre peut varier en fonction de la carte utilisée sur un même appareil, ou même en fonction des différentes activations effectuées sur un même appareil. 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'ID et les propriétés donnés.

list

 Renvoie la liste de tous les objets de transport 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é.