索引
TransitClassService
(介面)TransitObjectService
(介面)PurchaseDetails
(訊息)TicketCost
(訊息)TicketLeg
(訊息)TicketRestrictions
(訊息)TicketSeat
(訊息)TicketSeat.FareClass
(列舉)TransitClass
(訊息)TransitClass.TransitType
(列舉)TransitClassAddMessageRequest
(訊息)TransitClassAddMessageResponse
(訊息)TransitClassGetRequest
(訊息)TransitClassInsertRequest
(訊息)TransitClassListRequest
(訊息)TransitClassListResponse
(訊息)TransitClassPatchRequest
(訊息)TransitClassUpdateRequest
(訊息)TransitObject
(訊息)TransitObject.ConcessionCategory
(列舉)TransitObject.PassengerType
(列舉)TransitObject.TicketStatus
(列舉)TransitObject.TripType
(列舉)TransitObjectAddMessageRequest
(訊息)TransitObjectAddMessageResponse
(訊息)TransitObjectGetRequest
(訊息)TransitObjectInsertRequest
(訊息)TransitObjectListRequest
(訊息)TransitObjectListResponse
(訊息)TransitObjectPatchRequest
(訊息)TransitObjectUpdateRequest
(訊息)
TransitClassService
AddMessage | |
---|---|
新增訊息至指定類別 ID 參照的大眾運輸類別。
|
Get | |
---|---|
傳回具有指定類別 ID 的大眾運輸類別。
|
Insert | |
---|---|
插入具有指定 ID 和屬性的大眾運輸類別。
|
List | |
---|---|
傳回指定核發機構 ID 所有大眾運輸類別的清單。
|
Patch | |
---|---|
更新指定類別 ID 參照的大眾運輸類別。這個方法支援 patch 語意。
|
Update | |
---|---|
更新指定類別 ID 參照的大眾運輸類別。
|
TransitObjectService
AddMessage | |
---|---|
在指定物件 ID 參照的大眾運輸物件中新增訊息。
|
Get | |
---|---|
傳回具有指定物件 ID 的大眾運輸物件。
|
Insert | |
---|---|
插入具有指定 ID 和屬性的大眾運輸物件。
|
List | |
---|---|
傳回指定核發機構 ID 所有大眾運輸物件的清單。
|
Patch | |
---|---|
更新指定物件 ID 參照的大眾運輸物件。這個方法支援 patch 語意。
|
Update | |
---|---|
更新指定物件 ID 參照的大眾運輸物件。
|
PurchaseDetails
欄位 | |
---|---|
purchase_receipt_number |
透過售票機構追蹤購票活動所用的收據編號/ID。 |
purchase_date_time |
票券的購買日期/時間。 日期/時間採用 ISO 8601 擴充格式 (不一定含有偏移量)。時間的精確度可以指定到奈秒。此外,即使 ISO 8601 格式並未包含時差的秒數,時差的精確度仍可指定到秒。 例如:
在沒有時差資訊的情況下,某些實用功能可能無法使用。 |
account_id |
用於購買票券之帳戶的 ID。 |
confirmation_code |
購票的確認碼。多張不同票券可能會有相同的確認碼,且可使用確認碼將票券分成一組。 |
ticket_cost |
票券費用。 |
TicketCost
欄位 | |
---|---|
face_value |
票券面額。 |
purchase_price |
票券的實際購買價格 (稅後和/或套用折扣後)。 |
discount_message |
說明所套用之任何折扣的訊息。 |
TicketLeg
欄位 | |
---|---|
origin_station_code |
出發站點代碼。如果 |
origin_name |
出發站點名稱。如果 |
destination_station_code |
目的地站點代碼。 |
destination_name |
目的地名稱。 |
departure_date_time |
出發日期/時間。如果大眾運輸物件上並未設定有效的時間間隔,則此為必填項目。 日期/時間採用 ISO 8601 擴充格式 (不一定含有偏移量)。時間的精確度可以指定到奈秒。此外,即使 ISO 8601 格式並未包含時差的秒數,時差的精確度仍可指定到秒。 例如:
不含時差的日期/時間部分會被視為「當地日期/時間」,且應是出發站點的當地日期/時間。例如,如果在 2018 年 6 月 5 日 20 時從出發站點出發,則當地日期/時間的部分應為 在沒有時差資訊的情況下,某些實用功能可能無法使用。 |
arrival_date_time |
抵達日期/時間。 日期/時間採用 ISO 8601 擴充格式 (不一定含有偏移量)。時間的精確度可以指定到奈秒。此外,即使 ISO 8601 格式並未包含時差的秒數,時差的精確度仍可指定到秒。 例如:
不含時差的日期/時間部分會被視為「當地日期/時間」,且應是目的地站點的當地日期/時間。例如,如果活動是在 2018 年 6 月 5 日 20 時於目的地站點發生,則當地日期/時間的部分應為 在沒有時差資訊的情況下,某些實用功能可能無法使用。 |
fare_name |
這段行程的票價簡短說明/名稱。例如「任何班次,單次使用」。 |
carriage |
乘客要搭乘之火車或船舶的名稱/編號。 |
platform |
乘客乘車的月台或閘門。 |
zone |
月台內的乘車區域。 |
ticket_seat |
乘客的預留座位。如果要指定多個座位,請改用 |
ticket_seats[] |
乘客的預留座位。如果僅要指定一個座位,請改用 |
transit_operator_name |
負責營運此段行程的大眾運輸業者名稱。 |
transit_terminus_name |
火車/公車等交通工具的終點站或目的地。 |
TicketRestrictions
欄位 | |
---|---|
route_restrictions |
可使用之路線的相關限制。例如,這裡的內容可能會是「僅限預訂的英國縱貫鐵路火車」此字串。 |
route_restrictions_details |
有關上述 |
time_restrictions |
此票券的使用時間相關限制。 |
other_restrictions |
不屬於「路線」或「時間」類別的其他限制。 |
TicketSeat
欄位 | |
---|---|
fare_class |
售票座位的艙等。 |
custom_fare_class |
沒有適用的 |
coach |
售票座位所在的車廂 ID,例如:「10」 |
seat |
售票座位所在位置的 ID,例如:「42」。如果沒有特定的 ID,請改用 |
seat_assignment |
乘客的座位安排。例如:「無特定座位」。使用時機為 |
FareClass
列舉 | |
---|---|
FARE_CLASS_UNSPECIFIED |
|
ECONOMY |
|
economy |
|
FIRST |
|
first |
|
BUSINESS |
|
business |
|
TransitClass
欄位 | |
---|---|
transit_operator_name |
大眾運輸業者的名稱。 |
logo |
必要項目。票券的標誌圖片。這張圖片會顯示在應用程式的卡片詳細資料檢視畫面中。 |
transit_type |
必要項目。此類別代表的大眾運輸類型,例如「公車」。 |
watermark |
要在使用者的裝置上顯示的浮水印圖片。 |
language_override |
如有這個欄位,提供給使用者裝置的大眾運輸票券將一律採用此語言。表示 BCP 47 語言標記。範例值:「en-US」、「en-GB」、「de」或「de-AT」。 |
custom_transit_terminus_name_label |
用於大眾運輸終點站名稱值 ( |
custom_ticket_number_label |
用於票券號碼值 ( |
custom_route_restrictions_label |
用於路線限制值 ( |
custom_route_restrictions_details_label |
用於路線限制詳細資料值 ( |
custom_time_restrictions_label |
用於時間限制詳細資料值 ( |
custom_other_restrictions_label |
用於其他限制值 ( |
custom_purchase_receipt_number_label |
用於購票收據號碼值 ( |
custom_confirmation_code_label |
用於確認碼值 ( |
custom_purchase_face_value_label |
用於購買面額 ( |
custom_purchase_price_label |
用於購買價格值 ( |
custom_discount_message_label |
用於大眾運輸折扣訊息值 ( |
custom_carriage_label |
用於車廂值 ( |
custom_seat_label |
用於座位位置值 ( |
custom_coach_label |
用於車廂值 ( |
custom_platform_label |
用於月台值 ( |
custom_zone_label |
用於乘車區域值 ( |
custom_fare_class_label |
用於艙等值 ( |
custom_concession_category_label |
用於大眾運輸優待票類別值 ( |
custom_fare_name_label |
用於大眾運輸票價名稱值 ( |
class_template_info |
類別顯示方式的範本資訊。如未設定,Google 會恢復為顯示一組預設的欄位。 |
enable_single_leg_itinerary |
控制這個類別之單段行程的行程資訊是否會顯示。根據預設,只有含多段行程的旅程會顯示行程資訊。 |
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 |
每當使用者儲存/刪除這個類別的物件時,可以使用這些回呼選項來回呼發卡機構。這個類別的所有物件都適用回呼功能。 |
TransitType
列舉 | |
---|---|
TRANSIT_TYPE_UNSPECIFIED |
|
BUS |
|
bus |
|
RAIL |
|
rail |
|
TRAM |
|
tram |
|
FERRY |
|
ferry |
|
OTHER |
|
other |
|
TransitClassAddMessageRequest
欄位 | |
---|---|
resource_id |
類別的專屬 ID。特定核發機構的所有類別 ID 都不得重複。這個值應依循 issuer ID.identifier 的格式,其中前者是由 Google 核發,後者則由你指定。專屬 ID 只能包含英數字元、「.」、「_」或「-」。 |
add_message_request |
要求的內容。 |
TransitClassAddMessageResponse
欄位 | |
---|---|
resource |
更新的 TransitClass 資源。 |
TransitClassGetRequest
欄位 | |
---|---|
resource_id |
類別的專屬 ID。特定核發機構的所有類別 ID 都不得重複。這個值應依循 issuer ID.identifier 的格式,其中前者是由 Google 核發,後者則由你指定。專屬 ID 只能包含英數字元、「.」、「_」或「-」。 |
TransitClassInsertRequest
欄位 | |
---|---|
resource |
要求的內容。 |
TransitClassListRequest
欄位 | |
---|---|
issuer_id |
獲授權可列出類別的核發機構 ID。 |
token |
如有指定 |
max_results |
表示清單傳回的結果數量上限。如未定義 |
TransitClassListResponse
欄位 | |
---|---|
resources[] |
與清單要求相對應的資源。 |
pagination |
回應的分頁。 |
TransitClassPatchRequest
欄位 | |
---|---|
resource_id |
類別的專屬 ID。特定核發機構的所有類別 ID 都不得重複。這個值應依循 issuer ID.identifier 的格式,其中前者是由 Google 核發,後者則由你指定。專屬 ID 只能包含英數字元、「.」、「_」或「-」。 |
resource |
要求的內容。 |
TransitClassUpdateRequest
欄位 | |
---|---|
resource_id |
類別的專屬 ID。特定核發機構的所有類別 ID 都不得重複。這個值應依循 issuer ID.identifier 的格式,其中前者是由 Google 核發,後者則由你指定。專屬 ID 只能包含英數字元、「.」、「_」或「-」。 |
resource |
要求的內容。 |
TransitObject
欄位 | |
---|---|
class_reference |
父項類別的沿用欄位副本。這類欄位是在 GET 執行期間所擷取。 |
ticket_number |
票券的編號。這是大眾運輸業者系統中的票券專屬 ID。 |
passenger_type |
乘客人數。 |
passenger_names |
指派給該票券的乘客姓名。上述 |
trip_id |
如果使用者儲存了同一趟旅程的多張票券,系統會使用此 ID 將票券分成一組。 |
ticket_status |
票券的狀態。如果狀態會影響顯示情形,請改用 |
custom_ticket_status |
|
concession_category |
票券的優待票類別。 |
custom_concession_category |
|
ticket_restrictions |
此票券的使用限制相關資訊。舉例來說,這張票券可在星期幾使用,或是可使用票券的路線。 |
purchase_details |
此票券的購票詳細資料。 |
ticket_leg |
單段票券行程,含有出發和抵達的資訊,以及搭乘資訊和座位資訊。如果要指定多段行程,請改用 |
ticket_legs[] |
每張票券可以包含一段以上的行程。每段行程都包含出發和抵達的資訊,以及搭乘資訊和座位資訊。如果僅要指定一段行程,請改用 |
hex_background_color |
卡片的背景顏色。如果未設定,將會使用主頁橫幅的主要顏色;如果未設定主頁橫幅,將會使用標誌的主要顏色。格式為 #rrggbb,其中 rrggbb 是採十六進位制的 RGB 三元組,例如 |
trip_type |
必要項目。此大眾運輸物件代表的行程類型。用來判斷出發地與目的地之間所要使用的符號。 |
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 |
合作夥伴應用程式連結的相關資訊 (選擇性)。 |
ConcessionCategory
列舉 | |
---|---|
CONCESSION_CATEGORY_UNSPECIFIED |
|
ADULT |
|
adult |
|
CHILD |
|
child |
|
SENIOR |
|
senior |
|
PassengerType
列舉 | |
---|---|
PASSENGER_TYPE_UNSPECIFIED |
|
SINGLE_PASSENGER |
|
singlePassenger |
|
MULTIPLE_PASSENGERS |
|
multiplePassengers |
|
TicketStatus
列舉 | |
---|---|
TICKET_STATUS_UNSPECIFIED |
|
USED |
|
used |
|
REFUNDED |
|
refunded |
|
EXCHANGED |
|
exchanged |
|
TripType
列舉 | |
---|---|
TRIP_TYPE_UNSPECIFIED |
|
ROUND_TRIP |
|
roundTrip |
|
ONE_WAY |
|
oneWay |
|
TransitObjectAddMessageRequest
欄位 | |
---|---|
resource_id |
物件的專屬 ID。特定核發機構的所有物件 ID 都不得重複。這個值應依循 issuer ID.identifier 的格式,其中前者是由 Google 核發,後者則由你指定。專屬 ID 只能包含英數字元、「.」、「_」或「-」。 |
add_message_request |
要求的內容。 |
TransitObjectAddMessageResponse
欄位 | |
---|---|
resource |
更新的 TransitObject 資源。 |
TransitObjectGetRequest
欄位 | |
---|---|
resource_id |
物件的專屬 ID。特定核發機構的所有物件 ID 都不得重複。這個值應依循 issuer ID.identifier 的格式,其中前者是由 Google 核發,後者則由你指定。專屬 ID 只能包含英數字元、「.」、「_」或「-」。 |
TransitObjectInsertRequest
欄位 | |
---|---|
resource |
要求的內容。 |
TransitObjectListRequest
欄位 | |
---|---|
class_id |
要列出其物件的類別 ID。 |
token |
如有指定 |
max_results |
表示清單傳回的結果數量上限。如未定義 |
TransitObjectListResponse
欄位 | |
---|---|
resources[] |
與清單要求相對應的資源。 |
pagination |
回應的分頁。 |
TransitObjectPatchRequest
欄位 | |
---|---|
resource_id |
物件的專屬 ID。特定核發機構的所有物件 ID 都不得重複。這個值應依循 issuer ID.identifier 的格式,其中前者是由 Google 核發,後者則由你指定。專屬 ID 只能包含英數字元、「.」、「_」或「-」。 |
resource |
要求的內容。 |
TransitObjectUpdateRequest
欄位 | |
---|---|
resource_id |
物件的專屬 ID。特定核發機構的所有物件 ID 都不得重複。這個值應依循 issuer ID.identifier 的格式,其中前者是由 Google 核發,後者則由你指定。專屬 ID 只能包含英數字元、「.」、「_」或「-」。 |
resource |
要求的內容。 |