- Tài nguyên: TransitObject
- PassengerType
- TicketStatus
- ConcessionCategory
- TicketRestrictions
- PurchaseDetails
- TicketCost
- TicketLeg
- TicketSeat
- FareClass
- TripType
- ActivationStatus
- Trạng thái
- DeviceContext
- Phương thức
Tài nguyên: TransitObject
Biểu diễn dưới dạng JSON |
---|
{ "classReference": { object ( |
Trường | |
---|---|
classReference |
Bản sao các trường kế thừa của lớp mẹ. Các trường này được truy xuất trong quá trình GET. |
ticketNumber |
Số vé. Đây là giá trị nhận dạng duy nhất của vé trong hệ thống của nhà vận hành phương tiện công cộng. |
passengerType |
Số lượng hành khách. |
passengerNames |
Tên của hành khách được chỉ định vé. Trường |
tripId |
Mã này được dùng để nhóm các vé lại với nhau nếu người dùng đã lưu nhiều vé cho cùng một chuyến đi. |
ticketStatus |
Trạng thái của phiếu yêu cầu hỗ trợ. Đối với các trạng thái ảnh hưởng đến việc hiển thị, hãy sử dụng trường |
customTicketStatus |
Trạng thái tuỳ chỉnh để dùng cho giá trị trạng thái của phiếu yêu cầu hỗ trợ khi |
concessionCategory |
Danh mục giảm giá của vé. |
customConcessionCategory |
Một danh mục giảm giá tuỳ chỉnh để sử dụng khi |
ticketRestrictions |
Thông tin về những loại quy định hạn chế đối với việc sử dụng phiếu yêu cầu hỗ trợ này. Ví dụ: bạn phải sử dụng thông tin vào những ngày nào trong tuần hoặc những tuyến đường được phép sử dụng. |
purchaseDetails |
Thông tin chi tiết về việc mua vé này. |
ticketLeg |
Một chặng vé chứa thông tin về thời gian khởi hành và thời gian đến cùng với thông tin lên máy bay và chỗ ngồi. Nếu chỉ định nhiều chặng, hãy sử dụng trường |
ticketLegs[] |
Mỗi vé có thể chứa một hoặc nhiều chặng. Mỗi chặng chứa thông tin về điểm khởi hành và điểm đến cùng với thông tin lên máy bay và chỗ ngồi. Nếu chỉ định một chân, hãy sử dụng trường |
hexBackgroundColor |
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 hex RGB, chẳng hạn như |
tripType |
Bắt buộc. Loại chuyến đi mà đối tượng phương tiện này đại diện. Dùng để xác định tiêu đề của thẻ và/hoặc ký hiệu cần sử dụng giữa điểm khởi hành và điểm đến. |
id |
Bắt buộc. Giá trị nhận dạng duy nhất của một đối tượng. Mã nhận dạng này phải là duy nhất trên tất cả các đối tượ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 chỉ được bao gồm ký tự chữ-số, ".", "_" hoặc "-". |
classId |
Bắt buộc. Lớp liên kết với đối tượng này. Lớp phải cùng loại với đối tượng này, phải tồn tại và phải được phê duyệt. Mã lớp phải 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. |
version |
Không được dùng nữa |
state |
Bắt buộc. Trạng thái của đối tượng. Trường này được dùng để xác định cách một đối tượng xuất hiện trong ứng dụng. Ví dụ: một đối tượng |
barcode |
Loại và giá trị mã vạch. |
messages[] |
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. |
validTimeInterval |
Khoảng thời gian đối tượng này sẽ là |
locations[] |
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ý. |
hasUsers |
Cho biết đối tượng có người dùng hay không. Trường này là do nền tảng thiết lập. |
smartTapRedemptionValue |
Giá trị sẽ được truyền đến một thiết bị đầu cuối được chứng nhận bằng tính năng Chạm thông minh qua NFC đối với vật thể này. Bạn cũng phải thiết lập chính xác các trường cấp lớp |
hasLinkedDevice |
Liệu đối tượng này hiện có liên kết với một thiết bị nào hay không. Trường này do nền tảng đặt khi người dùng lưu đối tượng, liên kết đối tượng đó với thiết bị của họ. Dành cho một số đối tác chọn lọc sử dụng. Hãy liên hệ với nhóm hỗ trợ để biết thêm thông tin. |
disableExpirationNotification |
Cho biết liệu có cần chặn thông báo một cách rõ ràng hay không. Nếu bạn đặt trường này thành true, thì thông báo hết hạn cho người dùng sẽ bị chặn, bất kể trường Hiện tại, bạn chỉ có thể đặt chế độ cài đặt này cho các mặt hàng. |
infoModuleData |
Không dùng nữa. Thay vào đó, hãy sử dụng textModulesData. |
imageModulesData[] |
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[] |
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. |
linksModuleData |
Liên kết dữ liệu mô-đun. Nếu dữ liệu mô-đun đường liên kết cũng được xác định trong lớp này, thì cả hai đều sẽ hiển thị. |
appLinkData |
Đường liên kết đến trang web hoặc ứng dụng (không bắt buộc) sẽ xuất hiện dưới dạng một nút ở mặt trước của thẻ và vé. Nếu AppLinkData được cung cấp cho đối tượng lớp tương ứng, thì chỉ có AppLinkData sẽ xuất hiện. |
activationStatus |
Trạng thái kích hoạt của đối tượng. Bắt buộc nếu lớp này đã được đặt |
rotatingBarcode |
Giá trị và loại mã vạch xoay vòng. |
deviceContext |
Bối cảnh của thiết bị liên kết với đối tượng. |
heroImage |
Ả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ó lớp nào, hình ảnh chính của lớp (nếu có) sẽ xuất hiện. Nếu cũng không có hình ảnh chính của lớp, thì sẽ không có nội dung nào hiển thị. |
groupingInfo |
Thông tin kiểm soát cách nhóm thẻ và vé lại với nhau. |
passConstraints |
Truyền các quy tắc ràng buộc cho đối tượng. Bao gồm việc hạn chế hành vi NFC và ảnh chụp màn hình. |
saveRestrictions |
Các hạn chế đối với đối tượng cần được xác minh trước khi người dùng cố gắng lưu thẻ và vé. Xin lưu ý rằng các hạn chế này sẽ chỉ áp dụng trong thời gian tiết kiệm. Nếu các quy định hạn chế thay đổi sau khi người dùng lưu thẻ và vé, thì các hạn chế mới sẽ không áp dụng cho một thẻ và vé đã lưu. |
PassengerType
Enum | |
---|---|
PASSENGER_TYPE_UNSPECIFIED |
|
SINGLE_PASSENGER |
|
singlePassenger |
Bí danh cũ của |
MULTIPLE_PASSENGERS |
|
multiplePassengers |
Bí danh cũ của |
TicketStatus
Enum | |
---|---|
TICKET_STATUS_UNSPECIFIED |
|
USED |
|
used |
Bí danh cũ của |
REFUNDED |
|
refunded |
Bí danh cũ của |
EXCHANGED |
|
exchanged |
Bí danh cũ của |
ConcessionCategory
Enum | |
---|---|
CONCESSION_CATEGORY_UNSPECIFIED |
|
ADULT |
|
adult |
Bí danh cũ của |
CHILD |
|
child |
Bí danh cũ của |
SENIOR |
|
senior |
Bí danh cũ của |
TicketRestrictions
Biểu diễn dưới dạng JSON |
---|
{ "routeRestrictions": { object ( |
Trường | |
---|---|
routeRestrictions |
Quy định hạn chế về các tuyến đường có thể đi. Ví dụ: đây có thể là chuỗi "Chỉ các chuyến tàu xuyên quốc gia dành riêng". |
routeRestrictionsDetails |
Thông tin chi tiết về |
timeRestrictions |
Quy định hạn chế về thời gian có thể sử dụng vé này. |
otherRestrictions |
Các hạn chế bổ sung không thuộc "tuyến đường" hoặc "thời gian" danh mục. |
PurchaseDetails
Biểu diễn dưới dạng JSON |
---|
{
"purchaseReceiptNumber": string,
"purchaseDateTime": string,
"accountId": string,
"confirmationCode": string,
"ticketCost": {
object ( |
Trường | |
---|---|
purchaseReceiptNumber |
Số biên nhận/mã nhận dạng để theo dõi việc mua vé thông qua cơ quan đã bán vé. |
purchaseDateTime |
Ngày/giờ mua vé. Đây là ngày/giờ theo định dạng mở rộng ISO 8601, có hoặc không có giá trị bù trừ. Thời gian có thể được chỉ định với độ chính xác lên đến nano giây. Có thể chỉ định giá trị chênh lệch với độ chính xác theo giây (mặc dù giây bù trừ không phải là một phần của ISO 8601). Ví dụ:
Nếu không có thông tin về mức bù trừ, một số tính năng phong phú có thể không hoạt động. |
accountId |
Mã của tài khoản dùng để mua vé. |
confirmationCode |
Mã xác nhận cho giao dịch mua. Mã này có thể giống nhau cho nhiều vé khác nhau và được dùng để nhóm các vé lại với nhau. |
ticketCost |
Giá vé. |
TicketCost
Biểu diễn dưới dạng JSON |
---|
{ "faceValue": { object ( |
Trường | |
---|---|
faceValue |
Mệnh giá vé. |
purchasePrice |
Giá mua thực tế của vé, sau thuế và/hoặc chiết khấu. |
discountMessage |
Thông báo mô tả bất kỳ loại chiết khấu nào được áp dụng. |
TicketLeg
Biểu diễn dưới dạng JSON |
---|
{ "originStationCode": string, "originName": { object ( |
Trường | |
---|---|
originStationCode |
Mã trạm gốc. Đây là yêu cầu bắt buộc nếu có |
originName |
Tên của trạm khởi hành. Đây là yêu cầu bắt buộc nếu có |
destinationStationCode |
Mã trạm đích. |
destinationName |
Tên đích đến. |
departureDateTime |
Ngày/giờ khởi hành. Đây là yêu cầu bắt buộc nếu bạn chưa đặt khoảng thời gian hợp lệ trên đối tượng chuyển tuyến. Đây là ngày/giờ theo định dạng mở rộng ISO 8601, có hoặc không có giá trị bù trừ. Thời gian có thể được chỉ định với độ chính xác lên đến nano giây. Có thể chỉ định giá trị chênh lệch với độ chính xác theo giây (mặc dù giây bù trừ không phải là một phần của ISO 8601). Ví dụ:
Phần ngày/giờ không có chênh lệch được coi là "ngày/giờ địa phương". Đây phải là ngày/giờ địa phương tại trạm khởi hành. Ví dụ: nếu chuyến khởi hành xảy ra vào giờ thứ 20 của ngày 5 tháng 6 năm 2018 tại ga đi, thì phần ngày/giờ địa phương phải là Nếu không có thông tin về mức bù trừ, một số tính năng phong phú có thể không hoạt động. |
arrivalDateTime |
Ngày/giờ đến. Đây là ngày/giờ theo định dạng mở rộng ISO 8601, có hoặc không có giá trị bù trừ. Thời gian có thể được chỉ định với độ chính xác lên đến nano giây. Có thể chỉ định giá trị chênh lệch với độ chính xác theo giây (mặc dù giây bù trừ không phải là một phần của ISO 8601). Ví dụ:
Phần ngày/giờ không có chênh lệch được coi là "ngày/giờ địa phương". Đây phải là ngày/giờ địa phương tại trạm đến. Ví dụ: nếu sự kiện xảy ra vào giờ thứ 20 của ngày 5 tháng 6 năm 2018 tại trạm đích, thì phần ngày/giờ địa phương phải là Nếu không có thông tin về mức bù trừ, một số tính năng phong phú có thể không hoạt động. |
fareName |
Nội dung mô tả ngắn/tên giá vé cho chặng đi này. Ví dụ: "Sử dụng một lần bất cứ lúc nào". |
carriage |
Tên/số tàu hoặc số tàu mà hành khách cần lên tàu. |
platform |
Sân ga hoặc cổng mà hành khách có thể lên toa. |
zone |
Khu vực lên máy bay trong sân ga. |
ticketSeat |
Ghế ngồi đã đặt trước cho(các) hành khách. Nếu có nhiều chỗ ngồi được chỉ định, hãy sử dụng trường |
ticketSeats[] |
Ghế ngồi đã đặt trước cho(các) hành khách. Nếu chỉ có một ghế được chỉ định, hãy sử dụng trường |
transitOperatorName |
Tên của đơn vị vận hành phương tiện công cộng đang vận hành chặng này của chuyến đi. |
transitTerminusName |
Ga cuối hoặc điểm đến của tàu/xe buýt/v.v. |
TicketSeat
Biểu diễn dưới dạng JSON |
---|
{ "fareClass": enum ( |
Trường | |
---|---|
fareClass |
Hạng vé của chỗ ngồi có bán vé. |
customFareClass |
Một hạng vé tuỳ chỉnh sẽ được sử dụng nếu không có |
coach |
Giá trị nhận dạng của toa tàu hoặc toa tàu có chỗ ngồi có bán vé. Ví dụ: "10" |
seat |
Giá trị nhận dạng của chỗ ngồi có bán vé. Ví dụ: "42". Nếu không có giá trị nhận dạng cụ thể, hãy sử dụng |
seatAssignment |
Ghế ngồi cho hành khách. Ví dụ: "không có ghế ngồi cụ thể". Được sử dụng khi không có giá trị nhận dạng cụ thể để sử dụng trong |
FareClass
Enum | |
---|---|
FARE_CLASS_UNSPECIFIED |
|
ECONOMY |
|
economy |
Bí danh cũ của |
FIRST |
|
first |
Bí danh cũ của |
BUSINESS |
|
business |
Bí danh cũ của |
TripType
Enum | |
---|---|
TRIP_TYPE_UNSPECIFIED |
|
ROUND_TRIP |
|
roundTrip |
Bí danh cũ của |
ONE_WAY |
|
oneWay |
Bí danh cũ của |
ActivationStatus
Trạng thái kích hoạt của đối tượng. Trường này bao gồm trạng thái kích hoạt nếu có giá trị hỗ trợ kích hoạt.
Biểu diễn dưới dạng JSON |
---|
{
"state": enum ( |
Trường | |
---|---|
state |
|
Tiểu bang
Enum | |
---|---|
UNKNOWN_STATE |
|
NOT_ACTIVATED |
Chưa được kích hoạt, đây là trạng thái mặc định |
not_activated |
Bí danh cũ của |
ACTIVATED |
Kích hoạt |
activated |
Bí danh cũ của |
DeviceContext
Bối cảnh của thiết bị liên kết với đối tượng.
Biểu diễn dưới dạng JSON |
---|
{ "deviceToken": string } |
Trường | |
---|---|
deviceToken |
Nếu bạn đặt chính sách này, thông tin về việc đổi thưởng sẽ chỉ được trả về thiết bị đã cho khi bạn kích hoạt đối tượng. Bạn không nên sử dụng giá trị này làm giá trị nhận dạng ổn định để theo dõi thiết bị của người dùng. Nó có thể thay đổi giữa các thẻ và vé khác nhau cho cùng một thiết bị hoặc thậm chí trong các lần kích hoạt khác nhau cho cùng một thiết bị. Khi đặt giá trị này, phương thức gọi cũng phải đặt hasLinkedDevice trên đối tượng đang được kích hoạt. |
Phương thức |
|
---|---|
|
Thêm thông báo vào đối tượng truyền tải được tham chiếu theo mã đối tượng đã cho. |
|
Trả về đối tượng chuyển tuyến có mã đối tượng đã cho. |
|
Chèn một đối tượng chuyển tuyến có mã nhận dạng và các thuộc tính đã cho. |
|
Trả về danh sách tất cả các đối tượng chuyển tuyến cho một mã nhà phát hành cụ thể. |
|
Cập nhật đối tượng truyền tải được tham chiếu theo mã đối tượng đã cho. |
|
Cập nhật đối tượng truyền tải được tham chiếu theo mã đối tượng đã cho. |