google.walletobjects.v1.transit 套件

索引

TransitClassService

AddMessage

rpc AddMessage(TransitClassAddMessageRequest) returns (TransitClassAddMessageResponse)

新增訊息至指定類別 ID 參照的大眾運輸類別。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/wallet_object.issuer
Get

rpc Get(TransitClassGetRequest) returns (TransitClass)

傳回具有指定類別 ID 的大眾運輸類別。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/wallet_object.issuer
Insert

rpc Insert(TransitClassInsertRequest) returns (TransitClass)

插入具有指定 ID 和屬性的大眾運輸類別。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/wallet_object.issuer
List

rpc List(TransitClassListRequest) returns (TransitClassListResponse)

傳回指定核發機構 ID 所有大眾運輸類別的清單。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/wallet_object.issuer
Patch

rpc Patch(TransitClassPatchRequest) returns (TransitClass)

更新指定類別 ID 參照的大眾運輸類別。這個方法支援 patch 語意。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/wallet_object.issuer
Update

rpc Update(TransitClassUpdateRequest) returns (TransitClass)

更新指定類別 ID 參照的大眾運輸類別。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/wallet_object.issuer

TransitObjectService

AddMessage

rpc AddMessage(TransitObjectAddMessageRequest) returns (TransitObjectAddMessageResponse)

在指定物件 ID 參照的大眾運輸物件中新增訊息。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/wallet_object.issuer
Get

rpc Get(TransitObjectGetRequest) returns (TransitObject)

傳回具有指定物件 ID 的大眾運輸物件。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/wallet_object.issuer
Insert

rpc Insert(TransitObjectInsertRequest) returns (TransitObject)

插入具有指定 ID 和屬性的大眾運輸物件。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/wallet_object.issuer
List

rpc List(TransitObjectListRequest) returns (TransitObjectListResponse)

傳回指定核發機構 ID 所有大眾運輸物件的清單。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/wallet_object.issuer
Patch

rpc Patch(TransitObjectPatchRequest) returns (TransitObject)

更新指定物件 ID 參照的大眾運輸物件。這個方法支援 patch 語意。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/wallet_object.issuer
Update

rpc Update(TransitObjectUpdateRequest) returns (TransitObject)

更新指定物件 ID 參照的大眾運輸物件。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/wallet_object.issuer

PurchaseDetails

欄位
purchase_receipt_number

string

透過售票機構追蹤購票活動所用的收據編號/ID。

purchase_date_time

string

票券的購買日期/時間。

日期/時間採用 ISO 8601 擴充格式 (不一定含有偏移量)。時間的精確度可以指定到奈秒。此外,即使 ISO 8601 格式並未包含時差的秒數,時差的精確度仍可指定到秒。

例如:

1985-04-12T23:20:50.52Z 是世界標準時間 1985 年 4 月 12 日 23 時 20 分 50.52 秒。

1985-04-12T19:20:50.52-04:00 是 1985 年 4 月 12 日 19 時 20 分 50.52 秒,當地時間比世界標準時間慢 4 小時 (與上述範例為同一時間)。如果活動是在紐約舉行,則等同於美東夏令時間 (EDT)。請注意,時差可能會因當地當時是否施行日光節約時間 (或夏令時間) 而異。

1985-04-12T19:20:50.52 是 1985 年 4 月 12 日 19 時 20 分 50.52 秒,不含時差資訊。

在沒有時差資訊的情況下,某些實用功能可能無法使用。

account_id

string

用於購買票券之帳戶的 ID。

confirmation_code

string

購票的確認碼。多張不同票券可能會有相同的確認碼,且可使用確認碼將票券分成一組。

ticket_cost

TicketCost

票券費用。

TicketCost

欄位
face_value

Money

票券面額。

purchase_price

Money

票券的實際購買價格 (稅後和/或套用折扣後)。

discount_message

LocalizedString

說明所套用之任何折扣的訊息。

TicketLeg

欄位
origin_station_code

string

出發站點代碼。如果 destinationStationCode 存在,或 originName 不存在,則此為必要項目。

origin_name

LocalizedString

出發站點名稱。如果 desinationName 存在,或 originStationCode 不存在,則此為必要項目。

destination_station_code

string

目的地站點代碼。

destination_name

LocalizedString

目的地名稱。

departure_date_time

string

出發日期/時間。如果大眾運輸物件上並未設定有效的時間間隔,則此為必填項目。

日期/時間採用 ISO 8601 擴充格式 (不一定含有偏移量)。時間的精確度可以指定到奈秒。此外,即使 ISO 8601 格式並未包含時差的秒數,時差的精確度仍可指定到秒。

例如:

1985-04-12T23:20:50.52Z 是世界標準時間 1985 年 4 月 12 日 23 時 20 分 50.52 秒。

1985-04-12T19:20:50.52-04:00 是 1985 年 4 月 12 日 19 時 20 分 50.52 秒,當地時間比世界標準時間慢 4 小時 (與上述範例為同一時間)。如果活動是在紐約舉行,則等同於美東夏令時間 (EDT)。請注意,時差可能會因當地當時是否施行日光節約時間 (或夏令時間) 而異。

1985-04-12T19:20:50.52 是 1985 年 4 月 12 日 19 時 20 分 50.52 秒,不含時差資訊。

不含時差的日期/時間部分會被視為「當地日期/時間」,且應是出發站點的當地日期/時間。例如,如果在 2018 年 6 月 5 日 20 時從出發站點出發,則當地日期/時間的部分應為 2018-06-05T20:00:00。如果出發站點的當地日期/時間比世界標準時間慢 4 小時,可以加上 -04:00 的時差。

在沒有時差資訊的情況下,某些實用功能可能無法使用。

arrival_date_time

string

抵達日期/時間。

日期/時間採用 ISO 8601 擴充格式 (不一定含有偏移量)。時間的精確度可以指定到奈秒。此外,即使 ISO 8601 格式並未包含時差的秒數,時差的精確度仍可指定到秒。

例如:

1985-04-12T23:20:50.52Z 是世界標準時間 1985 年 4 月 12 日 23 時 20 分 50.52 秒。

1985-04-12T19:20:50.52-04:00 是 1985 年 4 月 12 日 19 時 20 分 50.52 秒,當地時間比世界標準時間慢 4 小時 (與上述範例為同一時間)。如果活動是在紐約舉行,則等同於美東夏令時間 (EDT)。請注意,時差可能會因當地當時是否施行日光節約時間 (或夏令時間) 而異。

1985-04-12T19:20:50.52 是 1985 年 4 月 12 日 19 時 20 分 50.52 秒,不含時差資訊。

不含時差的日期/時間部分會被視為「當地日期/時間」,且應是目的地站點的當地日期/時間。例如,如果活動是在 2018 年 6 月 5 日 20 時於目的地站點發生,則當地日期/時間的部分應為 2018-06-05T20:00:00。如果目的地站點的當地日期/時間比世界標準時間慢 4 小時,可以加上 -04:00 的時差。

在沒有時差資訊的情況下,某些實用功能可能無法使用。

fare_name

LocalizedString

這段行程的票價簡短說明/名稱。例如「任何班次,單次使用」。

carriage

string

乘客要搭乘之火車或船舶的名稱/編號。

platform

string

乘客乘車的月台或閘門。

zone

string

月台內的乘車區域。

ticket_seat

TicketSeat

乘客的預留座位。如果要指定多個座位,請改用 ticketSeats 欄位。ticketSeatticketSeats 都可不予設定。

ticket_seats[]

TicketSeat

乘客的預留座位。如果僅要指定一個座位,請改用 ticketSeat 欄位。ticketSeatticketSeats 都可不予設定。

transit_operator_name

LocalizedString

負責營運此段行程的大眾運輸業者名稱。

transit_terminus_name

LocalizedString

火車/公車等交通工具的終點站或目的地。

TicketRestrictions

欄位
route_restrictions

LocalizedString

可使用之路線的相關限制。例如,這裡的內容可能會是「僅限預訂的英國縱貫鐵路火車」此字串。

route_restrictions_details

LocalizedString

有關上述 routeRestrictions 的更多詳細資料。

time_restrictions

LocalizedString

此票券的使用時間相關限制。

other_restrictions

LocalizedString

不屬於「路線」或「時間」類別的其他限制。

TicketSeat

欄位
fare_class

FareClass

售票座位的艙等。

custom_fare_class

LocalizedString

沒有適用的 fareClass 時會採用的自訂艙等。fareClasscustomFareClass 都可不予設定。

coach

string

售票座位所在的車廂 ID,例如:「10」

seat

string

售票座位所在位置的 ID,例如:「42」。如果沒有特定的 ID,請改用 seatAssigment

seat_assignment

LocalizedString

乘客的座位安排。例如:「無特定座位」。使用時機為 seat 中沒有特定 ID 可用時。

FareClass

列舉
FARE_CLASS_UNSPECIFIED
ECONOMY
economy

ECONOMY 的舊版別名,已淘汰。

FIRST
first

FIRST 的舊版別名,已淘汰。

BUSINESS
business

BUSINESS 的舊版別名,已淘汰。

TransitClass

欄位
transit_operator_name

LocalizedString

大眾運輸業者的名稱。

transit_type

TransitType

必要項目。此類別代表的大眾運輸類型,例如「公車」。

watermark

Image

要在使用者的裝置上顯示的浮水印圖片。

language_override

string

如有這個欄位,提供給使用者裝置的大眾運輸票券將一律採用此語言。表示 BCP 47 語言標記。範例值:「en-US」、「en-GB」、「de」或「de-AT」。

custom_transit_terminus_name_label

LocalizedString

用於大眾運輸終點站名稱值 (transitObject.ticketLeg.transitTerminusName) 的自訂標籤。

custom_ticket_number_label

LocalizedString

用於票券號碼值 (transitObject.ticketNumber) 的自訂標籤。

custom_route_restrictions_label

LocalizedString

用於路線限制值 (transitObject.ticketRestrictions.routeRestrictions) 的自訂標籤。

custom_route_restrictions_details_label

LocalizedString

用於路線限制詳細資料值 (transitObject.ticketRestrictions.routeRestrictionsDetails) 的自訂標籤。

custom_time_restrictions_label

LocalizedString

用於時間限制詳細資料值 (transitObject.ticketRestrictions.timeRestrictions) 的自訂標籤。

custom_other_restrictions_label

LocalizedString

用於其他限制值 (transitObject.ticketRestrictions.otherRestrictions) 的自訂標籤。

custom_purchase_receipt_number_label

LocalizedString

用於購票收據號碼值 (transitObject.purchaseDetails.purchaseReceiptNumber) 的自訂標籤。

custom_confirmation_code_label

LocalizedString

用於確認碼值 (transitObject.purchaseDetails.confirmationCode) 的自訂標籤。

custom_purchase_face_value_label

LocalizedString

用於購買面額 (transitObject.purchaseDetails.ticketCost.faceValue) 的自訂標籤。

custom_purchase_price_label

LocalizedString

用於購買價格值 (transitObject.purchaseDetails.ticketCost.purchasePrice) 的自訂標籤。

custom_discount_message_label

LocalizedString

用於大眾運輸折扣訊息值 (transitObject.purchaseDetails.ticketCost.discountMessage) 的自訂標籤。

custom_carriage_label

LocalizedString

用於車廂值 (transitObject.ticketLeg.carriage) 的自訂標籤。

custom_seat_label

LocalizedString

用於座位位置值 (transitObject.ticketLeg.ticketSeat.seat) 的自訂標籤。

custom_coach_label

LocalizedString

用於車廂值 (transitObject.ticketLeg.ticketSeat.coach) 的自訂標籤。

custom_platform_label

LocalizedString

用於月台值 (transitObject.ticketLeg.platform) 的自訂標籤。

custom_zone_label

LocalizedString

用於乘車區域值 (transitObject.ticketLeg.zone) 的自訂標籤。

custom_fare_class_label

LocalizedString

用於艙等值 (transitObject.ticketLeg.ticketSeat.fareClass) 的自訂標籤。

custom_concession_category_label

LocalizedString

用於大眾運輸優待票類別值 (transitObject.concessionCategory) 的自訂標籤。

custom_fare_name_label

LocalizedString

用於大眾運輸票價名稱值 (transitObject.ticketLeg.fareName) 的自訂標籤。

class_template_info

ClassTemplateInfo

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

enable_single_leg_itinerary

bool

控制這個類別之單段行程的行程資訊是否會顯示。根據預設,只有含多段行程的旅程會顯示行程資訊。

id

string

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

version
(deprecated)

int64

已淘汰

issuer_name

string

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

messages[]

Message

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

allow_multiple_users_per_object
(deprecated)

bool

已淘汰,請改用 multipleDevicesAndHoldersAllowedStatus

homepage_uri

Uri

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

locations[]

LatLongPoint

review_status

ReviewStatus

必要項目。類別的狀態。可以透過 insert、patch 或 update 的 API 呼叫,將這個欄位設定為 draftunderReview。一旦審查狀態從 draft 變更為其他狀態,就無法再變回 draft

當類別處於發展階段時,這個欄位應保持為 draftdraft 類別無法用於建立任何物件。

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

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

review

Review

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

info_module_data
(deprecated)

InfoModuleData

已淘汰,請改用 textModulesData。

image_modules_data[]

ImageModuleData

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

text_modules_data[]

TextModuleData

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

redemption_issuers[]

int64

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

country_code

string

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

hero_image

Image

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

word_mark
(deprecated)

Image

已淘汰。

enable_smart_tap

bool

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

hex_background_color

string

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

localized_issuer_name

LocalizedString

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

multiple_devices_and_holders_allowed_status

MultipleDevicesAndHoldersAllowedStatus

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

callback_options

CallbackOptions

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

TransitType

列舉
TRANSIT_TYPE_UNSPECIFIED
BUS
bus

BUS 的舊版別名,已淘汰。

RAIL
rail

RAIL 的舊版別名,已淘汰。

TRAM
tram

TRAM 的舊版別名,已淘汰。

FERRY
ferry

FERRY 的舊版別名,已淘汰。

OTHER
other

OTHER 的舊版別名,已淘汰。

TransitClassAddMessageRequest

欄位
resource_id

string

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

add_message_request

AddMessageRequest

要求的內容。

TransitClassAddMessageResponse

欄位
resource

TransitClass

更新的 TransitClass 資源。

TransitClassGetRequest

欄位
resource_id

string

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

TransitClassInsertRequest

欄位
resource

TransitClass

要求的內容。

TransitClassListRequest

欄位
issuer_id

int64

獲授權可列出類別的核發機構 ID。

token

string

如有指定 maxResults,但清單中的類別數量超過 maxResults,則可使用這個項目取得下一組結果。舉例來說,如果您有包含 200 個類別的清單,且您在呼叫清單時 maxResults 是設為 20,清單則會傳回前 20 個類別和一個符記。只要在 maxResults 設為 20 的情況下使用符記再次呼叫清單,即可取得接下來的 20 個類別。

max_results

int32

表示清單傳回的結果數量上限。如未定義 maxResults,則會傳回所有結果。

TransitClassListResponse

欄位
resources[]

TransitClass

與清單要求相對應的資源。

pagination

Pagination

回應的分頁。

TransitClassPatchRequest

欄位
resource_id

string

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

resource

TransitClass

要求的內容。

TransitClassUpdateRequest

欄位
resource_id

string

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

resource

TransitClass

要求的內容。

TransitObject

欄位
class_reference

TransitClass

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

ticket_number

string

票券的編號。這是大眾運輸業者系統中的票券專屬 ID。

passenger_type

PassengerType

乘客人數。

passenger_names

string

指派給該票券的乘客姓名。上述 passengerType 欄位是用來為 Google 提供此欄位的背景資訊。

trip_id

string

如果使用者儲存了同一趟旅程的多張票券,系統會使用此 ID 將票券分成一組。

ticket_status

TicketStatus

票券的狀態。如果狀態會影響顯示情形,請改用 state 欄位。

custom_ticket_status

LocalizedString

ticketStatus 未提供正確的選項時,要用於票券狀態值的自訂狀態。ticketStatuscustomTicketStatus 都可不予設定。

concession_category

ConcessionCategory

票券的優待票類別。

custom_concession_category

LocalizedString

concessionCategory 未提供正確的選項時,要使用的自訂優待票類別。concessionCategorycustomConcessionCategory 都可不予設定。

ticket_restrictions

TicketRestrictions

此票券的使用限制相關資訊。舉例來說,這張票券可在星期幾使用,或是可使用票券的路線。

purchase_details

PurchaseDetails

此票券的購票詳細資料。

ticket_leg

TicketLeg

單段票券行程,含有出發和抵達的資訊,以及搭乘資訊和座位資訊。如果要指定多段行程,請改用 ticketLegs 欄位。ticketLegticketLegs 都可不予設定。

ticket_legs[]

TicketLeg

每張票券可以包含一段以上的行程。每段行程都包含出發和抵達的資訊,以及搭乘資訊和座位資訊。如果僅要指定一段行程,請改用 ticketLeg 欄位。ticketLegticketLegs 都可不予設定。

hex_background_color

string

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

trip_type

TripType

必要項目。此大眾運輸物件代表的行程類型。用來判斷出發地與目的地之間所要使用的符號。

id

string

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

class_id

string

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

類別 ID 應依循 issuer ID.identifier 的格式,其中前者是由 Google 核發,後者則由你指定。

version
(deprecated)

int64

已淘汰

state

State

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

barcode

Barcode

條碼類型和值。

messages[]

Message

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

valid_time_interval

TimeInterval

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

locations[]

LatLongPoint

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

has_users

bool

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

smart_tap_redemption_value

string

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

has_linked_device

bool

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

disable_expiration_notification

bool

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

目前此項目只能針對優惠進行設定。

info_module_data

InfoModuleData

已淘汰,請改用 textModulesData。

image_modules_data[]

ImageModuleData

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

text_modules_data[]

TextModuleData

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

ConcessionCategory

列舉
CONCESSION_CATEGORY_UNSPECIFIED
ADULT
adult

ADULT 的舊版別名,已淘汰。

CHILD
child

CHILD 的舊版別名,已淘汰。

SENIOR
senior

SENIOR 的舊版別名,已淘汰。

PassengerType

列舉
PASSENGER_TYPE_UNSPECIFIED
SINGLE_PASSENGER
singlePassenger

SINGLE_PASSENGER 的舊版別名,已淘汰。

MULTIPLE_PASSENGERS
multiplePassengers

MULTIPLE_PASSENGERS 的舊版別名,已淘汰。

TicketStatus

列舉
TICKET_STATUS_UNSPECIFIED
USED
used

USED 的舊版別名,已淘汰。

REFUNDED
refunded

REFUNDED 的舊版別名,已淘汰。

EXCHANGED
exchanged

EXCHANGED 的舊版別名,已淘汰。

TripType

列舉
TRIP_TYPE_UNSPECIFIED
ROUND_TRIP
roundTrip

ROUND_TRIP 的舊版別名,已淘汰。

ONE_WAY
oneWay

ONE_WAY 的舊版別名,已淘汰。

TransitObjectAddMessageRequest

欄位
resource_id

string

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

add_message_request

AddMessageRequest

要求的內容。

TransitObjectAddMessageResponse

欄位
resource

TransitObject

更新的 TransitObject 資源。

TransitObjectGetRequest

欄位
resource_id

string

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

TransitObjectInsertRequest

欄位
resource

TransitObject

要求的內容。

TransitObjectListRequest

欄位
class_id

string

要列出其物件的類別 ID。

token

string

如有指定 maxResults,但清單中的物件數量超過 maxResults,則可使用這個項目取得下一組結果。舉例來說,如果您有包含 200 個物件的清單,且您在呼叫清單時 maxResults 是設為 20,則清單會傳回前 20 個物件和一個符記。只要在 maxResults 設為 20 的情況下使用符記再次呼叫清單,即可取得接下來的 20 個物件。

max_results

int32

表示清單傳回的結果數量上限。如未定義 maxResults,則會傳回所有結果。

TransitObjectListResponse

欄位
resources[]

TransitObject

與清單要求相對應的資源。

pagination

Pagination

回應的分頁。

TransitObjectPatchRequest

欄位
resource_id

string

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

resource

TransitObject

要求的內容。

TransitObjectUpdateRequest

欄位
resource_id

string

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

resource

TransitObject

要求的內容。