REST Resource: flightobject

Zasób: FlightObject

Zapis 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)
    }
  ]
}
Pola
kind
(deprecated)

string

Określa rodzaj danego zasobu. Wartość: ustalony ciąg znaków "walletobjects#flightObject".

classReference

object (FlightClass)

Kopia dziedziczonych pól klasy nadrzędnej. Te pola są pobierane podczas żądania GET.

passengerName

string

Wymagane. Nazwisko pasażera, jakie widnieje na karcie pokładowej.

Na przykład: „Dave M Gahan” lub „Gahan/Dave”, lub „GAHAN/DAVEM”

boardingAndSeatingInfo

object (BoardingAndSeatingInfo)

Szczegółowe informacje dla pasażerów na temat wchodzenia na pokład i przydziału miejsc.

reservationInfo

object (ReservationInfo)

Wymagane. Informacje o rezerwacji lotu.

hexBackgroundColor

string

Kolor tła karty. Jeśli nie jest ustawiony, używany jest dominujący kolor obrazu banera powitalnego, a jeśli obraz banera powitalnego nie jest ustawiony, używany jest dominujący kolor logo. Format to #rrggbb, gdzie rrggbb to szesnastkowy zapis RGB, taki jak #ffcc00. Możesz także używać skróconej wersji zapisu RGB w formacie #rgb, jak w tym przykładzie: #fc0.

id

string

Wymagane. Unikalny identyfikator obiektu. Ten identyfikator musi być unikalny wśród wszystkich obiektów wydawcy. Ta wartość powinna mieć format issuer ID.identifier, gdzie pierwszy identyfikator jest wystawiany przez Google, a drugi jest wybierany przez Ciebie. Unikalny identyfikator powinien zawierać tylko znaki alfanumeryczne oraz znaki „.”, „_” lub „-”.

classId

string

Wymagane. Klasa powiązana z tym obiektem. Klasa musi być tego samego typu co ten obiekt, musi już istnieć i musi być zatwierdzona.

Identyfikatory klas powinny mieć format issuer ID.identifier, gdzie pierwszy identyfikator jest wystawiany przez Google, a drugi jest wybierany przez Ciebie.

version
(deprecated)

string (int64 format)

Wycofano

state

enum (State)

Wymagane. Stan obiektu. To pole służy do określania sposobu wyświetlania obiektu w aplikacji. Na przykład obiekt inactive jest przenoszony do sekcji „Karty, które straciły ważność”.

barcode

object (Barcode)

Typ i wartość kodu kreskowego.

messages[]

object (Message)

Tablica komunikatów wyświetlanych w aplikacji. Wszyscy użytkownicy tego obiektu będą otrzymywać powiązane z nim komunikaty. Maksymalna liczba tych pól to 10.

validTimeInterval

object (TimeInterval)

Okres, przez jaki ten obiekt będzie active i będzie można go używać. Po upływie tego czasu stan obiektu zostanie zmieniony na expired.

locations[]
(deprecated)

object (LatLongPoint)

Uwaga: to pole nie jest obecnie obsługiwane w przypadku wywoływania powiadomień geograficznych.

hasUsers

boolean

Wskazuje, czy obiekt ma użytkowników. To pole jest ustawiane przez platformę.

smartTapRedemptionValue

string

Wartość, która będzie przesyłana przez NFC do terminala z certyfikatem smart tap w przypadku tego obiektu. Aby karty obsługiwały funkcję smart tap, pola poziomu klasy enableSmartTapredemptionIssuers muszą być też prawidłowo skonfigurowane. Obsługiwane są tylko znaki ASCII.

hasLinkedDevice

boolean

Wskazuje, czy ten obiekt jest aktualnie połączony z jednym urządzeniem. To pole jest ustawiane przez platformę, gdy użytkownik zapisuje obiekt, łącząc go ze swoim urządzeniem. Przeznaczone do użytku przez wybranych partnerów. Aby uzyskać więcej informacji, skontaktuj się z zespołem pomocy.

disableExpirationNotification

boolean

Wskazuje, czy powiadomienia powinny być jawnie pomijane. Jeśli to pole jest ustawione na wartość true, niezależnie od pola messages powiadomienia o utracie ważności kierowane do użytkownika będą pomijane. Domyślnie to pole ma wartość false (fałsz).

Obecnie można je ustawiać tylko dla lotów.

infoModuleData

object (InfoModuleData)

Rola wycofana. Zamiast tego użyj textModulesData.

imageModulesData[]

object (ImageModuleData)

Dane modułu obrazu. Maksymalna liczba wyświetlanych pól wynosi 1 z poziomu obiektu i 1 na poziomie obiektu klasy.

textModulesData[]

object (TextModuleData)

Dane modułu tekstowego. Jeśli dane modułu tekstowego są określone również w klasie, będą wyświetlane jedne i drugie. Maksymalna liczba wyświetlanych pól wynosi 10 z obiektu i 10 z klasy.

rotatingBarcode

object (RotatingBarcode)

Typ i wartość zmieniającego się kodu kreskowego.

heroImage

object (Image)

Opcjonalny obraz banera wyświetlany z przodu karty. Jeśli nie ma żadnego obrazu, wyświetli się obraz banera powitalnego (jeśli jest dostępny). Jeśli nie ma też obrazu banera powitalnego klasy, nic się nie wyświetli.

groupingInfo

object (GroupingInfo)

Informacje określające sposób grupowania kart.

passConstraints

object (PassConstraints)

Przekazywanie ograniczeń dotyczących obiektu. Obejmuje to ograniczenie działania NFC i zrzutów ekranu.

saveRestrictions

object (SaveRestrictions)

Ograniczenia dotyczące obiektu, które musi zostać zweryfikowane, zanim użytkownik spróbuje zapisać kartę. Te ograniczenia będą stosowane tylko podczas zapisywania. Jeśli ograniczenia zmienią się po zapisaniu karty przez użytkownika, nowe ograniczenia nie zostaną zastosowane do zapisanej karty.

linkedObjectIds[]

string

linkedObjectIds to lista innych obiektów, takich jak bilet na wydarzenie, karta lojalnościowa, oferta, karta podarunkowa, karta pokładowa i bilet okresowy, które powinny być automatycznie dołączone do tego obiektu lotu. Jeśli użytkownik zapisze kartę pokładową, te identyfikatory połączonych obiektów zostaną automatycznie przesłane do portfela użytkownika (chyba że wyłączy ustawienie otrzymywania takich połączonych kart).

Upewnij się, że obiekty w linkedObjectIds zostały już wstawione. W przeciwnym razie wywołania nie powiedzą się. Po połączeniu połączonych obiektów nie można ich odłączyć. Nie możesz łączyć obiektów należących do innego wystawcy. Liczba obiektów, które można połączyć z jednym obiektem, jest ograniczona. Po osiągnięciu limitu nowe połączone obiekty w wywołaniu będą dyskretnie ignorowane.

Identyfikatory obiektów powinny mieć format issuer ID.identifier, gdzie pierwszy identyfikator jest wystawiany przez Google, a drugi jest wybierany przez Ciebie.

notifyPreference

enum (NotificationSettingsForUpdates)

Określa, czy aktualizacje pól tego obiektu powinny wyzwalać powiadomienia. Gdy ustawisz opcję NOTIFY (powiadamiaj), spróbujemy wywołać powiadomienie o zmianie pola dla użytkowników. Takie powiadomienia będą wysyłane do użytkowników tylko wtedy, gdy dane pole znajdzie się na liście dozwolonych. Jeśli ustawisz wartość DO_NOT_NOTIFY lub NOTIFICATION_SETTINGS_UNSPECIFIED, nie zostanie uruchomione żadne powiadomienie. To ustawienie jest tymczasowe i musi być ustawiane w ramach każdego żądania PATCH lub UPDATE, w przeciwnym razie powiadomienie nie zostanie wywołane.

valueAddedModuleData[]

object (ValueAddedModuleData)

Opcjonalne dane modułu wartości dodanej. Maksymalnie 10 na obiekt.

BoardingAndSeatingInfo

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

string

Określa rodzaj danego zasobu. Wartość: ustalony ciąg znaków "walletobjects#boardingAndSeatingInfo".

boardingGroup

string

Grupa (lub strefa) wchodzenia na pokład danego pasażera.

Na przykład: „B”.

Etykieta tej wartości zostanie określona przez pole boardingPolicy w klasie flightClass, do której odwołuje się ten obiekt.

seatNumber

string

Numer miejsca pasażera. Jeśli nie ma określonego identyfikatora, użyj zamiast tego seatAssignment.

Na przykład: „25A”

seatClass

string

Klasa miejsca.

Na przykład: „Economy” lub „Economy Plus”

boardingPrivilegeImage

object (Image)

Mały obraz wyświetlany nad kodem kreskowym karty pokładowej. Linie lotnicze mogą używać go do przekazywania informacji o specjalnych uprawnieniach wchodzenia na pokład. Jeśli logo programu bezpieczeństwa jest również ustawione, obraz ten może być renderowany obok logo programu bezpieczeństwa.

boardingPosition

string

Pozycja wejścia na pokład.

Na przykład: „76”.

sequenceNumber

string

Numer kolejny na karcie pokładowej. Zwykle odpowiada kolejności, w jakiej pasażerowie byli odprawiani. Linia lotnicza może używać tego numeru przy odprawie ręcznej i na przywieszkach bagażowych.

Na przykład: „49”

boardingDoor

enum (BoardingDoor)

Pole to należy ustawiać tylko wtedy, gdy wchodzenie na pokład odbywa się przez więcej niż jedno wejście i musisz wydrukować lokalizację wejścia bezpośrednio na karcie pokładowej. Większość linii lotniczych kieruje pasażerów do właściwego wejścia lub rękawa, odwołując się do wejścia/rękawa za pomocą pola seatClass. W takich przypadkach nie należy ustawiać boardingDoor.

seatAssignment

object (LocalizedString)

Przypisanie miejsca pasażera. Należy używać, gdy w seatNumber nie ma konkretnego identyfikatora.

Na przykład: „przypisane przy bramce”

BoardingDoor

Wartości w polu enum
BOARDING_DOOR_UNSPECIFIED
FRONT
front

Starsza wersja aliasu dla FRONT. Rola wycofana.

BACK
back

Starsza wersja aliasu dla BACK. Rola wycofana.

ReservationInfo

Zapis JSON
{
  "kind": string,
  "confirmationCode": string,
  "eticketNumber": string,
  "frequentFlyerInfo": {
    object (FrequentFlyerInfo)
  }
}
Pola
kind
(deprecated)

string

Określa rodzaj danego zasobu. Wartość: ustalony ciąg znaków "walletobjects#reservationInfo".

confirmationCode

string

Kod potwierdzenia potrzebny do odprawy na ten lot.

Jest to numer, który pasażer powinien wpisać w kiosku na lotnisku, aby wyszukać lot i wydrukować kartę pokładową.

eticketNumber

string

Numer biletu elektronicznego.

frequentFlyerInfo

object (FrequentFlyerInfo)

Informacje o członkostwie w programie lojalnościowym linii lotniczej.

FrequentFlyerInfo

Zapis JSON
{
  "kind": string,
  "frequentFlyerProgramName": {
    object (LocalizedString)
  },
  "frequentFlyerNumber": string
}
Pola
kind
(deprecated)

string

Określa rodzaj danego zasobu. Wartość: ustalony ciąg znaków "walletobjects#frequentFlyerInfo".

frequentFlyerProgramName

object (LocalizedString)

Nazwa programu lojalnościowego linii lotniczej, np. „Lufthansa Miles & More”

frequentFlyerNumber

string

Numer w programie lojalnościowym.

Wymagane dla każdego zagnieżdżonego obiektu rodzaju walletobjects#frequentFlyerInfo.

Metody

addmessage

Dodaje komunikat do obiektu lotu, do którego odwołuje się podany identyfikator obiektu.

get

Zwraca obiekt lotu o podanym identyfikatorze obiektu.

insert

Wstawia obiekt lotu o podanym identyfikatorze i właściwościach.

list

Zwraca listę wszystkich obiektów lotu dla podanego identyfikatora wydawcy.

patch

Aktualizuje obiekt lotu, do którego odwołuje się podany identyfikator obiektu.

update

Aktualizuje obiekt lotu, do którego odwołuje się podany identyfikator obiektu.