REST Resource: transitclass

資源：TransitClass

JSON 表示法 
{
  "transitOperatorName": {
    object (LocalizedString)
  },
  "logo": {
    object (Image)
  },
  "transitType": enum (TransitType),
  "watermark": {
    object (Image)
  },
  "languageOverride": string,
  "customTransitTerminusNameLabel": {
    object (LocalizedString)
  },
  "customTicketNumberLabel": {
    object (LocalizedString)
  },
  "customRouteRestrictionsLabel": {
    object (LocalizedString)
  },
  "customRouteRestrictionsDetailsLabel": {
    object (LocalizedString)
  },
  "customTimeRestrictionsLabel": {
    object (LocalizedString)
  },
  "customOtherRestrictionsLabel": {
    object (LocalizedString)
  },
  "customPurchaseReceiptNumberLabel": {
    object (LocalizedString)
  },
  "customConfirmationCodeLabel": {
    object (LocalizedString)
  },
  "customPurchaseFaceValueLabel": {
    object (LocalizedString)
  },
  "customPurchasePriceLabel": {
    object (LocalizedString)
  },
  "customDiscountMessageLabel": {
    object (LocalizedString)
  },
  "customCarriageLabel": {
    object (LocalizedString)
  },
  "customSeatLabel": {
    object (LocalizedString)
  },
  "customCoachLabel": {
    object (LocalizedString)
  },
  "customPlatformLabel": {
    object (LocalizedString)
  },
  "customZoneLabel": {
    object (LocalizedString)
  },
  "customFareClassLabel": {
    object (LocalizedString)
  },
  "customConcessionCategoryLabel": {
    object (LocalizedString)
  },
  "customFareNameLabel": {
    object (LocalizedString)
  },
  "classTemplateInfo": {
    object (ClassTemplateInfo)
  },
  "enableSingleLegItinerary": boolean,
  "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)
  },
  "activationOptions": {
    object (ActivationOptions)
  },
  "viewUnlockRequirement": enum (ViewUnlockRequirement),
  "wideLogo": {
    object (Image)
  },
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "appLinkData": {
    object (AppLinkData)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
欄位
transitOperatorName

object (LocalizedString)

大眾運輸業者的名稱。
transitType

enum (TransitType)

必要欄位。這個類別代表的大眾運輸類型，例如「公車」。
watermark

object (Image)

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

string

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

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

用於票價等級值 (transitObject.ticketLeg.ticketSeat.fareClass) 的自訂標籤。
customConcessionCategoryLabel

object (LocalizedString)

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

object (LocalizedString)

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

object (ClassTemplateInfo)

類別顯示方式的範本資訊。如未設定，Google 會改回顯示一組預設欄位。
enableSingleLegItinerary

boolean

控管這個類別的單段行程顯示方式。根據預設，只有含多段車程的行程會顯示行程。
id

string

必要欄位。類別的專屬 ID。這個 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 呼叫，將這個欄位設為 draft 或 underReview。一旦審查狀態從 draft 變更為其他狀態，就無法再變回 draft。

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

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

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

object (Review)

類別標示為 approved 或 rejected 時，平台所設定的審查留言。
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)

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

enum (MultipleDevicesAndHoldersAllowedStatus)

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

object (CallbackOptions)

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

object (SecurityAnimation)

安全動畫的選用資訊。如果設定此屬性，票證詳細資料上會顯示安全性動畫。
activationOptions

object (ActivationOptions)

可啟用票證的啟用選項。
viewUnlockRequirement

enum (ViewUnlockRequirement)

查看大眾運輸票券的解鎖規定選項。
notifyPreference

enum (NotificationSettingsForUpdates)

這個類別的欄位更新是否應觸發通知。設為 NOTIFY 時，我們會嘗試向使用者觸發欄位更新通知。只有在欄位屬於許可清單的一部分時，系統才會傳送這些通知給使用者。如果設為 DO_NOT_NOTIFY 或 NOTIFICATION_SETTINGS_UNSPECIFIED，系統就不會觸發通知。這項設定是暫時性的，需要在每次 PATCH 或 UPDATE 要求中設定，否則系統不會觸發通知。
valueAddedModuleData[]

object (ValueAddedModuleData)

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

TransitType

列舉
TRANSIT_TYPE_UNSPECIFIED
BUS
bus

BUS 的舊版別名，已淘汰。
RAIL
rail

RAIL 的舊版別名，已淘汰。
TRAM
tram

TRAM 的舊版別名，已淘汰。
FERRY
ferry

FERRY 的舊版別名，已淘汰。
OTHER
other

OTHER 的舊版別名，已淘汰。

ActivationOptions

類別的 ActivationOptions

JSON 表示法 
{
  "activationUrl": string,
  "allowReactivation": boolean
}
欄位
activationUrl

string

支援 REST 語意的 HTTPS 網址。可用於向合作夥伴要求啟用，但使用者觸發時能帶來價值。
allowReactivation

boolean

此標記可讓使用者透過其他裝置撥打啟用電話。這可讓用戶端顯示已啟用的啟用按鈕，即使 enableStatus 為 ACTIVATED，但要求的裝置與目前的裝置不同。

方法

addmessage

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

get

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

insert

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

list

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

patch

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

update

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