- 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 | |
---|---|
class |
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. |
ticket |
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. |
passenger |
Số lượng hành khách. |
passenger |
(Các) tên của hành khách được chỉ định vé. Trường |
trip |
Mã nhận dạng 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. |
ticket |
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 |
custom |
Trạng thái tuỳ chỉnh để sử dụng cho giá trị trạng thái phiếu yêu cầu hỗ trợ khi |
concession |
Danh mục giảm giá của vé. |
custom |
Danh mục đặc quyền tuỳ chỉnh để sử dụng khi |
ticket |
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ụ: ngày trong tuần phải sử dụng hoặc tuyến đường được phép đi. |
purchase |
Thông tin chi tiết về việc mua vé này. |
ticket |
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 bạn cần chỉ định nhiều chặng, hãy sử dụng trường |
ticket |
Mỗi vé có thể chứa một hoặc nhiều chặng. Mỗi chặng bay chứa thông tin về thời gian khởi hành và đến cùng với thông tin về việc lên máy bay và chỗ ngồi. Nếu chỉ cần chỉ định một chặng, hãy sử dụng trường |
hex |
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 RGB thập lục phân, chẳng hạn như |
trip |
Bắt buộc. Loại chuyến đi mà đối tượng phương tiện công cộng 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 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 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 ngang ("-"). |
class |
Bắt buộc. Lớp liên kết với đối tượng này. Lớp này 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 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 dùng để xác định cách hiển thị một đối tượng trong ứng dụng. Ví dụ: đố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. |
valid |
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í. |
has |
Cho biết đối tượng có người dùng hay không. Trường này do nền tảng đặt. |
smart |
Giá trị sẽ được truyền đến thiết bị đầu cuối được chứng nhận Smart Tap qua NFC cho đối tượng này. Bạn cũng phải thiết lập chính xác các trường cấp lớp |
has |
Liệu đối tượng này có đang được liên kết với một thiết bị 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. |
disable |
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ể thiết lập chế độ cài đặt này cho các mặt hàng. |
info |
Không dùng nữa. Thay vào đó, hãy sử dụng textModulesData. |
image |
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. |
text |
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ủa các trường này hiển thị là 10 từ đối tượng và 10 từ lớp. |
links |
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 trên lớp, thì cả hai sẽ hiển thị. |
app |
Đường liên kết đến ứng dụng hoặc trang web (không bắt buộc) sẽ hiển thị dưới dạng nút ở mặt trước của thẻ và vé. Nếu AppLinkData được cung cấp cho lớp tương ứng thì chỉ có đối tượng AppLinkData sẽ xuất hiện. |
activation |
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 |
rotating |
Loại và giá trị mã vạch xoay. |
device |
Bối cảnh của thiết bị liên kết với đối tượng. |
hero |
Hình ảnh biểu ngữ không bắt buộc xuất hiện ở mặt trước 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ị. |
grouping |
Thông tin kiểm soát cách nhóm thẻ và vé lại với nhau. |
pass |
Truyền các quy tắc ràng buộc cho đối tượng. Bao gồm cả việc hạn chế hành vi NFC và ảnh chụp màn hình. |
save |
Các quy định 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 quy định hạn chế này sẽ chỉ được áp dụng trong thời gian tiết kiệm pin. 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 quy định hạn chế mới sẽ không được áp dụng cho thẻ và vé đã lưu. |
linked |
linkedObjectIds là danh sách các đối tượng khác như vé xem sự kiện, chương trình khách hàng thân thiết, ưu đãi, thông tin chung, thẻ quà tặng, thẻ đi phương tiện công cộng và thẻ lên máy bay sẽ được tự động gắn vào đối tượng phương tiện công cộng này. Nếu người dùng đã lưu thẻ đi phương tiện công cộng này, thì các linkingObjectIds này sẽ tự động được chuyển vào ví của người dùng (trừ phi người dùng tắt chế độ cài đặt nhận những thẻ và vé được liên kết đó). Đảm bảo rằng các đối tượng có trong linkedObjectIds đã được chèn – nếu không, các lệnh gọi sẽ không thành công. Sau khi liên kết, bạn không thể huỷ liên kết các đối tượng đã liên kết. Bạn không thể liên kết các đối tượng thuộc về một tổ chức phát hành khác. Có giới hạn về số lượng đối tượng có thể được liên kết với một đối tượng. Sau khi đạt đến giới hạn, các đối tượng liên kết mới trong lệnh gọi sẽ bị bỏ qua một cách tự động. Mã đối tượng 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. |
notify |
Liệu nội dung cập nhật trường cho đối tượng 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 được đặt thành DO_NOT_chẳng hạn, thì sẽ không có thông báo nào được kích hoạt. 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. |
value |
Dữ liệu mô-đun giá trị gia tăng không bắt buộc. Tối đa 10 đối tượng. |
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 | |
---|---|
route |
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". |
route |
Thông tin chi tiết về |
time |
Quy định hạn chế về thời gian có thể sử dụng vé này. |
other |
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 | |
---|---|
purchase |
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é. |
purchase |
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. |
account |
Mã nhận dạng của tài khoản dùng để mua vé. |
confirmation |
Mã xác nhận cho giao dịch mua. Mã này có thể giống nhau cho 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. |
ticket |
Giá vé. |
TicketCost
Biểu diễn dưới dạng JSON |
---|
{ "faceValue": { object ( |
Trường | |
---|---|
face |
Mệnh giá của vé. |
purchase |
Giá mua thực tế của vé, sau khi trừ thuế và/hoặc chiết khấu. |
discount |
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 | |
---|---|
origin |
Mã ga xuất phát. Đây là yêu cầu bắt buộc nếu có |
origin |
Tên của ga xuất phát. Đây là yêu cầu bắt buộc nếu có |
destination |
Mã ga đến. |
destination |
Tên đích đến. |
departure |
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ờ theo giờ địa phương tại ga xuất phát. Ví dụ: nếu chuyến tàu khởi hành lúc 20 giờ ngày 5 tháng 6 năm 2018 tại ga xuất phát, thì phần ngày/giờ theo giờ địa phương phải là Nếu không có thông tin chênh lệch, một số tính năng đa dạng thức có thể không hoạt động. |
arrival |
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ừ. Bạn có thể chỉ định thời gian với độ chính xác lên đến nano giây. Bạn có thể chỉ định độ lệch với độ chính xác đến giây (mặc dù độ lệch giây không thuộc tiêu chuẩn ISO 8601). Ví dụ:
Phần ngày/giờ không có độ 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. |
fare |
Nội dung mô tả ngắn/tên của 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ố hiệu tàu hoặc xe lửa mà hành khách cần lên. |
platform |
Nền tảng hoặc cổng nơi hành khách có thể lên toa xe. |
zone |
Vùng lên tàu trong nhà ga. |
ticket |
Ghế ngồi đã đặt trước cho(các) hành khách. Nếu bạn cần chỉ định nhiều chỗ ngồi, hãy sử dụng trường |
ticket |
Chỗ ngồi được đặ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 |
transit |
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. |
transit |
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 | |
---|---|
fare |
Hạng vé của chỗ ngồi có bán vé. |
custom |
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 xe hoặc toa xe khách nơi có ghế được đặt vé. Ví dụ: "10" |
seat |
Giá trị nhận dạng vị trí của chỗ ngồi đã mua vé. Ví dụ: "42". Nếu không có giá trị nhận dạng cụ thể, hãy sử dụng |
seat |
Ghế đượ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ể để 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 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 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 quan đến đối tượng.
Biểu diễn dưới dạng JSON |
---|
{ "deviceToken": string } |
Trường | |
---|---|
device |
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. Mã này có thể thay đổi giữa các thẻ/vé cho cùng một thiết bị hoặc thậm chí giữa các lần kích hoạt 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 phương tiện công cộng được tham chiếu bằng mã nhận dạng đối tượng đã cho. |
|
Trả về đối tượng phương tiện công cộng có mã nhận dạng đố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 chuyển đổi được tham chiếu theo mã đối tượng đã cho. |
|
Cập nhật đối tượng chuyển đổi được tham chiếu theo mã đối tượng đã cho. |