REST Resource: flightobject

資源：FlightObject

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)
    }
  ]
}
欄位
kind
(deprecated)

string

表示資源的種類。值：固定字串 "walletobjects#flightObject"。
classReference

object (FlightClass)

父項類別的沿用欄位副本。這類欄位是在 GET 執行期間擷取。
passengerName

string

必要欄位。登機證上顯示的乘客姓名。

例如：「Dave M Gahan」、「Gahan/Dave」或「GAHAN/DAVEM」
boardingAndSeatingInfo

object (BoardingAndSeatingInfo)

有關登機和座位的乘客專屬資訊。
reservationInfo

object (ReservationInfo)

必要欄位。航班預訂資訊。
hexBackgroundColor

string

卡片的背景顏色。如果未設定，系統會使用主頁橫幅的主要顏色；如果未設定主頁橫幅，系統會使用標誌的主要顏色。格式為 #rrggbb，其中 rrggbb 是採十六進位制的 RGB 三位元組，例如 #ffcc00。您也可以使用 RGB 三元組的簡寫版本 #rgb，例如 #fc0。
id

string

必要欄位。物件的專屬 ID。特定核發機構的所有物件 ID 都不得重複。這個值應依循 issuer ID 格式。identifier 的格式，其中前者是由 Google 核發，後者則由您指定。專屬 ID 只能包含英數字元、「.」、「_」或「-」。
classId

string

必要欄位。與這個物件相關聯的類別。必須是與這個物件同類型、已存在，並且經過核准的類別。

類別 ID 應依循 issuer ID 格式。identifier 的格式，其中前者是由 Google 核發，後者則由您指定。
version
(deprecated)

string (int64 format)

已淘汰
state

enum (State)

必要欄位。物件的狀態。您可以使用這個欄位來設定物件在應用程式中的顯示情形。舉例來說，inactive 物件會移至「過期的票證」區段。
barcode

object (Barcode)

條碼類型和值。
messages[]

object (Message)

應用程式中顯示的訊息陣列。這個物件的所有使用者都會收到相關聯的訊息。這類欄位的數量上限是 10 個。
validTimeInterval

object (TimeInterval)

這個物件處於 active 狀態且可供使用的時間範圍。如果過了這段時間範圍，物件的狀態會變成 expired。
locations[]
(deprecated)

object (LatLongPoint)

注意：系統目前不支援使用這個欄位觸發地理通知。
hasUsers

boolean

表示這個物件是否有使用者。這個欄位是由平台所設定。
smartTapRedemptionValue

string

這個物件會透過 NFC 傳送至智慧感應認證感應式刷卡機的值。類別層級的欄位 enableSmartTap 和 redemptionIssuers 也必須正確設定，票證才能支援智慧感應功能。系統僅支援 ASCII 字元。
hasLinkedDevice

boolean

表示這個物件目前是否已連結至某部裝置。當使用者儲存物件以將物件連結到裝置時，平台會設定這個欄位。適用於特定合作夥伴。詳情請洽詢支援團隊。
disableExpirationNotification

boolean

表示是否應明確封鎖通知。如果將這個欄位設為 true，無論 messages 欄位的值為何，向使用者發出的到期通知都會遭封鎖。根據預設，這個欄位會設為 false。

目前只能針對航班/機票進行設定。
infoModuleData

object (InfoModuleData)

已淘汰，請改用 textModulesData。
imageModulesData[]

object (ImageModuleData)

圖片模組資料。這類欄位的顯示數量上限為物件層級 1 個，以及類別物件層級 1 個。
textModulesData[]

object (TextModuleData)

文字模組資料。如果類別中也定義了文字模組資料，則兩項資料都會顯示。這類欄位的顯示數量上限為來自物件的 10 個，以及來自類別的 10 個。
rotatingBarcode

object (RotatingBarcode)

旋轉條碼的類型和值。
heroImage

object (Image)

顯示在卡片正面的選用橫幅圖片。如果沒有，則會顯示類別的主頁橫幅 (如有)。如果類別也沒有主頁橫幅圖片，系統就不會顯示任何圖片。
groupingInfo

object (GroupingInfo)

用於控管票證分組方式的資訊。
passConstraints

object (PassConstraints)

傳遞物件的限制條件。包括限制 NFC 和螢幕截圖行為。
saveRestrictions

object (SaveRestrictions)

使用者嘗試儲存票證前，需要驗證的物件限制。請注意，這項限制只適用於節省時間。如果使用者儲存票證後，限制條件有所變更，系統不會將新限制套用至已儲存的票證。
linkedObjectIds[]

string

linkedObjectIds 是其他物件的清單，例如活動票券、會員卡、優惠、一般、禮物卡、大眾運輸和登機證，這些物件應自動附加至此航班物件。如果使用者已儲存這張登機證，系統會自動將這些 linkedObjectId 推送至使用者的錢包 (除非使用者關閉接收這類已連結票證的設定)。

請確認已插入 linkedObjectIds 中的物件，否則呼叫會失敗。連結一經建立，就無法取消連結。您無法連結屬於其他發卡機構的物件。單一物件可連結的物件數量有限。達到上限後，系統會以無通知的方式忽略呼叫中的新連結物件。

物件 ID 應採用 issuer ID 格式。identifier 的格式，其中前者是由 Google 核發，後者則由您指定。
notifyPreference

enum (NotificationSettingsForUpdates)

此物件的欄位更新是否應觸發通知。如果設為 NOTIFY，我們會嘗試觸發向使用者發出欄位更新通知。只有在欄位屬於許可清單的一部分時，系統才會傳送這些通知給使用者。如果設為 DO_NOT_NOTIFY 或 NOTIFICATION_SETTINGS_UNSPECIFIED，系統就不會觸發通知。這是暫時性的設定，且必須為每個 PATCH 或 UPDATE 要求進行設置，否則不會觸發通知。
valueAddedModuleData[]

object (ValueAddedModuleData)

選用價值加值模組資料。物件上最多可有十個。

BoardingAndSeatingInfo

JSON 表示法 
{
  "kind": string,
  "boardingGroup": string,
  "seatNumber": string,
  "seatClass": string,
  "boardingPrivilegeImage": {
    object (Image)
  },
  "boardingPosition": string,
  "sequenceNumber": string,
  "boardingDoor": enum (BoardingDoor),
  "seatAssignment": {
    object (LocalizedString)
  }
}
欄位
kind
(deprecated)

string

表示資源的種類。值：固定字串 "walletobjects#boardingAndSeatingInfo"。
boardingGroup

string

此乘客所屬的登機群組 (或區域) 值。

例如：「B」

這個值的標籤取決於此物件參照的 flightClass 所含的 boardingPolicy 欄位。
seatNumber

string

乘客座位的值。如果沒有特定的 ID，請改用 seatAssignment。

例如：「25A」
seatClass

string

座艙級別的值。

例如：「經濟艙」或「豪華經濟艙」
boardingPrivilegeImage

object (Image)

登機條碼上方顯示的小圖片。航空公司可使用這張圖片說明任何登機特權。如果同時設定了安檢計畫的標誌，這張圖片可能會與該安檢計畫的標誌一起顯示。
boardingPosition

string

登機位置的值。

例如：「76」
sequenceNumber

string

登機證的序號。通常與乘客報到的順序一致。航空公司可能會將這組號碼用於手動登機和行李標記。

例如：「49」
boardingDoor

enum (BoardingDoor)

只有在此航班透過多個登機門或空橋進行登機，且您想在登機證上明確提供登機門的位置時，才需要設定這個欄位。大部分的航空公司會透過在 seatClass 旁顯示登機門/空橋來告訴乘客正確的登機門或空橋，引導乘客順利登機。在這類情況下，請不要設定 boardingDoor。
seatAssignment

object (LocalizedString)

乘客的座位安排。使用時機為 seatNumber 中沒有特定 ID 可用時。

例如：「在登機門處安排座位」

BoardingDoor

列舉
BOARDING_DOOR_UNSPECIFIED
FRONT
front

FRONT 的舊版別名，已淘汰。
BACK
back

BACK 的舊版別名，已淘汰。

ReservationInfo

JSON 表示法 
{
  "kind": string,
  "confirmationCode": string,
  "eticketNumber": string,
  "frequentFlyerInfo": {
    object (FrequentFlyerInfo)
  }
}
欄位
kind
(deprecated)

string

表示資源的種類。值：固定字串 "walletobjects#reservationInfo"。
confirmationCode

string

辦理此航班報到手續所需的確認碼。

乘客在機場的互動式資訊服務站查詢航班及列印登機證時，必須輸入這組號碼。
eticketNumber

string

電子機票號碼。
frequentFlyerInfo

object (FrequentFlyerInfo)

飛行常客會員資訊。

FrequentFlyerInfo

JSON 表示法 
{
  "kind": string,
  "frequentFlyerProgramName": {
    object (LocalizedString)
  },
  "frequentFlyerNumber": string
}
欄位
kind
(deprecated)

string

表示資源的種類。值：固定字串 "walletobjects#frequentFlyerInfo"。
frequentFlyerProgramName

object (LocalizedString)

飛行常客計畫名稱，例如：「Lufthansa Miles & More」
frequentFlyerNumber

string

飛行常客號碼。

對每個種類為 walletobjects#frequentFlyerInfo 的巢狀物件而言為必要欄位。

方法

addmessage

 新增訊息至指定物件 ID 參照的航班物件。

get

 傳回具有指定物件 ID 的航班物件。

insert

 插入具有指定 ID 和屬性的航班物件。

list

 傳回指定發卡機構 ID 的完整航班物件清單。

patch

 更新指定物件 ID 參照的航班物件。

update

 更新指定物件 ID 參照的航班物件。