索引
FlightClassService
(介面)FlightObjectService
(介面)AirportInfo
(訊息)BoardingAndSeatingInfo
(訊息)BoardingAndSeatingInfo.BoardingDoor
(列舉)BoardingAndSeatingPolicy
(訊息)BoardingAndSeatingPolicy.BoardingPolicy
(列舉)BoardingAndSeatingPolicy.SeatClassPolicy
(列舉)FlightCarrier
(訊息)FlightClass
(訊息)FlightClass.FlightStatus
(列舉)FlightClassAddMessageRequest
(訊息)FlightClassAddMessageResponse
(訊息)FlightClassGetRequest
(訊息)FlightClassInsertRequest
(訊息)FlightClassListRequest
(訊息)FlightClassListResponse
(訊息)FlightClassPatchRequest
(訊息)FlightClassUpdateRequest
(訊息)FlightHeader
(訊息)FlightObject
(訊息)FlightObjectAddMessageRequest
(訊息)FlightObjectAddMessageResponse
(訊息)FlightObjectGetRequest
(訊息)FlightObjectInsertRequest
(訊息)FlightObjectListRequest
(訊息)FlightObjectListResponse
(訊息)FlightObjectPatchRequest
(訊息)FlightObjectUpdateRequest
(訊息)FrequentFlyerInfo
(訊息)ReservationInfo
(訊息)
FlightClassService
AddMessage | |
---|---|
在指定類別 ID 參照的航班類別中新增訊息。
|
Get | |
---|---|
傳回含有指定類別 ID 的航班類別。
|
Insert | |
---|---|
插入具有指定 ID 和屬性的航班類別。
|
List | |
---|---|
傳回指定核發機構 ID 的所有航班類別清單。
|
Patch | |
---|---|
更新指定類別 ID 參照的航班類別。這個方法支援 patch 語意。
|
Update | |
---|---|
更新指定類別 ID 參照的航班類別。
|
FlightObjectService
AddMessage | |
---|---|
新增訊息至指定物件 ID 參照的航班物件。
|
Get | |
---|---|
傳回具有指定物件 ID 的航班物件。
|
Insert | |
---|---|
插入具有指定 ID 和屬性的航班物件。
|
List | |
---|---|
傳回指定核發機構 ID 的所有航班物件清單。
|
Patch | |
---|---|
更新指定物件 ID 參照的航班物件。這個方法支援 patch 語意。
|
Update | |
---|---|
更新指定物件 ID 參照的航班物件。
|
AirportInfo
欄位 | |
---|---|
kind |
表示資源的種類。值:固定字串 |
airport_iata_code |
IATA 機場代碼 (共三個字元)。這是 例如:「SFO」 |
terminal |
航廈名稱,例如:「INTL」或「I」 |
gate |
登機門名稱,例如:「B59」或「59」 |
airport_name_override |
這個選填欄位會覆寫由 IATA 定義的機場城市名稱。根據預設,Google 會採用已提供的 IATA 機場城市名稱網站列出了 IATA 的官方機場城市名稱。以 IATA 代碼為「LTN」的機場為例,IATA 網站顯示的相應機場城市為「倫敦」。 如果不填入這個欄位,Google 會顯示「倫敦」。 但如果在這個欄位填入自訂名稱 (例如「倫敦魯頓機場」),則會覆寫這個值。 |
BoardingAndSeatingInfo
欄位 | |
---|---|
kind |
表示資源的種類。值:固定字串 |
boarding_group |
此乘客所屬的登機群組 (或區域) 值。 例如:「B」 這個值的標籤取決於此物件所參照之 |
seat_number |
乘客座位的值。如果沒有專屬識別碼,請改用 例如「25A」 |
seat_class |
座艙級別的值。 例如:「經濟艙」或「豪華經濟艙」 |
boarding_privilege_image |
登機條碼上方顯示的小圖片。航空公司可使用這張圖片說明任何登機特權。如果同時設定了安檢計畫的標誌,這張圖片可能會與該安檢計畫的標誌一起顯示。 |
boarding_position |
登機順序的值。 例如:「76」 |
sequence_number |
登機證的序號,通常與乘客報到的順序一致。航空公司可能會將這組號碼用於手動登機和行李標記。 例如:「49」 |
boarding_door |
只有在此航班透過多個登機門或空橋進行登機,且您想在登機證上明確提供登機門的位置時,才需要設定這個欄位。大部分的航空公司會透過在 |
seat_assignment |
乘客的座位安排。使用時機為 例如:「在登機門處安排座位」 |
BoardingDoor
列舉 | |
---|---|
BOARDING_DOOR_UNSPECIFIED |
|
FRONT |
|
front |
|
BACK |
|
back |
|
BoardingAndSeatingPolicy
欄位 | |
---|---|
kind |
表示資源的種類。值:固定字串 |
boarding_policy |
註明航空公司的登機政策。如果未設定,Google 會預設為 |
seat_class_policy |
規定系統如何顯示座位級別的座位政策。如果未設定,Google 會預設為 |
BoardingPolicy
列舉 | |
---|---|
BOARDING_POLICY_UNSPECIFIED |
|
ZONE_BASED |
|
zoneBased |
|
GROUP_BASED |
|
groupBased |
|
BOARDING_POLICY_OTHER |
|
boardingPolicyOther |
|
SeatClassPolicy
列舉 | |
---|---|
SEAT_CLASS_POLICY_UNSPECIFIED |
|
CABIN_BASED |
|
cabinBased |
|
CLASS_BASED |
|
classBased |
|
TIER_BASED |
|
tierBased |
|
SEAT_CLASS_POLICY_OTHER |
|
seatClassPolicyOther |
|
FlightCarrier
欄位 | |
---|---|
kind |
表示資源的種類。值:固定字串 |
carrier_iata_code |
銷售航空公司 (相對於承運航空公司) 的 IATA 航空公司代碼 (共兩個字元)。必須提供一個此種代碼或是 例如:瑞士國際航空公司的代碼為「LX」 |
carrier_icao_code |
銷售航空公司 (相對於承運航空公司) 的 ICAO 航空公司代碼 (共 3 個字元)。必須提供一個此種代碼或是 例如:易捷航空為「EZY」 |
airline_name |
由 carrierIataCode 指定的航空公司本地化名稱。如未設定,則會顯示 例如:瑞士國際航空公司為「LX」 |
airline_logo |
由 carrierIataCode 和 localizedAirlineName 定義的航空公司標誌。這個標誌會顯示在卡片資料檢視畫面上方。 |
airline_alliance_logo |
航空聯盟的標誌,顯示在乘客登機時掃描的 QR 圖碼上方。 |
FlightClass
欄位 | |
---|---|
kind |
表示資源的種類。值:固定字串 |
local_scheduled_departure_date_time |
必要項目。飛機離開登機門 (而非跑道) 的表定日期和時間。 注意:這個欄位不應過於接近起飛時間。如須更新起飛時間 (例如發生延誤情況),請設定 日期/時間採用 ISO 8601 擴充格式 (不含時差)。時間可以準確指定到毫秒。 範例: 這是機場的當地日期/時間 (並非世界標準時間)。 如果提供世界標準時間時差,Google 會拒絕這項要求。Google 會根據啟程的機場計算時區。 |
local_estimated_or_actual_departure_date_time |
飛機離開登機門的預定時間,或飛機實際從登機門離開的時間。注意:這個值與跑道時間不同。 如果符合下列其中一種或多種情況,請設定這個欄位:
日期/時間採用 ISO 8601 擴充格式 (不含時差)。時間可以準確指定到毫秒。 範例: 這是機場的當地日期/時間 (並非世界標準時間)。 如果提供世界標準時間時差,Google 會拒絕這項要求。Google 會根據啟程的機場計算時區。 如果未設定,Google 會根據其他來源提供的資料設定這個值。 |
local_boarding_date_time |
登機證上列出的登機時間。 日期/時間採用 ISO 8601 擴充格式 (不含時差)。時間可以準確指定到毫秒。 範例: 這是機場的當地日期/時間 (並非世界標準時間)。 如果提供世界標準時間時差,Google 會拒絕這項要求。Google 會根據啟程的機場計算時區。 如果未設定,Google 會根據其他來源提供的資料設定這個值。 |
local_scheduled_arrival_date_time |
飛機抵達目的地登機門 (而非跑道) 的表定日期和時間。 注意:這個欄位不應過於接近起飛時間。如須更新起飛時間 (例如發生延誤情況),請設定 日期/時間採用 ISO 8601 擴充格式 (不含時差)。時間可以準確指定到毫秒。 範例: 這是機場的當地日期/時間 (並非世界標準時間)。 如果提供世界標準時間時差,Google 會拒絕這項要求。Google 會根據抵達的機場計算時區。 如果未設定,Google 會根據其他來源提供的資料設定這個值。 |
local_estimated_or_actual_arrival_date_time |
飛機抵達目的地登機門 (而非跑道) 的預定日期和時間。 如果符合下列其中一種或多種情況,請設定這個欄位:
日期/時間採用 ISO 8601 擴充格式 (不含時差)。時間可以準確指定到毫秒。 範例: 這是機場的當地日期/時間 (並非世界標準時間)。 如果提供世界標準時間時差,Google 會拒絕這項要求。Google 會根據抵達的機場計算時區。 如果未設定,Google 會根據其他來源提供的資料設定這個值。 |
flight_header |
必要項目。航班所屬航空公司和航班編號的相關資訊。 |
origin |
必要項目。出發地機場。 |
destination |
必要項目。目的地機場。 |
flight_status |
航班的狀態。 如果您未設定這個值,Google 會根據 FlightStats 等其他來源提供的資料決定航班狀態。 注意:API 回應中不會傳回 Google 決定的狀態值。 |
boarding_and_seating_policy |
登機和座位政策。這類值會說明要向使用者顯示哪些標籤。 |
local_gate_closing_date_time |
登機證上列出的登機門關閉時間。如果不想在登機證上列出此資訊,請勿設定這個欄位。 日期/時間採用 ISO 8601 擴充格式 (不含時差)。時間可以準確指定到毫秒。 範例: 這是機場的當地日期/時間 (並非世界標準時間)。 如果提供世界標準時間時差,Google 會拒絕這項要求。Google 會根據啟程的機場計算時區。 |
class_template_info |
類別顯示方式的範本資訊。如未設定,Google 會恢復為顯示一組預設的欄位。 |
language_override |
如有這個欄位,顯示於使用者裝置的登機證將一律採用此語言。表示 BCP 47 語言標記。範例值:「en-US」、「en-GB」、「de」或「de-AT」。 |
id |
必要項目。類別的專屬 ID。特定核發機構的所有類別 ID 都不得重複。這個值應依循 issuer ID.identifier 的格式,其中前者是由 Google 核發,後者則由你指定。專屬 ID 只能包含英數字元、「.」、「_」或「-」。 |
version |
已淘汰 |
issuer_name |
必要項目。發卡機構名稱。建議長度上限為 20 個字元,以確保在較小的螢幕上可顯示完整字串。 |
messages[] |
應用程式中顯示的訊息陣列。這個物件的所有使用者都會收到與該物件相關聯的訊息。這類欄位的數量上限是 10 個。 |
allow_multiple_users_per_object |
已淘汰,請改用 |
homepage_uri |
應用程式首頁的 URI。在這個欄位填入 URI 所產生的行為與在 linksModuleData 填入 URI 相同 (顯示物件時,首頁的連結會顯示在通常視為物件 linksModuleData 區段的地方)。 |
locations[] |
|
review_status |
必要項目。類別的狀態。可以透過 insert、patch 或 update 的 API 呼叫,將這個欄位設定為 當類別處於發展階段時,這個欄位應保持為 如果您確認類別可供使用,則應將此欄位設為 更新已處於 |
review |
當類別被標示為 |
info_module_data |
已淘汰,請改用 textModulesData。 |
image_modules_data[] |
圖片模組資料。這類欄位的顯示數量上限為物件層級 1 個,以及類別物件層級 1 個。 |
text_modules_data[] |
文字模組資料。如果類別中也定義了文字模組資料,則兩項資料都會顯示。這類欄位的顯示數量上限為來自物件的 10 個,以及來自類別的 10 個。 |
links_module_data |
連結模組資料。如果物件中也定義了連結模組資料,則兩項資料都會顯示。 |
redemption_issuers[] |
僅適用於支援智慧感應功能的合作夥伴。如需其他協助,請聯絡支援小組。 |
country_code |
國家/地區代碼,用於顯示卡片的國家/地區 (當使用者不在該國家/地區時),以及用於顯示本地化內容 (當沒有使用者語言代碼適用的內容時)。 |
hero_image |
顯示在卡片正面的選用橫幅圖片。如果未提供,就不會顯示任何圖片。圖片會以 100% 寛度顯示。 |
word_mark |
已淘汰。 |
enable_smart_tap |
僅適用於支援智慧感應功能的合作夥伴。如需其他協助,請聯絡支援小組。 |
hex_background_color |
卡片的背景顏色。如果未設定,將會使用主頁橫幅的主要顏色;如果未設定主頁橫幅,將會使用標誌的主要顏色。格式為 #rrggbb,其中 rrggbb 是採十六進位制的 RGB 三元組,例如 |
localized_issuer_name |
issuer_name 的翻譯字串。建議長度上限為 20 個字元,以確保在較小的螢幕上可顯示完整字串。 |
multiple_devices_and_holders_allowed_status |
表示是否有多位使用者和多台裝置會儲存參照這個類別的同一個物件。 |
callback_options |
每當使用者儲存/刪除這個類別的物件時,可以使用這些回呼選項來回呼發卡機構。這個類別的所有物件都適用回呼功能。 |
FlightStatus
列舉 | |
---|---|
FLIGHT_STATUS_UNSPECIFIED |
|
SCHEDULED |
航班會準時、提前或延誤起飛。 |
scheduled |
|
ACTIVE |
航班正在途中 (滑行、起飛、降落、飛行中)。 |
active |
|
LANDED |
航班已在原始目的地降落。 |
landed |
|
CANCELLED |
航班已取消。 |
cancelled |
|
REDIRECTED |
航班正在飛行中,但前往的機場與原始目的地不同。 |
redirected |
|
DIVERTED |
航班已在與原始目的地不同的機場降落。 |
diverted |
|
FlightClassAddMessageRequest
欄位 | |
---|---|
resource_id |
類別的專屬 ID。特定核發機構的所有類別 ID 都不得重複。這個值應依循 issuer ID.identifier 的格式,其中前者是由 Google 核發,後者則由你指定。專屬 ID 只能包含英數字元、「.」、「_」或「-」。 |
add_message_request |
要求的內容。 |
FlightClassAddMessageResponse
欄位 | |
---|---|
resource |
更新過的 FlightClass 資源。 |
FlightClassGetRequest
欄位 | |
---|---|
resource_id |
類別的專屬 ID。特定核發機構的所有類別 ID 都不得重複。這個值應依循 issuer ID.identifier 的格式,其中前者是由 Google 核發,後者則由你指定。專屬 ID 只能包含英數字元、「.」、「_」或「-」。 |
FlightClassInsertRequest
欄位 | |
---|---|
resource |
要求的內容。 |
FlightClassListRequest
欄位 | |
---|---|
issuer_id |
獲授權可列出類別的核發機構 ID。 |
token |
如有指定 |
max_results |
表示清單傳回的結果數量上限。如未定義 |
FlightClassListResponse
欄位 | |
---|---|
resources[] |
與清單要求相對應的資源。 |
pagination |
回應的分頁。 |
FlightClassPatchRequest
欄位 | |
---|---|
resource_id |
類別的專屬 ID。特定核發機構的所有類別 ID 都不得重複。這個值應依循 issuer ID.identifier 的格式,其中前者是由 Google 核發,後者則由你指定。專屬 ID 只能包含英數字元、「.」、「_」或「-」。 |
resource |
要求的內容。 |
FlightClassUpdateRequest
欄位 | |
---|---|
resource_id |
類別的專屬 ID。特定核發機構的所有類別 ID 都不得重複。這個值應依循 issuer ID.identifier 的格式,其中前者是由 Google 核發,後者則由你指定。專屬 ID 只能包含英數字元、「.」、「_」或「-」。 |
resource |
要求的內容。 |
FlightHeader
欄位 | |
---|---|
kind |
表示資源的種類。值:固定字串 |
carrier |
航空公司的相關資訊。這是 |
flight_number |
航班編號 (不含 IATA 航空公司代碼)。這個欄位只能包含數字。這是 例如:「123」 |
operating_carrier |
承運航空公司的相關資訊。 |
operating_flight_number |
承運航空公司所使用的航班編號 (不含 IATA 航空公司代碼)。這個欄位只能包含數字。 例如:「234」 |
FlightObject
欄位 | |
---|---|
kind |
表示資源的種類。值:固定字串 |
class_reference |
父項類別的沿用欄位副本。這類欄位是在 GET 執行期間所擷取。 |
passenger_name |
必要項目。登機證上顯示的乘客姓名。 例如:「Dave M Gahan」、「Gahan/Dave」或「GAHAN/DAVEM」 |
boarding_and_seating_info |
有關登機和座位的乘客專屬資訊。 |
reservation_info |
必要項目。航班預訂資訊。 |
security_program_logo |
乘客適用的安檢計畫圖片。 |
hex_background_color |
卡片的背景顏色。如果未設定,將會使用主頁橫幅的主要顏色;如果未設定主頁橫幅,將會使用標誌的主要顏色。格式為 #rrggbb,其中 rrggbb 是採十六進位制的 RGB 三元組,例如 |
id |
必要項目。物件的專屬 ID。特定核發機構的所有物件 ID 都不得重複。這個值應依循 issuer ID.identifier 的格式,其中前者是由 Google 核發,後者則由你指定。專屬 ID 只能包含英數字元、「.」、「_」或「-」。 |
class_id |
必要項目。與這個物件相關聯的類別,必須是與這個物件同類型、已存在,並且經過核准的類別。 類別 ID 應依循 issuer ID.identifier 的格式,其中前者是由 Google 核發,後者則由你指定。 |
version |
已淘汰 |
state |
必要項目。物件的狀態。您可以使用這個欄位來設定物件在應用程式中的顯示情形。舉例來說, |
barcode |
條碼類型和值。 |
messages[] |
應用程式中顯示的訊息陣列。這個物件的所有使用者都會收到與該物件相關聯的訊息。這類欄位的數量上限是 10 個。 |
valid_time_interval |
這個物件處於 |
locations[] |
可以使用物件的位置清單。平台會使用這項資訊以觸發向使用者顯示的地理位置通知。請注意,物件中的位置會覆寫類別中的位置,類別中的位置會覆寫 Google 地方資訊 ID 中的位置。 |
has_users |
表示這個物件是否有使用者。這個欄位是由平台所設定。 |
smart_tap_redemption_value |
僅適用於支援智慧感應功能的合作夥伴。如需其他協助,請聯絡支援小組。 |
has_linked_device |
表示這個物件目前是否已連結至某部裝置。當使用者儲存物件以將物件連結到裝置時,平台會設定這個欄位。適用於特定合作夥伴。詳情請聯絡支援小組。 |
disable_expiration_notification |
表示是否應明確封鎖通知。如果將這個欄位設為 true,無論 目前只能針對航班/機票進行設定。 |
info_module_data |
已淘汰,請改用 textModulesData。 |
image_modules_data[] |
圖片模組資料。這類欄位的顯示數量上限為物件層級 1 個,以及類別物件層級 1 個。 |
text_modules_data[] |
文字模組資料。如果類別中也定義了文字模組資料,則兩項資料都會顯示。這類欄位的顯示數量上限為來自物件的 10 個,以及來自類別的 10 個。 |
links_module_data |
連結模組資料。如果類別中也定義了連結模組資料,則兩項資料都會顯示。 |
app_link_data |
合作夥伴應用程式連結的相關資訊 (選擇性)。 |
FlightObjectAddMessageRequest
欄位 | |
---|---|
resource_id |
物件的專屬 ID。特定核發機構的所有物件 ID 都不得重複。這個值應依循 issuer ID.identifier 的格式,其中前者是由 Google 核發,後者則由你指定。專屬 ID 只能包含英數字元、「.」、「_」或「-」。 |
add_message_request |
要求的內容。 |
FlightObjectAddMessageResponse
欄位 | |
---|---|
resource |
更新過的 FlightObject 資源。 |
FlightObjectGetRequest
欄位 | |
---|---|
resource_id |
物件的專屬 ID。特定核發機構的所有物件 ID 都不得重複。這個值應依循 issuer ID.identifier 的格式,其中前者是由 Google 核發,後者則由你指定。專屬 ID 只能包含英數字元、「.」、「_」或「-」。 |
FlightObjectInsertRequest
欄位 | |
---|---|
resource |
要求的內容。 |
FlightObjectListRequest
欄位 | |
---|---|
class_id |
要列出其物件的類別 ID。 |
token |
如有指定 |
max_results |
表示清單傳回的結果數量上限。如未定義 |
FlightObjectListResponse
欄位 | |
---|---|
resources[] |
與清單要求相對應的資源。 |
pagination |
回應的分頁。 |
FlightObjectPatchRequest
欄位 | |
---|---|
resource_id |
物件的專屬 ID。特定核發機構的所有物件 ID 都不得重複。這個值應依循 issuer ID.identifier 的格式,其中前者是由 Google 核發,後者則由你指定。專屬 ID 只能包含英數字元、「.」、「_」或「-」。 |
resource |
要求的內容。 |
FlightObjectUpdateRequest
欄位 | |
---|---|
resource_id |
物件的專屬 ID。特定核發機構的所有物件 ID 都不得重複。這個值應依循 issuer ID.identifier 的格式,其中前者是由 Google 核發,後者則由你指定。專屬 ID 只能包含英數字元、「.」、「_」或「-」。 |
resource |
要求的內容。 |
FrequentFlyerInfo
欄位 | |
---|---|
kind |
表示資源的種類。值:固定字串 |
frequent_flyer_program_name |
飛行常客計畫名稱,例如:「Lufthansa Miles & More」 |
frequent_flyer_number |
飛行常客號碼。 對每個種類為 |
ReservationInfo
欄位 | |
---|---|
kind |
表示資源的種類。值:固定字串 |
confirmation_code |
辦理此航班報到手續所需的確認碼。 乘客在機場的互動式資訊服務站查詢航班及列印登機證時,必須輸入這組號碼。 |
eticket_number |
電子機票號碼。 |
frequent_flyer_info |
飛行常客會員資訊。 |