REST Resource: flightobject

Ressource: FlightObject

JSON-Darstellung
{
  "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)
    }
  ]
}
Felder
kind
(deprecated)

string

Gibt an, um welche Art von Ressource es sich handelt. Wert: der feste String "walletobjects#flightObject".

classReference

object (FlightClass)

Eine Kopie der übernommenen Felder der übergeordneten Klasse. Diese Felder werden bei einem GET-Vorgang abgerufen.

passengerName

string

Erforderlich. Der Passagiername, wie er auf der Bordkarte stehen würde.

Beispiel: „Dave M Gahan“ oder „Gahan/Dave“ oder „GAHAN/DAVEM“

boardingAndSeatingInfo

object (BoardingAndSeatingInfo)

Fahrgastspezifische Informationen zum Einsteigen und zum Sitzplatz

reservationInfo

object (ReservationInfo)

Erforderlich. Informationen zur Flugreservierung.

hexBackgroundColor

string

Die Hintergrundfarbe der Karte bzw. des Tickets. Falls nicht festgelegt, wird die Hauptfarbe des Hero-Images verwendet, und wenn kein Hero-Image festgelegt ist, wird die Hauptfarbe des Logos verwendet. Das Format ist #rrggbb, wobei rrggbb ein hexadezimales RGB-Triplet ist, z. B. #ffcc00. Du kannst auch die Kurzversion des RGB-Triplets (#rgb) verwenden, z. B. #fc0.

id

string

Erforderlich. Die eindeutige Kennung für ein Objekt. Diese ID muss für alle Objekte eines Ausstellers eindeutig sein. Dieser Wert sollte das Format issuer ID haben.identifier, wobei von Google ausgegeben und von dir ausgewählt wird. Die eindeutige Kennung darf nur alphanumerische Zeichen, „.“ (Punkt), „_“ (Unterstrich) oder „-“ (Bindestriche) enthalten.

classId

string

Erforderlich. Die Klasse, die mit diesem Objekt verknüpft ist. Die Klasse muss vom selben Typ wie dieses Objekt sein, bereits vorhanden und genehmigt sein.

Klassen-IDs müssen dem Format issuer ID entsprechen.identifier, wobei von Google ausgegeben und von dir ausgewählt wird.

version
(deprecated)

string (int64 format)

Verworfen

state

enum (State)

Erforderlich. Der Status des Objekts. Mit diesem Feld wird festgelegt, wie ein Objekt in der App angezeigt wird. Ein inactive-Objekt wird beispielsweise in den Abschnitt „Abgelaufene Karten/Tickets“ verschoben.

barcode

object (Barcode)

Der Typ und Wert des Barcodes.

messages[]

object (Message)

Eine Reihe von Nachrichten, die in der App angezeigt werden. Alle Nutzer dieses Objekts erhalten die zugehörigen Nachrichten. Die maximale Anzahl dieser Felder ist 10.

validTimeInterval

object (TimeInterval)

Der Zeitraum, in dem dieses Objekt active ist und verwendet werden kann. Nach Ablauf dieses Zeitraums ändert sich der Status des Objekts in expired.

locations[]
(deprecated)

object (LatLongPoint)

Hinweis: Dieses Feld wird derzeit nicht zum Auslösen von Benachrichtigungen unterstützt.

hasUsers

boolean

Gibt an, ob das Objekt Nutzer hat. Dieses Feld wird von der Plattform festgelegt.

smartTapRedemptionValue

string

Der Wert, der für dieses Objekt über NFC an ein Smart-Bonus-zertifiziertes Terminal übertragen wird. Die Felder enableSmartTap und redemptionIssuers auf Klassenebene müssen ebenfalls richtig eingerichtet sein, damit die Karte bzw. das Ticket Smart-Bonus unterstützt. Es werden nur ASCII-Zeichen unterstützt.

hasLinkedDevice

boolean

Gibt an, ob dieses Objekt derzeit mit einem einzelnen Gerät verknüpft ist. Dieses Feld wird von der Plattform festgelegt, wenn ein Nutzer das Objekt speichert und mit seinem Gerät verknüpft. Nur für ausgewählte Partner bestimmt. Weitere Informationen erhalten Sie vom Support.

disableExpirationNotification

boolean

Gibt an, ob Benachrichtigungen ausdrücklich unterdrückt werden sollen. Wenn dieses Feld auf „wahr“ gesetzt ist, werden unabhängig vom Feld messages keine Ablaufbenachrichtigungen an den Nutzer gesendet. Standardmäßig ist dieses Feld auf „false“ gesetzt.

Derzeit kann dies nur für Flüge festgelegt werden.

infoModuleData

object (InfoModuleData)

Verworfen. Verwenden Sie stattdessen „textModulesData“.

imageModulesData[]

object (ImageModuleData)

Daten des Bildmoduls. Maximal werden ein Feld auf Objektebene und ein Feld auf Klassenobjektebene angezeigt.

textModulesData[]

object (TextModuleData)

Textmoduldaten. Wenn für den Kurs auch Textmoduldaten definiert sind, werden beide angezeigt. Es werden maximal 10 Felder des Objekts und 10 Felder der Klasse angezeigt.

rotatingBarcode

object (RotatingBarcode)

Der Typ und Wert des rotierenden Barcodes.

heroImage

object (Image)

Optionales Bannerbild, das auf der Vorderseite der Karte angezeigt wird. Ist keins vorhanden, wird das Hero-Image der Klasse angezeigt, sofern vorhanden. Wenn auch das Hero-Image des Kurses nicht vorhanden ist, wird nichts angezeigt.

groupingInfo

object (GroupingInfo)

Informationen, die steuern, wie Karten/Tickets gruppiert werden.

passConstraints

object (PassConstraints)

Einschränkungen für Karten/Tickets für das Objekt. Dazu gehört auch die Einschränkung des NFC- und Screenshot-Verhaltens.

saveRestrictions

object (SaveRestrictions)

Einschränkungen für das Objekt, die überprüft werden müssen, bevor der Nutzer versucht, die Karte bzw. das Ticket zu speichern. Diese Einschränkungen gelten nur während der Speicherzeit. Wenn sich die Einschränkungen ändern, nachdem ein Nutzer die Karte bzw. das Ticket gespeichert hat, werden die neuen Einschränkungen nicht auf eine bereits gespeicherte Karte bzw. ein bereits gespeichertes Ticket angewendet.

linkedObjectIds[]

string

„linkedObjectIds“ ist eine Liste anderer Objekte wie Veranstaltungstickets, Kundenkarten, Angebote, generische Karten/Tickets, Geschenkkarten, Fahrkarten und Bordkarten, die automatisch an dieses Flugobjekt angehängt werden sollen. Wenn ein Nutzer diese Bordkarte gespeichert hat, werden diese verknüpften ObjectIds automatisch an die Wallet des Nutzers gesendet, es sei denn, er hat die Einstellung deaktiviert, um solche verknüpften Karten zu erhalten.

Achten Sie darauf, dass Objekte, die in „linkedObjectIds“ vorhanden sind, bereits eingefügt wurden. Andernfalls schlagen Aufrufe fehl. Verknüpfte Objekte können nicht mehr getrennt werden. Sie können keine Objekte verknüpfen, die einem anderen Aussteller gehören. Die Anzahl der Objekte, die mit einem einzelnen Objekt verknüpft werden können, ist begrenzt. Wenn das Limit erreicht ist, werden neue verknüpfte Objekte im Anruf stumm ignoriert.

Objekt-IDs müssen dem Format issuer ID entsprechen.identifier, wobei von Google ausgegeben und von dir ausgewählt wird.

notifyPreference

enum (NotificationSettingsForUpdates)

Gibt an, ob Feldaktualisierungen für dieses Objekt Benachrichtigungen auslösen sollen. Wenn diese Option auf NOTIFY gesetzt ist, versuchen wir, eine Benachrichtigung über die Aktualisierung eines Felds an die Nutzer auszulösen. Diese Benachrichtigungen werden nur an Nutzer gesendet, wenn das Feld auf einer Zulassungsliste steht. Wenn „DO_NOT_NOTIFY“ oder „NOTIFICATION_SETTINGS_UNSPECIFIED“ festgelegt ist, wird keine Benachrichtigung ausgelöst. Diese Einstellung ist temporär und muss bei jeder PATCH- oder UPDATE-Anfrage festgelegt werden. Andernfalls wird keine Benachrichtigung ausgelöst.

valueAddedModuleData[]

object (ValueAddedModuleData)

Optionale Daten zum Mehrwertmodul. Maximal zehn für das Objekt.

BoardingAndSeatingInfo

JSON-Darstellung
{
  "kind": string,
  "boardingGroup": string,
  "seatNumber": string,
  "seatClass": string,
  "boardingPrivilegeImage": {
    object (Image)
  },
  "boardingPosition": string,
  "sequenceNumber": string,
  "boardingDoor": enum (BoardingDoor),
  "seatAssignment": {
    object (LocalizedString)
  }
}
Felder
kind
(deprecated)

string

Gibt an, um welche Art von Ressource es sich handelt. Wert: der feste String "walletobjects#boardingAndSeatingInfo".

boardingGroup

string

Der Wert der Einstiegsgruppe (oder -zone), mit der dieser Fahrgast einsteigen soll.

Beispiel: „B“

Das Label für diesen Wert wird durch das Feld boardingPolicy im flightClass bestimmt, auf das dieses Objekt verweist.

seatNumber

string

Der Wert des Beifahrersitzes. Wenn keine bestimmte Kennung vorhanden ist, verwenden Sie stattdessen seatAssignment.

Beispiel: „25A“

seatClass

string

Der Wert der Sitzplatzklasse.

Beispiel: „Economy“ oder „Economy Plus“

boardingPrivilegeImage

object (Image)

Ein kleines Bild über dem Boarding-Barcode. Fluggesellschaften können damit besondere Berechtigungen für den Einstieg mitteilen. Falls auch das Logo des Sicherheitsprogramms festgelegt ist, wird dieses Bild möglicherweise zusammen mit dem Logo für das Sicherheitsprogramm gerendert.

boardingPosition

string

Der Wert der Einstiegsposition.

Beispiel: „76“

sequenceNumber

string

Die fortlaufende Nummer auf dem Boardingpass. Dieser entspricht in der Regel der Reihenfolge, in der die Passagiere eingecheckt haben. Die Fluggesellschaft verwendet die Nummer möglicherweise für manuelles Boarding und Gepäcklabels.

Beispiel: „49“

boardingDoor

enum (BoardingDoor)

Legen Sie dieses Feld nur fest, wenn für diesen Flug mehr als eine Tür oder Brücke verwendet wird und Sie den Standort der Tür auf dem Boardingpass ausdrücklich drucken möchten. Die meisten Fluggesellschaften leiten ihre Passagiere an die richtige Tür oder Brücke weiter, indem sie sich an der seatClass orientieren. In diesen Fällen sollte boardingDoor nicht festgelegt werden.

seatAssignment

object (LocalizedString)

Die Sitzplatzzuweisung des Fahrgastes. Wird verwendet, wenn in seatNumber keine bestimmte Kennung verwendet werden soll.

Beispiel: „assigned at gate“

BoardingDoor

Enums
BOARDING_DOOR_UNSPECIFIED
FRONT
front

Alter Alias für FRONT. Verworfen.

BACK
back

Alter Alias für BACK. Verworfen.

ReservationInfo

JSON-Darstellung
{
  "kind": string,
  "confirmationCode": string,
  "eticketNumber": string,
  "frequentFlyerInfo": {
    object (FrequentFlyerInfo)
  }
}
Felder
kind
(deprecated)

string

Gibt an, um welche Art von Ressource es sich handelt. Wert: der feste String "walletobjects#reservationInfo".

confirmationCode

string

Bestätigungscode, der für den Check-in für diesen Flug erforderlich ist.

Diese Nummer gibt der Passagier an einem Kiosk am Flughafen ein, um den Flug abzurufen und eine Bordkarte auszudrucken.

eticketNumber

string

E-Ticket-Nummer.

frequentFlyerInfo

object (FrequentFlyerInfo)

Informationen zur Vielfliegermitgliedschaft

FrequentFlyerInfo

JSON-Darstellung
{
  "kind": string,
  "frequentFlyerProgramName": {
    object (LocalizedString)
  },
  "frequentFlyerNumber": string
}
Felder
kind
(deprecated)

string

Gibt an, um welche Art von Ressource es sich handelt. Wert: der feste String "walletobjects#frequentFlyerInfo".

frequentFlyerProgramName

object (LocalizedString)

Name des Vielfliegerprogramms, z. B. „Lufthansa Miles & More“

frequentFlyerNumber

string

Vielfliegernummer

Erforderlich für jedes verschachtelte Objekt vom Typ walletobjects#frequentFlyerInfo.

Methoden

addmessage

Fügt dem Flugobjekt, auf das durch die angegebene Objekt-ID verwiesen wird, eine Nachricht hinzu.

get

Gibt das Flugobjekt mit der angegebenen Objekt-ID zurück.

insert

Ein Flugobjekt mit der angegebenen ID und den angegebenen Eigenschaften wird eingefügt.

list

Gibt eine Liste aller Flugobjekte für eine bestimmte Aussteller-ID zurück.

patch

Aktualisiert das Flugobjekt, auf das durch die angegebene Objekt-ID verwiesen wird.

update

Aktualisiert das Flugobjekt, auf das durch die angegebene Objekt-ID verwiesen wird.