REST 資源: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)
      }
    }
欄位
kind
(deprecated)

string

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

classReference

FlightClassobject ()

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

passengerName

string

必要項目。登機證上顯示的乘客姓名。

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

boardingAndSeatingInfo

BoardingAndSeatingInfoobject ()

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

reservationInfo

ReservationInfoobject ()

必要項目。航班預訂資訊。

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

Stateenum ()

必要項目。物件的狀態。您可以使用這個欄位來設定物件在應用程式中的顯示情形。舉例來說,inactive 物件不會再顯示於 Google Pay 應用程式中。

barcode

Barcodeobject ()

條碼類型和值。

messages[]

Messageobject ()

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

validTimeInterval

TimeIntervalobject ()

這個物件處於 active 狀態且可供使用的時間範圍。如果過了這段時間範圍,物件的狀態會變成 expired

locations[]

LatLongPointobject ()

可以使用物件的位置清單。平台會使用這項資訊以觸發向使用者顯示的地理位置通知。請注意,物件中的位置會覆寫類別中的位置,類別中的位置會覆寫 Google 地方資訊 ID 中的位置。

hasUsers

boolean

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

smartTapRedemptionValue

string

僅適用於支援智慧感應功能的合作夥伴。如需其他協助,請聯絡支援小組。

hasLinkedDevice

boolean

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

disableExpirationNotification

boolean

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

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

infoModuleData

InfoModuleDataobject ()

已淘汰,請改用 textModulesData。

imageModulesData[]

ImageModuleDataobject ()

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

textModulesData[]

TextModuleDataobject ()

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

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

乘客座位的值。如果沒有專屬識別碼,請改用 seatAssignment

例如「25A」

seatClass

string

座艙級別的值。

例如:「經濟艙」或「豪華經濟艙」

boardingPrivilegeImage

Imageobject ()

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

boardingPosition

string

登機順序的值。

例如:「76」

sequenceNumber

string

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

例如:「49」

boardingDoor

BoardingDoorenum ()

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

seatAssignment

LocalizedStringobject ()

乘客的座位安排。使用時機為 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

FrequentFlyerInfoobject ()

飛行常客會員資訊。

FrequentFlyerInfo

JSON 表示法

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

string

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

frequentFlyerProgramName

LocalizedStringobject ()

飛行常客計畫名稱,例如:「Lufthansa Miles & More」

frequentFlyerNumber

string

飛行常客號碼。

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

方法

addmessage

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

get

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

insert

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

list

傳回指定核發機構 ID 所有航班物件的清單。

patch

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

update

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