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)
  },
  "appLinkData": {
    object (AppLinkData)
  }
}
Trường
transitOperatorName

object (LocalizedString)

Tên của đơn vị vận chuyển.
transitType

enum (TransitType)

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

object (Image)

Hình mờ sẽ 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át đến thiết bị của người dùng sẽ luôn sử dụng ngôn ngữ này. Đại diện cho thẻ ngôn ngữ BCP 47. Giá trị mẫu 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 phương tiện công cộng (transitObject.ticketLeg.transitTerminusName).
customTicketNumberLabel

object (LocalizedString)

Một nhãn tuỳ chỉnh để sử dụng cho giá trị số phiếu yêu cầu hỗ trợ (transitObject.ticketNumber).
customRouteRestrictionsLabel

object (LocalizedString)

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

object (LocalizedString)

Một nhãn tuỳ chỉnh dùng cho giá trị thông tin chi tiết về các 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ề các quy định hạn chế về 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 để sử dụng cho giá trị của mã số biên nhận mua hàng (transitObject.purchaseDetails.purchaseReceiptNumber).
customConfirmationCodeLabel

object (LocalizedString)

Một 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á giao dịch mua (transitObject.purchaseDetails.ticketCost.faceValue).
customPurchasePriceLabel

object (LocalizedString)

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

object (LocalizedString)

Một nhãn tuỳ chỉnh để sử dụng cho giá trị của thông báo chiết khấu khi đi phương tiện công cộng (transitObject.purchaseDetails.ticketCost.discountMessage).
customCarriageLabel

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

Một nhãn tuỳ chỉnh để sử dụng cho giá trị của nền tảng lên máy bay (transitObject.ticketLeg.platform).
customZoneLabel

object (LocalizedString)

Một nhãn tuỳ chỉnh dùng cho giá trị khu vực lên máy bay (transitObject.ticketLeg.zone).
customFareClassLabel

object (LocalizedString)

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

object (LocalizedString)

Một nhãn tuỳ chỉnh để sử dụng cho giá trị danh mục giảm giá khi đi phương tiện công cộng (transitObject.concessionCategory).
customFareNameLabel

object (LocalizedString)

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

object (ClassTemplateInfo)

Thông tin mẫu về cách lớp học sẽ hiển thị. Nếu bạn không đặt chính sách này, Google sẽ chuyển dự phòng về 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, một 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 không được trùng với tất cả các hạng của công ty phát hành. Giá trị này phải tuân theo định dạng issuer ID.identifier, trong đó mã bưu chính do Google phát hành còn 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. Độ dài tối đa được đề xuất là 20 ký tự để đảm bảo chuỗi đầy đủ hiển thị trên các 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á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 trang chủ ứng dụng của bạn. Việc điền sẵn URI trong trường này sẽ dẫn đến hành vi chính xác tương tự như đ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 ở phần thường được coi là 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 theo vị trí địa lý.
reviewStatus

enum (ReviewStatus)

Bắt buộc. Trạng thái của lớp học. 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. Khi đã thay đổi trạng thái xem xét từ draft, bạn sẽ không thể khôi phục trạng thái đó về draft.

Bạn nên giữ 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 thiết lập 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à trường này có thể được dùng ngay để tạo hoặc di chuyển đối tượng.

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

object (Review)

Các bình luận đá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 trường tối đa được hiển thị là 1 trường ở cấp đối tượng và 1 trường ở 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 này, thì cả hai đều sẽ hiển thị. Số lượng tối đa các trường này được 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 tổ chức phát hành thẻ đổi thưởng có thể sử dụng thẻ/vé qua tính năng Chạm thông minh. Công ty phát hành chương trình đổi thưởng được xác định theo mã tổ chức phát hành của họ. Tổ chức phát hành ưu đãi 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 đúng cách các trường enableSmartTap và smartTapRedemptionLevel ở cấp đối tượng để thẻ/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 đượ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)

Ả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ó dải ô, thì sẽ không có tệp nào 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 đúng cách các trường redemptionIssuers và smartTapRedemptionLevel ở cấp đối tượng để thẻ/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 đặt màu chủ đạo của hình ảnh chính, và nếu bạn không đặt 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 màu 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 là #rgb, chẳng hạn như #fc0.
localizedIssuerName

object (LocalizedString)

Các chuỗi đã được dịch choNhà phát hànhName. Độ dài tối đa được đề xuất là 20 ký tự để đảm bảo chuỗi đầy đủ hiển thị trên các 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 công ty phát hành cho mỗi lần người dùng cuối lưu/xoá một đối tượng cho lớp này. Tất cả các đối tượng của lớp này đều đủ điều kiện để thực hiện 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 giá trị này, ảnh động bảo mật sẽ hiển thị trên thông tin chi tiết của thẻ và vé.
activationOptions

object (ActivationOptions)

Các tuỳ chọn kích hoạt cho một phiếu yêu cầu hỗ trợ.
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

TriggerOptions cho lớp

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

string

URL HTTPS có hỗ trợ ngữ nghĩa REST. Sẽ được dùng để yêu cầu đối tác kích hoạt cho các mức giá trị cụ thể, 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 hiển thị nút kích hoạt đã bật ngay cả khi kích hoạtStatus được ACTIVED (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 truyền tải đượ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 sẵn.

insert

 Chèn một lớp chuyển tuyến 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 cho một mã tổ chức phát hành cụ thể.

patch

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

update

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