- Tài nguyên: TransitObject (Tài nguyên):
- 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ủa 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 đơn vị 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 những 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 màn hình, hãy sử dụng trường |
customTicketStatus |
Trạng thái tuỳ chỉnh để sử 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 |
Danh mục giảm giá tuỳ chỉnh để sử dụng khi |
ticketRestrictions |
Thông tin về những quy định hạn chế đối với việc sử dụng vé này. Ví dụ: phải sử dụng dữ liệu vào những ngày nào trong tuần hoặc tuyến đường nào được phép đi. |
purchaseDetails |
Thông tin mua vé này. |
ticketLeg |
Một chặng vé chứa thông tin về điểm khởi hành và thời gian đến, cùng thông tin lên máy bay và chỗ ngồi. Nếu cần chỉ định nhiều chân, 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 đều có thông tin về điểm khởi hành và thời gian đến, cùng thông tin lên máy bay và chỗ ngồi. Nếu chỉ cần 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 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ư |
tripType |
Bắt buộc. Loại chuyến đi mà đối tượng chuyển tuyến này đại diện. Dùng để xác định tiêu đề thẻ và/hoặc ký hiệu sử dụng giữa điểm xuất phát 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à mã duy nhất trên tất cả các đối tượng của một nhà phát hành. 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 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 thuộc 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 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. |
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 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 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. |
validTimeInterval |
Khoảng thời gian mà đố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 địa lý. |
hasUsers |
Cho biết đối tượng có người dùng hay không. Trường này do nền tảng đặt. |
smartTapRedemptionValue |
Giá trị sẽ được truyền đến thiết bị đầu cuối được chứng nhận Chạm thông minh qua NFC cho đối tượng này. Bạn cũng phải thiết lập các trường cấp lớp |
hasLinkedDevice |
Liệu đối tượng này hiện có được liên kết với một thiết bị duy nhất hay không. Trường này do nền tảng đặt khi người dùng lưu đối tượng và liên kết đối tượng đó với thiết bị của họ. Chỉ dành cho một số đối tác chọn lọc. Hãy liên hệ với nhóm hỗ trợ để biết thêm thông tin. |
disableExpirationNotification |
Cho biết liệu thông báo có phải bị chặn một cách rõ ràng hay không. Nếu bạn đặt trường này thành true (đúng), thì thông báo về thời hạn gửi đến người dùng đều sẽ bị chặn bất kể trường Hiện tại, bạn chỉ có thể đặt mục này cho ưu đãi. |
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 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[] |
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. |
linksModuleData |
Liên kết dữ liệu mô-đun. Nếu dữ liệu mô-đun liên kết cũng được xác định trên lớp, thì cả hai sẽ hiển thị. |
appLinkData |
Đường liên kết không bắt buộc đến ứng dụng hoặc trang web sẽ xuất hiện dưới dạng một nút ở mặt trước của thẻ. Nếu bạn cung cấp AppLinkData cho lớp tương ứng, thì chỉ có đối tượng AppLinkData 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 đã đặt |
rotatingBarcode |
Loại và giá trị mã vạch xoay vòng. |
deviceContext |
Ngữ cảnh thiết bị được 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, thì hình ảnh chính của lớp (nếu có) sẽ hiển thị. Nếu cũng không có hình ảnh chính của lớp thì sẽ không có hình ảnh nào hiển thị. |
groupingInfo |
Thông tin kiểm soát cách nhóm các 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 cả việc giới hạn NFC và hành vi chụp ảnh màn hình. |
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ể được đi. Ví dụ: đây có thể là chuỗi "Chỉ dành cho chuyến tàu đã qua quốc gia dành riêng". |
routeRestrictionsDetails |
Thông tin khác về |
timeRestrictions |
Quy định hạn chế về thời gian sử dụng vé này. |
otherRestrictions |
Các hạn chế bổ sung không thuộc danh mục "tuyến đường" hoặc "thời gian". |
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 giao dịch mua vé thông qua phần nội dung đã bán vé. |
purchaseDateTime |
Ngày/giờ mua vé. Đây là ngày/giờ định dạng mở rộng ISO 8601, có hoặc không có độ lệch. Thời gian có thể được chỉ định với độ chính xác lên đến nano giây. Bạn có thể chỉ định mức chênh lệch với độ chính xác tính bằng giây (mặc dù số giây bù trừ không thuộc tiêu chuẩn ISO 8601). Ví dụ:
Nếu không có thông tin về mức chênh lệch, bạn có thể không dùng được một số tính năng đa dạng thức. |
accountId |
Mã tài khoản đã dùng để mua vé. |
confirmationCode |
Mã xác nhận cho giao dịch mua hàng. Thao tác này có thể giống nhau đối với nhiều phiếu yêu cầu hỗ trợ và được dùng để nhóm các phiếu yêu cầu hỗ trợ lại với nhau. |
ticketCost |
Chi phí 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 khi trừ thuế và/hoặc chiết khấu. |
discountMessage |
Thông báo mô tả mọi loại chiết khấu được áp dụng. |
TicketLeg
Biểu diễn dưới dạng JSON |
---|
{ "originStationCode": string, "originName": { object ( |
Trường | |
---|---|
originStationCode |
Mã trạm khởi hành. Đây là yêu cầu bắt buộc nếu |
originName |
Tên của trạm khởi hành. Đây là yêu cầu bắt buộc nếu |
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 không có khoảng thời gian hợp lệ nào được thiết lập cho đối tượng chuyển tuyến. Đây là ngày/giờ định dạng mở rộng ISO 8601, có hoặc không có độ lệch. Thời gian có thể được chỉ định với độ chính xác lên đến nano giây. Bạn có thể chỉ định mức chênh lệch với độ chính xác tính bằng giây (mặc dù số giây bù trừ không thuộc tiêu chuẩn 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 thời gian khởi hành 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 chênh lệch, bạn có thể không dùng được một số tính năng đa dạng thức. |
arrivalDateTime |
Ngày/giờ đến. Đây là ngày/giờ định dạng mở rộng ISO 8601, có hoặc không có độ lệch. Thời gian có thể được chỉ định với độ chính xác lên đến nano giây. Bạn có thể chỉ định mức chênh lệch với độ chính xác tính bằng giây (mặc dù số giây bù trừ không thuộc tiêu chuẩn 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 đích. 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 sẽ là Nếu không có thông tin về mức chênh lệch, bạn có thể không dùng được một số tính năng đa dạng thức. |
fareName |
Nội dung mô tả/tên ngắn gọn về giá vé cho chặng đi này. Ví dụ: "Sử dụng một lần mọi lúc". |
carriage |
Tên/số tàu hoặc số tàu mà hành khách cần lên máy bay. |
platform |
Bệ đỡ hoặc cổng nơi hành khách có thể lên tàu. |
zone |
Khu vực lên tàu trong nền tảng. |
ticketSeat |
Chỗ ngồi đặt trước cho(các) hành khách. Nếu cần chỉ định nhiều giấy phép, hãy sử dụng trường |
ticketSeats[] |
Chỗ ngồi đặt trước cho(các) hành khách. Nếu chỉ cần chỉ định một giấy phép, hãy sử dụng trường |
transitOperatorName |
Tên của nhà cung cấp dịch vụ phương tiện công cộng đang điều hành chặng này của chuyến đi. |
transitTerminusName |
Ga cuối hoặc điểm đến của xe lửa/xe buýt/các vị trí khác. |
TicketSeat
Biểu diễn dưới dạng JSON |
---|
{ "fareClass": enum ( |
Trường | |
---|---|
fareClass |
Hạng giá vé của ghế có bán vé. |
customFareClass |
Hạng vé tuỳ chỉnh sẽ được sử dụng nếu không áp dụng |
coach |
Giá trị nhận dạng của toa tàu hoặc toa tàu có chỗ ngồi bán vé. Ví dụ: "10" |
seat |
Giá trị nhận dạng nơi đặt ghế có bán vé. Ví dụ: "42". Nếu không có giá trị nhận dạng cụ thể, hãy dùng |
seatAssignment |
Ghế ngồi được chỉ định cho hành khách. Ví dụ: "không có chỗ ngồi cụ thể". Được sử dụng khi không có giá trị nhận dạng cụ thể để 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 giá trị hỗ trợ việc 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
Ngữ cảnh thiết bị được 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 được đặt, thông tin đổi thưởng sẽ chỉ được trả về thiết bị đã cho khi kích hoạt đối tượng. 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. Dữ liệu này có thể thay đổi giữa nhiều thẻ và vé trên cùng một thiết bị hoặc thậm chí theo nhiều lần kích hoạt trên 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 chuyển tuyến được tham chiếu bởi 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à 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 nhất định. |
|
Cập nhật đối tượng chuyển tuyến được tham chiếu theo mã đối tượng đã cho. |
|
Cập nhật đối tượng chuyển tuyến được tham chiếu theo mã đối tượng đã cho. |