REST Resource: transitobject

{
  "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)
  }
}

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.

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.

enum (PassengerType)

Nombre de passagers.

string

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

string

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

enum (TicketStatus)

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

object (LocalizedString)

État personnalisé à utiliser pour la valeur d'état de la demande lorsque ticketStatus ne propose pas l'option appropriée. Impossible de définir ticketStatus et customTicketStatus.

enum (ConcessionCategory)

Catégorie de réduction pour le billet.

object (LocalizedString)

Catégorie de réduction personnalisée à utiliser lorsque concessionCategory ne propose pas la bonne option. Impossible de définir concessionCategory et customConcessionCategory.

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.

object (PurchaseDetails)

Détails de l'achat de ce billet.

object (TicketLeg)

Une section de ticket unique contient des informations sur les départs et les arrivées, ainsi que des informations sur l'embarquement et les places. Si plusieurs sections doivent être spécifiées, utilisez plutôt le champ ticketLegs. Impossible de définir ticketLeg et ticketLegs.

object (TicketLeg)

Chaque billet peut comporter une ou plusieurs sections. Chaque étape contient des informations sur les départs et les arrivées, ainsi que des informations sur l'embarquement et les places. Si une seule section doit être spécifiée, utilisez plutôt le champ ticketLeg. Impossible de définir ticketLeg et ticketLegs.

string

Couleur d'arrière-plan de la carte. 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), comme #fc0.

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.

string

Obligatoire. Identifiant unique d'un objet. Cet identifiant doit être unique pour 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 "-".

string

Obligatoire. Classe associée à cet objet. La classe doit être du même type que cet objet, existe déjà 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.

string (int64 format)

Obsolète

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é vers "Cartes expirées" .

object (Barcode)

Type et valeur du code-barres.

object (Message)

Tableau des 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.

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.

object (LatLongPoint)

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

boolean

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

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.

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 et l'associe à son appareil. Destiné à certains partenaires. Contactez l'assistance pour en savoir plus.

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, cela ne peut être défini que pour les offres.

object (InfoModuleData)

Obsolète. Utilisez textModulesData à la place.

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.

object (TextModuleData)

Données du module de texte. Si des données de module de texte sont également définies sur la classe, les deux s'affichent. Ces champs affichés sont limités à 10 pour l'objet et 10 à partir de la classe.

object (LinksModuleData)

Données du module de liens. Si des données du module de liens sont également définies sur la classe, les deux s'affichent.

object (AppLinkData)

Lien facultatif vers l'application ou le site Web qui s'affichera 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é.

object (ActivationStatus)

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

object (RotatingBarcode)

Type et valeur du code-barres rotatif.

object (DeviceContext)

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

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.

object (GroupingInfo)

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

object (PassConstraints)

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

object (SaveRestrictions)

Restrictions sur l'objet qui doit être vérifié avant que l'utilisateur ne tente d'enregistrer la carte. Notez que ces restrictions ne seront appliquées que pendant la sauvegarde. Si les restrictions changent après qu'un utilisateur a enregistré la carte, les nouvelles restrictions ne s'appliquent pas à une carte déjà enregistrée.

{
  "routeRestrictions": {
    object (LocalizedString)
  },
  "routeRestrictionsDetails": {
    object (LocalizedString)
  },
  "timeRestrictions": {
    object (LocalizedString)
  },
  "otherRestrictions": {
    object (LocalizedString)
  }
}

object (LocalizedString)

Restrictions concernant les itinéraires possibles. Par exemple, il peut s'agir de la chaîne "Réservé aux trains CrossCountry uniquement".

object (LocalizedString)

En savoir plus sur les routeRestrictions ci-dessus.

object (LocalizedString)

Restrictions concernant les horaires d'utilisation de ce billet.

object (LocalizedString)

Restrictions supplémentaires ne relevant pas de la "route" ou "heure" catégories.

{
  "purchaseReceiptNumber": string,
  "purchaseDateTime": string,
  "accountId": string,
  "confirmationCode": string,
  "ticketCost": {
    object (TicketCost)
  }
}

string

Numéro de reçu/identifiant pour le suivi de l'achat du billet via le corps ayant vendu le billet.

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 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 sont pas conformes à 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 en heure 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 UTC (même instant dans le temps que dans l'exemple ci-dessus). Si l'événement a eu lieu à 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 informations de décalage.

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

string

ID du compte utilisé pour acheter le billet.

string

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

object (TicketCost)

Coût du billet.

{
  "faceValue": {
    object (Money)
  },
  "purchasePrice": {
    object (Money)
  },
  "discountMessage": {
    object (LocalizedString)
  }
}

object (Money)

Valeur nominale du billet.

object (Money)

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

object (LocalizedString)

Message décrivant tout type de remise appliqué.

{
  "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)
  }
}

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

object (LocalizedString)

Nom de la station de départ. Cette valeur est obligatoire si desinationName est présent ou si originStationCode n'est pas spécifié.

string

Code de la station de destination.

object (LocalizedString)

Nom de la destination.

string

Date et heure du 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 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 en heure 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 UTC (même instant dans le temps que dans l'exemple ci-dessus). Si l'événement a eu lieu à 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 informations de 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 et de l'heure locales de la station 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 et l'heure locales de la station de départ se situent quatre 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.

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 sont pas conformes à 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 en heure 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 UTC (même instant dans le temps que dans l'exemple ci-dessus). Si l'événement a eu lieu à 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 informations de 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 et de l'heure locales de la station 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 et l'heure locales de la station de destination se situent quatre 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.

object (LocalizedString)

Brève description/nom du tarif pour cette partie du trajet. Par exemple, "Valable une seule fois" à tout moment.

string

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

string

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

string

Zone d'embarquement sur le quai.

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. Impossible de définir ticketSeat et 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. Impossible de définir ticketSeat et ticketSeats.

object (LocalizedString)

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

object (LocalizedString)

Gare terminus ou destination du train, du bus, etc.

{
  "fareClass": enum (FareClass),
  "customFareClass": {
    object (LocalizedString)
  },
  "coach": string,
  "seat": string,
  "seatAssignment": {
    object (LocalizedString)
  }
}

enum (FareClass)

Classe tarifaire du siège avec billet.

object (LocalizedString)

Classe tarifaire personnalisée à utiliser si aucun fareClass ne s'applique. Impossible de définir fareClass et customFareClass.

string

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

string

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

object (LocalizedString)

Attribution des sièges du passager. Par exemple : "aucun siège spécifique". À utiliser lorsqu'il n'y a pas d'identifiant spécifique à utiliser dans seat.

{
  "state": enum (State)
}

enum (State)

{
  "deviceToken": string
}

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. Il ne doit pas être utilisé comme un identifiant stable pour suivre l'appareil d'un utilisateur. Ce nombre peut varier d'une carte à un autre pour un même appareil, ou même lors de différentes activations pour un même appareil. Les appelants doivent également définir hasLinkedDevice sur l'objet en cours d'activation.