REST Resource: flightobject

Ressource: FlightObject

Représentation JSON
{
  "kind": string,
  "classReference": {
    object (FlightClass)
  },
  "passengerName": string,
  "boardingAndSeatingInfo": {
    object (BoardingAndSeatingInfo)
  },
  "reservationInfo": {
    object (ReservationInfo)
  },
  "securityProgramLogo": {
    object (Image)
  },
  "hexBackgroundColor": string,
  "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)
  },
  "rotatingBarcode": {
    object (RotatingBarcode)
  },
  "heroImage": {
    object (Image)
  },
  "groupingInfo": {
    object (GroupingInfo)
  },
  "passConstraints": {
    object (PassConstraints)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  },
  "linkedObjectIds": [
    string
  ],
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
Champs
kind
(deprecated)

string

Identifie le type de ressource. Valeur : chaîne fixe "walletobjects#flightObject".

classReference

object (FlightClass)

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

passengerName

string

Obligatoire. Nom du passager tel qu'il apparaît sur la carte d'embarquement

Exemples: "Dave M Gahan" ou "Gahan/Dave" ou "GAHAN/DAVEM"

boardingAndSeatingInfo

object (BoardingAndSeatingInfo)

Informations spécifiques au passager sur l'embarquement et les sièges

reservationInfo

object (ReservationInfo)

Obligatoire. Informations sur la réservation de vol.

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 hexadécimal, comme #ffcc00. Vous pouvez également utiliser la version abrégée du triplet RVB (#rgb), telle que #fc0.

id

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

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 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 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 et pourra être utilisé. L'état d'un objet passe à expired une fois ce délai écoulé.

locations[]
(deprecated)

object (LatLongPoint)

Remarque : Il n'est actuellement pas possible d'utiliser ce champ pour déclencher des notifications géo.

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 de niveau de classe enableSmartTap et redemptionIssuers doivent également être configurés correctement 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".

Actuellement, cela ne peut être défini que pour Flights.

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.

rotatingBarcode

object (RotatingBarcode)

Type et valeur du code-barres rotatif.

heroImage

object (Image)

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

object (GroupingInfo)

Information qui gère le regroupement des cartes.

passConstraints

object (PassConstraints)

Transmettez les contraintes de l'objet. Inclut la limitation des comportements NFC et 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 changent 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 linkedObjectIds sont une liste d'autres objets tels que des billets pour des événements, des cartes de fidélité, des offres, des génériques, des cartes cadeaux, des titres de transport et des cartes d'embarquement qui doivent être automatiquement associés à cet objet de vol. Si un utilisateur a enregistré cette carte d'embarquement, 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).

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

object (ValueAddedModuleData)

Données du module avec valeur ajoutée facultative. Dix au maximum sur l'objet.

BoardingAndSeatingInfo

Représentation JSON
{
  "kind": string,
  "boardingGroup": string,
  "seatNumber": string,
  "seatClass": string,
  "boardingPrivilegeImage": {
    object (Image)
  },
  "boardingPosition": string,
  "sequenceNumber": string,
  "boardingDoor": enum (BoardingDoor),
  "seatAssignment": {
    object (LocalizedString)
  }
}
Champs
kind
(deprecated)

string

Identifie le type de ressource. Valeur : chaîne fixe "walletobjects#boardingAndSeatingInfo".

boardingGroup

string

Valeur du groupe d'embarquement (ou zone) auquel ce passager doit embarquer.

Exemple: "B"

Le libellé de cette valeur sera déterminé par le champ boardingPolicy du flightClass référencé par cet objet.

seatNumber

string

Valeur du siège passager. Si aucun identifiant spécifique n'est disponible, utilisez plutôt seatAssignment.

Ex. : "25A"

seatClass

string

Valeur de la classe du siège.

Exemple: "Économique" ou "Économique Plus"

boardingPrivilegeImage

object (Image)

Petite image affichée au-dessus du code-barres d'embarquement. Les compagnies aériennes peuvent l'utiliser pour communiquer tout droit d'embarquement spécial. Si le logo du programme de sécurité est également défini, cette image peut être affichée à côté du logo de ce programme de sécurité.

boardingPosition

string

Valeur de la position d'embarquement.

Ex. : "76"

sequenceNumber

string

Numéro de séquence figurant sur la carte d'embarquement. Il s'agit généralement de la séquence dans laquelle les passagers se sont enregistrés. La compagnie aérienne peut utiliser ce numéro pour les étiquettes de bagages et d'embarquement manuels.

Exemple: "49"

boardingDoor

enum (BoardingDoor)

Ne définissez ce champ que si ce vol embarque via plusieurs portes ou passerelles et que vous souhaitez imprimer explicitement l'emplacement de la porte sur la carte d'embarquement. La plupart des compagnies aériennes orientent leurs passagers vers la bonne porte ou passerelle en utilisant le code seatClass. Dans ce cas, boardingDoor ne doit pas être défini.

seatAssignment

object (LocalizedString)

Siège attribué au passager. À utiliser lorsqu'aucun identifiant spécifique n'est à utiliser dans seatNumber.

Exemple: "assigned at gate"

BoardingDoor

Enums
BOARDING_DOOR_UNSPECIFIED
FRONT
front

Ancien alias pour FRONT. Obsolète.

BACK
back

Ancien alias de BACK. Obsolète.

ReservationInfo

Représentation JSON
{
  "kind": string,
  "confirmationCode": string,
  "eticketNumber": string,
  "frequentFlyerInfo": {
    object (FrequentFlyerInfo)
  }
}
Champs
kind
(deprecated)

string

Identifie le type de ressource. Valeur : chaîne fixe "walletobjects#reservationInfo".

confirmationCode

string

Code de confirmation nécessaire pour vous enregistrer pour ce vol.

Il s'agit du numéro que le passager doit entrer sur un kiosque à l'aéroport pour rechercher le vol et imprimer une carte d'embarquement.

eticketNumber

string

Numéro du billet électronique.

frequentFlyerInfo

object (FrequentFlyerInfo)

Informations sur l'abonnement à un programme de fidélité

FrequentFlyerInfo

Représentation JSON
{
  "kind": string,
  "frequentFlyerProgramName": {
    object (LocalizedString)
  },
  "frequentFlyerNumber": string
}
Champs
kind
(deprecated)

string

Identifie le type de ressource. Valeur : chaîne fixe "walletobjects#frequentFlyerInfo".

frequentFlyerProgramName

object (LocalizedString)

Nom du programme de fidélité. Exemple : "Lufthansa Miles & More"

frequentFlyerNumber

string

Numéro de membre du programme de fidélité.

Obligatoire pour chaque objet imbriqué de genre walletobjects#frequentFlyerInfo.

Méthodes

addmessage

Ajoute un message à l'objet vol référencé par l'ID d'objet donné.

get

Renvoie l'objet vol associé à l'ID d'objet donné.

insert

Insère un objet vol avec l'ID et les propriétés donnés.

list

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

patch

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

update

Met à jour l'objet "flight" référencé par l'ID d'objet donné.