REST Resource: flightclass

資源:FlightClass

JSON 表示法
{
  "kind": string,
  "localScheduledDepartureDateTime": string,
  "localEstimatedOrActualDepartureDateTime": string,
  "localBoardingDateTime": string,
  "localScheduledArrivalDateTime": string,
  "localEstimatedOrActualArrivalDateTime": string,
  "flightHeader": {
    object (FlightHeader)
  },
  "origin": {
    object (AirportInfo)
  },
  "destination": {
    object (AirportInfo)
  },
  "flightStatus": enum (FlightStatus),
  "boardingAndSeatingPolicy": {
    object (BoardingAndSeatingPolicy)
  },
  "localGateClosingDateTime": string,
  "classTemplateInfo": {
    object (ClassTemplateInfo)
  },
  "languageOverride": string,
  "id": string,
  "version": string,
  "issuerName": string,
  "messages": [
    {
      object (Message)
    }
  ],
  "allowMultipleUsersPerObject": boolean,
  "homepageUri": {
    object (Uri)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "reviewStatus": enum (ReviewStatus),
  "review": {
    object (Review)
  },
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "redemptionIssuers": [
    string
  ],
  "countryCode": string,
  "heroImage": {
    object (Image)
  },
  "wordMark": {
    object (Image)
  },
  "enableSmartTap": boolean,
  "hexBackgroundColor": string,
  "localizedIssuerName": {
    object (LocalizedString)
  },
  "multipleDevicesAndHoldersAllowedStatus": enum (MultipleDevicesAndHoldersAllowedStatus),
  "callbackOptions": {
    object (CallbackOptions)
  },
  "securityAnimation": {
    object (SecurityAnimation)
  },
  "viewUnlockRequirement": enum (ViewUnlockRequirement),
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "appLinkData": {
    object (AppLinkData)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
欄位
kind
(deprecated)

string

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

localScheduledDepartureDateTime

string

必要欄位。飛機離開登機門 (而非跑道) 的表定日期和時間

注意:這個欄位不應過於接近出發時間。如要更新起飛時間 (例如發生延誤情況),請設定 localEstimatedOrActualDepartureDateTime

日期/時間採用 ISO 8601 擴充格式 (不含偏移量)。時間的精確度可以指定到毫秒。

例如:2027-03-05T06:30:00

這是機場的當地日期/時間 (並非世界標準時間)。

如果提供世界標準時間時差,Google 會拒絕這項要求。Google 會根據啟程的機場計算時區。

localEstimatedOrActualDepartureDateTime

string

飛機離開登機門的預定時間,或飛機實際從登機門離開的時間。請注意:這個值與跑道時間不同。

如果符合以下其中一項條件,就必須設定這個欄位:

  • 時間與表定時間不同。Google 會使用這個值來計算延誤時間。
  • 飛機已離開登機門。飛機實際起飛時,Google 會使用這個值來通知使用者。

日期/時間採用 ISO 8601 擴充格式 (不含時差)。時間的精確度可以指定到毫秒。

例如:2027-03-05T06:30:00

這是機場的當地日期/時間 (並非世界標準時間)。

如果提供世界標準時間偏移量,Google 將拒絕這項要求。Google 會根據啟程的機場計算時區。

localBoardingDateTime

string

登機證上列出的登機時間。

日期/時間採用 ISO 8601 擴充格式 (不含時差)。時間的精確度可以指定到毫秒。

例如:2027-03-05T06:30:00

這是機場的當地日期/時間 (並非世界標準時間)。

如果提供世界標準時間時差,Google 會拒絕這項要求。Google 會根據啟程的機場計算時區。

localScheduledArrivalDateTime

string

飛機抵達目的地登機門 (而非跑道) 的表定時間。

注意:這個欄位不應過於接近起飛時間。如要更新起飛時間 (例如發生延誤情況),請設定 localEstimatedOrActualArrivalDateTime

日期/時間採用 ISO 8601 擴充格式 (不含偏移量)。時間的精確度可以指定到毫秒。

例如:2027-03-05T06:30:00

這是機場的當地日期/時間 (並非世界標準時間)。

如果提供世界標準時間偏移量,Google 會拒絕這項要求。Google 會根據抵達的機場計算時區。

localEstimatedOrActualArrivalDateTime

string

飛機抵達目的地登機門 (而非跑道) 的預定日期和時間。

如果符合下列其中一種或多種情況,請設定這個欄位:

  • 時間與表定時間不同。Google 會使用這個值來計算延誤時間。
  • 飛機已抵達登機門。Google 會使用這個值來通知使用者航班已抵達登機門。

日期/時間採用 ISO 8601 擴充格式 (不含時差)。時間的精確度可以指定到毫秒。

例如:2027-03-05T06:30:00

這是機場的當地日期/時間 (並非世界標準時間)。

如果提供世界標準時間偏移量,Google 會拒絕這項要求。Google 會根據抵達的機場計算時區。

flightHeader

object (FlightHeader)

必要欄位。航班所屬航空公司和航班編號的相關資訊。

origin

object (AirportInfo)

必要欄位。出發地機場。

destination

object (AirportInfo)

必要欄位。目的地機場。

flightStatus

enum (FlightStatus)

這個航班的狀態。

如果未設定這個值,Google 會根據 FlightStats 等其他來源提供的資料決定航班狀態。

注意:API 回應中不會傳回 Google 決定的狀態值。

boardingAndSeatingPolicy

object (BoardingAndSeatingPolicy)

登機和座位政策。這類值會說明要向使用者顯示哪些標籤。

localGateClosingDateTime

string

登機證上列出的登機門關閉時間。如果不想在登機證上列出此資訊,請勿設定這個欄位。

日期/時間採用 ISO 8601 擴充格式 (不含偏移量)。時間的精確度可以指定到毫秒。

例如:2027-03-05T06:30:00

這是機場的當地日期/時間 (並非世界標準時間)。

如果提供世界標準時間偏移量,Google 將拒絕這項要求。Google 會根據啟程的機場計算時區。

classTemplateInfo

object (ClassTemplateInfo)

類別顯示方式的範本資訊。如未設定,Google 會恢復為顯示一組預設的欄位。

languageOverride

string

如有這個欄位,顯示於使用者裝置的登機證將一律採用此語言。表示 BCP 47 語言標記。範例值:「en-US」、「en-GB」、「de」或「de-AT」。

id

string

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

version
(deprecated)

string (int64 format)

已淘汰

issuerName

string

必要欄位。發卡機構名稱。建議長度上限為 20 個字元,以確保在較小的螢幕上可顯示完整字串。

messages[]

object (Message)

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

allowMultipleUsersPerObject
(deprecated)

boolean

已淘汰,請改用 multipleDevicesAndHoldersAllowedStatus

homepageUri

object (Uri)

應用程式首頁的 URI。在這個欄位填入 URI 所產生的行為與在 linksModuleData 填入 URI 相同 (顯示物件時,首頁的連結會顯示在通常視為物件 linksModuleData 區段的地方)。

locations[]
(deprecated)

object (LatLongPoint)

注意:這個欄位目前不支援觸發地理通知。

reviewStatus

enum (ReviewStatus)

必要欄位。課程的狀態。可以透過插入、修補或更新 API 呼叫的方式,將這個欄位設為 draftunderReview。一旦審查狀態從 draft 變更為其他狀態,就無法再變回 draft

類別仍在開發階段時,這個欄位應維持 draftdraft 類別無法用於建立任何物件。

如果您確認類別可供使用,應將此欄位設為 underReview。平台會自動將此欄位設為 approved,這樣就能立即用以建立或遷移物件。

更新已處於 approved 的類別時,請繼續將這個欄位設為 underReview

review

object (Review)

類別標示為 approvedrejected 時,平台所設定的審查留言。

infoModuleData
(deprecated)

object (InfoModuleData)

已淘汰,請改用 textModulesData。

imageModulesData[]

object (ImageModuleData)

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

textModulesData[]

object (TextModuleData)

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

redemptionIssuers[]

string (int64 format)

指出哪些兌換核發機構可透過智慧感應功能兌換票證。票證兌換機構 ID 可用於辨識票證兌換機構。兌換發放者必須設定至少一個智慧輕觸按鍵。

enableSmartTap 和物件層級 smartTapRedemptionLevel 欄位也必須正確設定,才能讓票證支援智慧感應功能。

countryCode

string

國家/地區代碼,用於顯示卡片的國家/地區 (當使用者不在該國家/地區時),以及用於顯示本地化內容 (當沒有使用者語言代碼適用的內容時)。

heroImage

object (Image)

顯示在卡片正面的選用橫幅圖片。如果未提供,就不會顯示任何圖片。圖片會以 100% 寬度顯示。

wordMark
(deprecated)

object (Image)

已淘汰。

enableSmartTap

boolean

識別這個類別是否支援智慧感應功能。redemptionIssuers 和物件層級 smartTapRedemptionLevel 欄位也必須正確設定,才能讓票證支援智慧感應功能。

hexBackgroundColor

string

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

localizedIssuerName

object (LocalizedString)

providerName 的翻譯字串。建議長度上限為 20 個字元,以確保在較小的螢幕上可顯示完整字串。

multipleDevicesAndHoldersAllowedStatus

enum (MultipleDevicesAndHoldersAllowedStatus)

表示是否有多位使用者和多台裝置會儲存參照這個類別的相同物件。

callbackOptions

object (CallbackOptions)

使用者每次儲存/刪除這個類別的物件時,都可以使用這些回呼選項來回呼發卡機構。這個類別的所有物件都適用回呼功能。

securityAnimation

object (SecurityAnimation)

安全防護動畫的相關資訊 (選填)。如果設為此值,系統會在通行證詳細資料上顯示安全性動畫。

viewUnlockRequirement

enum (ViewUnlockRequirement)

查看登機證的「解鎖要求」選項。

notifyPreference

enum (NotificationSettingsForUpdates)

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

valueAddedModuleData[]

object (ValueAddedModuleData)

選用價值加值模組資料。每堂課最多可容納十位學生。票證中只會顯示十個票證,請從物件中優先顯示這些票證。

FlightHeader

JSON 表示法
{
  "kind": string,
  "carrier": {
    object (FlightCarrier)
  },
  "flightNumber": string,
  "operatingCarrier": {
    object (FlightCarrier)
  },
  "operatingFlightNumber": string,
  "flightNumberDisplayOverride": string
}
欄位
kind
(deprecated)

string

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

carrier

object (FlightCarrier)

航空公司的相關資訊。這是 flightHeader 的必填屬性。

flightNumber

string

航班編號 (不含 IATA 航空公司代碼)。這個欄位只能包含數字。這是 flightHeader 的必填屬性。

例如:「123」

operatingCarrier

object (FlightCarrier)

承運航空公司的相關資訊。

operatingFlightNumber

string

承運航空公司所使用的航班編號 (不含 IATA 航空公司代碼)。這個欄位只能包含數字。

例如:「234」

flightNumberDisplayOverride

string

覆寫要用於航班號碼的值。用於顯示的預設值是航空公司 +FlightNumber。如果需要向乘客顯示不同的值,請使用這個欄位覆寫預設行為。

例如:「XX1234 / YY576」

FlightCarrier

JSON 表示法
{
  "kind": string,
  "carrierIataCode": string,
  "carrierIcaoCode": string,
  "airlineName": {
    object (LocalizedString)
  },
  "airlineLogo": {
    object (Image)
  },
  "airlineAllianceLogo": {
    object (Image)
  },
  "wideAirlineLogo": {
    object (Image)
  }
}
欄位
kind
(deprecated)

string

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

carrierIataCode

string

行銷航空公司 (相對於營運航空公司) 的 IATA 航空公司代碼 (共兩個字元)。必須提供一個此種代碼或是 carrierIcaoCodecarrieroperatingCarrier 使用。

例如:瑞士國際航空公司的代碼為「LX」

carrierIcaoCode

string

銷售航空公司 (相對於承運航空公司) 的 ICAO 航空公司代碼 (共 3 個字元)。必須提供一個此種代碼或是 carrierIataCodecarrieroperatingCarrier 使用。

例如:易捷航空為「EZY」

airlineName

object (LocalizedString)

由 CarrierIataCode 指定的航空公司本地化名稱。如未設定,則會顯示 FlightClassissuerNamelocalizedIssuerName

例如:瑞士國際航空公司為「LX」

AirportInfo

JSON 表示法
{
  "kind": string,
  "airportIataCode": string,
  "terminal": string,
  "gate": string,
  "airportNameOverride": {
    object (LocalizedString)
  }
}
欄位
kind
(deprecated)

string

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

airportIataCode

string

IATA 機場代碼 (共三個字元)。這是 origindestination 的必填欄位。

例如:「SFO」

terminal

string

航廈名稱,例如:「INTL」或「I」

gate

string

登機門名稱,例如:「B59」或「59」

airportNameOverride

object (LocalizedString)

這個選填欄位會覆寫 IATA 定義的機場城市名稱。根據預設,Google 會採用已提供的 airportIataCode,並將其對應至由 IATA 定義的官方機場城市名稱。

IATA 機場城市名稱網站列出了 IATA 的官方機場城市名稱。以 IATA 代碼為「LTN」的機場為例,IATA 網站顯示的相應機場城市為「倫敦」。

如果不填入這個欄位,Google 會顯示「倫敦」。

但如果在這個欄位填入自訂名稱 (例如「倫敦魯頓機場」),則會覆寫這個值。

FlightStatus

列舉
FLIGHT_STATUS_UNSPECIFIED
SCHEDULED 航班會準時、提前或延誤起飛。
scheduled

SCHEDULED 的舊版別名,已淘汰。

ACTIVE 航班正在途中 (滑行、起飛、降落、飛行中)。
active

ACTIVE 的舊版別名,已淘汰。

LANDED 航班已在原始目的地降落。
landed

LANDED 的舊版別名,已淘汰。

CANCELLED 航班已取消。
cancelled

CANCELLED 的舊版別名,已淘汰。

REDIRECTED 航班正在飛行中,但前往的機場與原始目的地不同。
redirected

REDIRECTED 的舊版別名,已淘汰。

DIVERTED 航班已在與原始目的地不同的機場降落。
diverted

DIVERTED 的舊版別名,已淘汰。

BoardingAndSeatingPolicy

JSON 表示法
{
  "kind": string,
  "boardingPolicy": enum (BoardingPolicy),
  "seatClassPolicy": enum (SeatClassPolicy)
}
欄位
kind
(deprecated)

string

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

boardingPolicy

enum (BoardingPolicy)

表示航空公司的登機政策。如未設定,Google 會預設為 zoneBased

seatClassPolicy

enum (SeatClassPolicy)

規定系統如何顯示座位級別的座位政策。如果未設定,Google 會預設為 cabinBased

BoardingPolicy

列舉
BOARDING_POLICY_UNSPECIFIED
ZONE_BASED
zoneBased

ZONE_BASED 的舊版別名,已淘汰。

GROUP_BASED
groupBased

GROUP_BASED 的舊版別名,已淘汰。

BOARDING_POLICY_OTHER
boardingPolicyOther

BOARDING_POLICY_OTHER 的舊版別名,已淘汰。

SeatClassPolicy

列舉
SEAT_CLASS_POLICY_UNSPECIFIED
CABIN_BASED
cabinBased

CABIN_BASED 的舊版別名,已淘汰。

CLASS_BASED
classBased

CLASS_BASED 的舊版別名,已淘汰。

TIER_BASED
tierBased

TIER_BASED 的舊版別名,已淘汰。

SEAT_CLASS_POLICY_OTHER
seatClassPolicyOther

SEAT_CLASS_POLICY_OTHER 的舊版別名,已淘汰。

方法

addmessage

在指定類別 ID 參照的航班類別中新增訊息。

get

傳回含有指定類別 ID 的航班類別。

insert

插入具有指定 ID 和屬性的航班類別。

list

傳回指定核發者 ID 的所有航班類別清單。

patch

更新指定類別 ID 參照的航班類別。

update

更新指定類別 ID 參照的航班類別。