REST Resource: transitclass

Tài nguyên: TransitClass

Biểu diễn dưới dạng 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)
    }
  ]
}
Trường
transitOperatorName

object (LocalizedString)

Tên của nhà vận hành phương tiện công cộng.
transitType

enum (TransitType)

Bắt buộc. Loại phương tiện công cộng mà lớp này đại diện, chẳng hạn như "xe buýt".
watermark

object (Image)

Hình ảnh hình mờ để hiển thị trên thiết bị của người dùng.
languageOverride

string

Nếu có trường này, vé phương tiện công cộng được phân phát đến thiết bị của người dùng sẽ luôn bằng ngôn ngữ này. Biểu thị thẻ ngôn ngữ BCP 47. Ví dụ: "en-US", "en-GB", "de" hoặc "de-AT".
customTransitTerminusNameLabel

object (LocalizedString)

Nhãn tuỳ chỉnh để sử dụng cho giá trị tên nhà ga cuối (transitObject.ticketLeg.transitTerminusName).
customTicketNumberLabel

object (LocalizedString)

Nhãn tuỳ chỉnh để sử dụng cho giá trị số vé (transitObject.ticketNumber).
customRouteRestrictionsLabel

object (LocalizedString)

Nhãn tuỳ chỉnh để sử dụng cho giá trị hạn chế về lộ trình (transitObject.ticketRestrictions.routeRestrictions).
customRouteRestrictionsDetailsLabel

object (LocalizedString)

Nhãn tuỳ chỉnh để sử dụng cho giá trị chi tiết về hạn chế về lộ trình (transitObject.ticketRestrictions.routeRestrictionsDetails).
customTimeRestrictionsLabel

object (LocalizedString)

Nhãn tuỳ chỉnh để sử dụng cho giá trị chi tiết về quy định hạn chế về thời gian (transitObject.ticketRestrictions.timeRestrictions).
customOtherRestrictionsLabel

object (LocalizedString)

Nhãn tuỳ chỉnh để sử dụng cho giá trị hạn chế khác (transitObject.ticketRestrictions.otherRestrictions).
customPurchaseReceiptNumberLabel

object (LocalizedString)

Nhãn tuỳ chỉnh để sử dụng cho giá trị mã số biên lai mua hàng (transitObject.purchaseDetails.purchaseReceiptNumber).
customConfirmationCodeLabel

object (LocalizedString)

Nhãn tuỳ chỉnh để sử dụng cho giá trị mã xác nhận (transitObject.purchaseDetails.confirmationCode).
customPurchaseFaceValueLabel

object (LocalizedString)

Nhãn tuỳ chỉnh để sử dụng cho mệnh giá khi mua (transitObject.purchaseDetails.ticketCost.faceValue).
customPurchasePriceLabel

object (LocalizedString)

Nhãn tuỳ chỉnh để sử dụng cho giá mua (transitObject.purchaseDetails.ticketCost.purchasePrice).
customDiscountMessageLabel

object (LocalizedString)

Nhãn tuỳ chỉnh để sử dụng cho giá trị thông báo chiết khấu vận chuyển (transitObject.purchaseDetails.ticketCost.discountMessage).
customCarriageLabel

object (LocalizedString)

Nhãn tuỳ chỉnh để sử dụng cho giá trị vận chuyển (transitObject.ticketLeg.carriage).
customSeatLabel

object (LocalizedString)

Nhãn tuỳ chỉnh để sử dụng cho giá trị vị trí chỗ ngồi (transitObject.ticketLeg.ticketSeat.seat).
customCoachLabel

object (LocalizedString)

Nhãn tuỳ chỉnh để sử dụng cho giá trị huấn luyện viên (transitObject.ticketLeg.ticketSeat.coach).
customPlatformLabel

object (LocalizedString)

Nhãn tuỳ chỉnh để sử dụng cho giá trị của bến lên tàu (transitObject.ticketLeg.platform).
customZoneLabel

object (LocalizedString)

Nhãn tuỳ chỉnh để sử dụng cho giá trị khu vực lên máy bay (transitObject.ticketLeg.zone).
customFareClassLabel

object (LocalizedString)

Nhãn tuỳ chỉnh để sử dụng cho giá trị hạng vé (transitObject.ticketLeg.ticketSeat.fareClass).
customConcessionCategoryLabel

object (LocalizedString)

Nhãn tuỳ chỉnh để sử dụng cho giá trị danh mục đặc quyền vận chuyển (transitObject.concessionCategory).
customFareNameLabel

object (LocalizedString)

Nhãn tuỳ chỉnh để sử dụng cho giá trị tên phí đi phương tiện công cộng (transitObject.ticketLeg.fareName).
classTemplateInfo

object (ClassTemplateInfo)

Thông tin mẫu về cách hiển thị lớp. Nếu bạn không đặt giá trị, Google sẽ sử dụng một tập hợp trường mặc định để hiển thị.
enableSingleLegItinerary

boolean

Kiểm soát việc hiển thị hành trình một chặng cho lớp này. Theo mặc định, hành trình sẽ chỉ hiển thị cho các chuyến đi nhiều chặng.
id

string

Bắt buộc. Giá trị nhận dạng duy nhất của một lớp. Mã nhận dạng này phải là duy nhất trên tất cả các lớp của một tổ chức phát hành. Giá trị này phải tuân theo định dạng issuer ID.identifier, trong đó mã nhận dạng trước do Google phát hành và mã nhận dạng sau do bạn chọn. Giá trị nhận dạng duy nhất của bạn chỉ được chứa các ký tự chữ và số, dấu chấm ("."), dấu gạch dưới ("_") hoặc dấu gạch nối ("-").
version
(deprecated)

string (int64 format)

Không được dùng nữa
issuerName

string

Bắt buộc. Tên tổ chức phát hành. Độ dài tối đa đề xuất là 20 ký tự để đảm bảo chuỗi đầy đủ hiển thị trên màn hình nhỏ hơn.
messages[]

object (Message)

Một mảng thông báo hiển thị trong ứng dụng. Tất cả người dùng của đối tượng này sẽ nhận được thông báo liên quan. Số lượng tối đa của các trường này là 10.
allowMultipleUsersPerObject
(deprecated)

boolean

Không dùng nữa. Thay vào đó, hãy sử dụng multipleDevicesAndHoldersAllowedStatus.
homepageUri

object (Uri)

URI của trang chủ ứng dụng. Việc điền URI vào trường này sẽ dẫn đến hành vi giống hệt như khi điền URI vào linksModuleData (khi một đối tượng được hiển thị, một đường liên kết đến trang chủ sẽ xuất hiện trong phần thường được coi là phần linksModuleData của đối tượng).
locations[]
(deprecated)

object (LatLongPoint)

Lưu ý: Trường này hiện không được hỗ trợ để kích hoạt thông báo theo vị trí.
reviewStatus

enum (ReviewStatus)

Bắt buộc. Trạng thái của lớp. Bạn có thể đặt trường này thành draft hoặc underReview bằng cách sử dụng lệnh gọi API chèn, vá hoặc cập nhật. Sau khi thay đổi trạng thái xem xét từ draft, bạn không thể thay đổi trạng thái này về draft.

Bạn nên giữ trường này thành draft khi lớp đang được phát triển. Không thể dùng lớp draft để tạo đối tượng nào.

Bạn nên đặt trường này thành underReview khi cho rằng lớp đã sẵn sàng để sử dụng. Nền tảng sẽ tự động đặt trường này thành approved và bạn có thể sử dụng trường này ngay lập tức để tạo hoặc di chuyển các đối tượng.

Khi cập nhật một lớp đã là approved, bạn nên tiếp tục đặt trường này thành underReview.
review

object (Review)

Bình luận đánh giá do nền tảng đặt ra khi một lớp được đánh dấu là approved hoặc rejected.
infoModuleData
(deprecated)

object (InfoModuleData)

Không dùng nữa. Thay vào đó, hãy sử dụng textModulesData.
imageModulesData[]

object (ImageModuleData)

Dữ liệu mô-đun hình ảnh. Số lượng tối đa của các trường này hiển thị là 1 từ cấp đối tượng và 1 cho cấp đối tượng lớp.
textModulesData[]

object (TextModuleData)

Dữ liệu mô-đun văn bản. Nếu dữ liệu mô-đun văn bản cũng được xác định trên lớp, thì cả hai sẽ hiển thị. Số lượng tối đa của các trường này hiển thị là 10 từ đối tượng và 10 từ lớp.
redemptionIssuers[]

string (int64 format)

Xác định những đơn vị phát hành có thể sử dụng thẻ và vé qua tính năng Nhấn thông minh. Bên phát hành mã thưởng được xác định bằng mã nhận dạng bên phát hành. Bên phát hành mã thưởng phải định cấu hình ít nhất một khoá Chạm thông minh.

Bạn cũng phải thiết lập đúng cách các trường enableSmartTap và smartTapRedemptionLevel cấp đối tượng để thẻ và vé có thể hỗ trợ tính năng Chạm thông minh.
countryCode

string

Mã quốc gia dùng để hiển thị quốc gia của thẻ (khi người dùng không ở quốc gia đó), cũng như để hiển thị nội dung được bản địa hoá khi không có nội dung bằng ngôn ngữ của người dùng.
heroImage

object (Image)

Hình ảnh biểu ngữ không bắt buộc xuất hiện ở mặt trước của thẻ. Nếu không có, thì sẽ không có nội dung nào hiển thị. Hình ảnh sẽ hiển thị ở chiều rộng 100%.
wordMark
(deprecated)

object (Image)

Không dùng nữa.
enableSmartTap

boolean

Xác định xem lớp này có hỗ trợ tính năng Nhấn thông minh hay không. Bạn cũng phải thiết lập đúng cách các trường redemptionIssuers và smartTapRedemptionLevel cấp đối tượng để thẻ và vé có thể hỗ trợ tính năng Chạm thông minh.
hexBackgroundColor

string

Màu nền cho thẻ. Nếu bạn không đặt, hệ thống sẽ sử dụng màu chủ đạo của hình ảnh chính và nếu bạn không đặt hình ảnh chính, hệ thống sẽ sử dụng màu chủ đạo của biểu trưng. Định dạng là #rrggbb, trong đó rrggbb là bộ ba RGB thập lục phân, chẳng hạn như #ffcc00. Bạn cũng có thể sử dụng phiên bản viết tắt của bộ ba RGB là #rgb, chẳng hạn như #fc0.
localizedIssuerName

object (LocalizedString)

Chuỗi đã dịch cho issuerName. Độ dài tối đa đề xuất là 20 ký tự để đảm bảo chuỗi đầy đủ hiển thị trên màn hình nhỏ hơn.
multipleDevicesAndHoldersAllowedStatus

enum (MultipleDevicesAndHoldersAllowedStatus)

Xác định xem nhiều người dùng và thiết bị có lưu cùng một đối tượng tham chiếu đến lớp này hay không.
callbackOptions

object (CallbackOptions)

Các tuỳ chọn gọi lại được dùng để gọi lại phương thức phát hành cho mỗi lần người dùng cuối lưu/xoá đối tượng cho lớp này. Tất cả đối tượng của lớp này đều đủ điều kiện để gọi lại.
securityAnimation

object (SecurityAnimation)

Thông tin không bắt buộc về ảnh động bảo mật. Nếu bạn đặt giá trị này, một ảnh động bảo mật sẽ được hiển thị trên thông tin chi tiết về thẻ và vé.
activationOptions

object (ActivationOptions)

Các tuỳ chọn kích hoạt cho một vé có thể kích hoạt.
viewUnlockRequirement

enum (ViewUnlockRequirement)

Xem các lựa chọn về Yêu cầu mở khoá cho vé phương tiện công cộng.
notifyPreference

enum (NotificationSettingsForUpdates)

Liệu nội dung cập nhật trường cho lớp này có kích hoạt thông báo hay không. Khi được đặt thành NOTIFY, chúng tôi sẽ cố gắng kích hoạt thông báo cập nhật trường cho người dùng. Những thông báo này sẽ chỉ được gửi đến người dùng nếu trường đó nằm trong danh sách cho phép. Nếu bạn đặt thành DO_NOT_NOTIFY hoặc NOTIFICATION_SETTINGS_UNSPECIFIED, thì hệ thống sẽ không kích hoạt thông báo nào. Chế độ cài đặt này là tạm thời và cần được đặt với mỗi yêu cầu PATCH hoặc UPDATE, nếu không thông báo sẽ không được kích hoạt.
valueAddedModuleData[]

object (ValueAddedModuleData)

Dữ liệu mô-đun giá trị gia tăng không bắt buộc. Tối đa 10 người trong lớp. Đối với một thẻ và vé, chỉ 10 thẻ và vé sẽ hiển thị, ưu tiên những thẻ và vé từ đối tượng.

TransitType

Enum
TRANSIT_TYPE_UNSPECIFIED
BUS
bus

Bí danh cũ của BUS. Không dùng nữa.
RAIL
rail

Bí danh cũ của RAIL. Không dùng nữa.
TRAM
tram

Bí danh cũ của TRAM. Không dùng nữa.
FERRY
ferry

Bí danh cũ của FERRY. Không dùng nữa.
OTHER
other

Bí danh cũ của OTHER. Không dùng nữa.

ActivationOptions

ActivationOptions cho lớp

Biểu diễn dưới dạng JSON 
{
  "activationUrl": string,
  "allowReactivation": boolean
}
Trường
activationUrl

string

URL loại HTTPS hỗ trợ ngữ nghĩa REST. Sẽ được dùng để yêu cầu đối tác kích hoạt một giá trị nhất định do người dùng kích hoạt.
allowReactivation

boolean

Cờ để cho phép người dùng thực hiện cuộc gọi kích hoạt từ nhiều thiết bị. Điều này cho phép ứng dụng hiển thị nút kích hoạt đã bật ngay cả khi activationStatus là ACTIVATED nhưng thiết bị được yêu cầu khác với thiết bị hiện tại.

Phương thức

addmessage

 Thêm thông báo vào lớp phương tiện công cộng được tham chiếu bằng mã lớp đã cho.

get

 Trả về lớp phương tiện công cộng có mã lớp đã cho.

insert

 Chèn một lớp phương tiện công cộng có mã nhận dạng và thuộc tính đã cho.

list

 Trả về danh sách tất cả các lớp phương tiện công cộng cho một mã phát hành nhất định.

patch

 Cập nhật lớp phương tiện công cộng được tham chiếu bằng mã lớp đã cho.

update

 Cập nhật lớp phương tiện công cộng được tham chiếu bằng mã lớp đã cho.