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)
  }
}
Trường
transitOperatorName

object (LocalizedString)

Tên của đơn vị 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à loại này đại diện, chẳng hạn như "xe buýt".
watermark

object (Image)

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é đi phương tiện công cộng được phân phối đến thiết bị của người dùng sẽ luôn ở ngôn ngữ này. Đại diện cho thẻ ngôn ngữ BCP 47. Giá trị ví dụ là "en-US", "en-GB", "de" hoặc "de-AT".
customTransitTerminusNameLabel

object (LocalizedString)

Một nhãn tuỳ chỉnh để sử dụng cho giá trị tên của điểm cuối chuyển tuyến (transitObject.ticketLeg.transitTerminusName).
customTicketNumberLabel

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

Một nhãn tuỳ chỉnh để sử dụng cho giá trị thông tin chi tiết về quy định hạn chế về tuyến đường (transitObject.ticketRestrictions.routeRestrictionsDetails).
customTimeRestrictionsLabel

object (LocalizedString)

Một nhãn tuỳ chỉnh dùng cho giá trị thông tin chi tiết về giới hạn thời gian (transitObject.ticketRestrictions.timeRestrictions).
customOtherRestrictionsLabel

object (LocalizedString)

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

object (LocalizedString)

Một nhãn tuỳ chỉnh dùng cho giá trị số biên nhận mua hàng (transitObject.purchaseDetails.purchaseReceiptNumber).
customConfirmationCodeLabel

object (LocalizedString)

Nhãn tuỳ chỉnh 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á giao dịch mua (transitObject.purchaseDetails.ticketCost.faceValue).
customPurchasePriceLabel

object (LocalizedString)

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

object (LocalizedString)

Nhãn tuỳ chỉnh dùng cho giá trị của thông báo chiết khấu trên phương tiện công cộng (transitObject.purchaseDetails.ticketCost.discountMessage).
customCarriageLabel

object (LocalizedString)

Một nhãn tuỳ chỉnh dùng cho giá trị đầu dòng (transitObject.ticketLeg.carriage).
customSeatLabel

object (LocalizedString)

Một nhãn tùy chỉnh sử dụng cho giá trị vị trí ghế (transitObject.ticketLeg.ticketSeat.seat).
customCoachLabel

object (LocalizedString)

Một nhãn tùy 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ị nền tảng lên máy bay (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 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 ưu đãi đi phương tiện công cộng (transitObject.concessionCategory).
customFareNameLabel

object (LocalizedString)

Nhãn tuỳ chỉnh dùng cho giá trị tên giá vé đ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 trường này, Google sẽ dự phòng đến một nhóm 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 hạng 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ã này của một nhà phát hành phải là duy nhất trên tất cả các lớp. Giá trị này phải tuân theo định dạng issuer ID.identifier, trong đó mã do Google phát hành và mã sau do bạn chọn. Giá trị nhận dạng duy nhất của bạn chỉ được bao gồm ký tự chữ-số, ".", "_" hoặc "-".
version
(deprecated)

string (int64 format)

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

string

Bắt buộc. Tên nhà phát hành. Bạn nên sử dụng độ dài tối đa 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 dãy thông báo hiển thị trong ứng dụng. Tất cả người dùng đối tượng này sẽ nhận được các tin nhắn 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 trong trường này sẽ dẫn đến hành vi giống hệt như việc điền URI trong linksModuleData (khi một đối tượng được kết xuất, một đường liên kết đến trang chủ sẽ xuất hiện trong phần linksModuleData của đối tượng).
locations[]

object (LatLongPoint)

Lưu ý: Trường này hiện không được hỗ trợ để kích hoạt thông báo địa lý.
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 chèn, vá hoặc cập nhật các lệnh gọi API. Sau khi thay đổi trạng thái xem xét từ draft, bạn không thể chuyển lại về draft.

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

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

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

object (Review)

Các nhận xét về bài đánh giá do nền tảng đặt 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ác trường này được hiển thị là 1 ở 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ác trường này hiển thị là 10 trường từ đối tượng và 10 trường từ lớp.
redemptionIssuers[]

string (int64 format)

Xác định những tổ chức phát hành thẻ và vé có thể sử dụng tính năng Chạm thông minh. Nhà phát hành đổi thưởng được xác định theo mã nhà phát hành của họ. Nhà phát hành chương trình đổi thưởng phải thiết lập ít nhất một khoá Chạm thông minh.

Bạn cũng phải thiết lập chính xác các trường smartTapRedemptionLevel ở cấp đối tượng và enableSmartTap để hệ thống có thể truyền và 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 đã bản địa hoá khi nội dung không có sẵn bằng ngôn ngữ của người dùng.
heroImage

object (Image)

Ả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ó giá trị nào hiển thị thì sẽ không có gì hiển thị. Hình ảnh sẽ hiển thị với 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ợ công nghệ Chạm thông minh hay không. Bạn cũng phải thiết lập chính xác các trường smartTapRedemptionLevel ở cấp đối tượng và redemptionIssuers để hệ thống có thể truyền và 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 thiết lập màu chủ đạo của hình ảnh chính sẽ được sử dụng, còn nếu bạn không thiết lập hình ảnh chính, thì màu chủ đạo của biểu trưng sẽ được sử dụng. Định dạng là #rrggbb, trong đó rrggbb là bộ ba hệ thập lục phân RGB, 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 #rgb, chẳng hạn như #fc0.
localizedIssuerName

object (LocalizedString)

Chuỗi văn bản được dịch cho tên nhà phát hành. Bạn nên sử dụng độ dài tối đa 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 trình phát hành mỗi khi người dùng cuối lưu/xoá một đối tượng cho lớp này. Mọi đối tượng của lớp này đều đủ điều kiện để sử dụng lệnh 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 chế độ này, một ảnh động bảo mật sẽ hiển thị khi bạn truyền thông tin chi tiết.
activationOptions

object (ActivationOptions)

Các lựa chọn kích hoạt cho một phiếu yêu cầu hỗ trợ có thể kích hoạt.
viewUnlockRequirement

enum (ViewUnlockRequirement)

Xem các lựa chọn Yêu cầu mở khoá cho vé đi phương tiện công cộ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

Kích hoạt Tùy chọn 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 số giá trị có giá trị nhất định, do người dùng kích hoạt.
allowReactivation

boolean

Gắn cờ để cho phép người dùng thực hiện cuộc gọi kích hoạt từ thiết bị khác. Điều này cho phép ứng dụng khách hiển thị nút kích hoạt được bật ngay cả khi trạng thái kích hoạt là KÍCH HOẠT 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 một thông báo vào lớp chuyển tuyến được tham chiếu theo mã lớp đã cho.

get

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

insert

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

list

 Trả về danh sách tất cả các hạng phương tiện công cộng của một mã tổ chức 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 theo mã lớp nhất định.

update

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