REST Resource: transitobject

Tài nguyên: TransitObject

Biểu diễn dưới dạng JSON
{
  "classReference": {
    object (TransitClass)
  },
  "ticketNumber": string,
  "passengerType": enum (PassengerType),
  "passengerNames": string,
  "tripId": string,
  "ticketStatus": enum (TicketStatus),
  "customTicketStatus": {
    object (LocalizedString)
  },
  "concessionCategory": enum (ConcessionCategory),
  "customConcessionCategory": {
    object (LocalizedString)
  },
  "ticketRestrictions": {
    object (TicketRestrictions)
  },
  "purchaseDetails": {
    object (PurchaseDetails)
  },
  "ticketLeg": {
    object (TicketLeg)
  },
  "ticketLegs": [
    {
      object (TicketLeg)
    }
  ],
  "hexBackgroundColor": string,
  "tripType": enum (TripType),
  "id": string,
  "classId": string,
  "version": string,
  "state": enum (State),
  "barcode": {
    object (Barcode)
  },
  "messages": [
    {
      object (Message)
    }
  ],
  "validTimeInterval": {
    object (TimeInterval)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "hasUsers": boolean,
  "smartTapRedemptionValue": string,
  "hasLinkedDevice": boolean,
  "disableExpirationNotification": boolean,
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "appLinkData": {
    object (AppLinkData)
  },
  "activationStatus": {
    object (ActivationStatus)
  },
  "rotatingBarcode": {
    object (RotatingBarcode)
  },
  "deviceContext": {
    object (DeviceContext)
  },
  "heroImage": {
    object (Image)
  },
  "groupingInfo": {
    object (GroupingInfo)
  },
  "passConstraints": {
    object (PassConstraints)
  }
}
Trường
classReference

object (TransitClass)

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

string

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

enum (PassengerType)

Số lượng hành khách.

passengerNames

string

Tên của những hành khách được chỉ định vé. Trường passengerType ở trên nhằm cung cấp thông tin bối cảnh cho Google về trường này.

tripId

string

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

enum (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 state.

customTicketStatus

object (LocalizedString)

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 ticketStatus không cung cấp lựa chọn phù hợp. Bạn không thể đặt cả ticketStatuscustomTicketStatus.

concessionCategory

enum (ConcessionCategory)

Danh mục giảm giá của vé.

customConcessionCategory

object (LocalizedString)

Danh mục giảm giá tuỳ chỉnh để sử dụng khi concessionCategory không cung cấp tuỳ chọn phù hợp. Bạn không thể đặt cả concessionCategorycustomConcessionCategory.

ticketRestrictions

object (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

object (PurchaseDetails)

Thông tin mua vé này.

ticketLeg

object (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. Bạn không thể đặt cả ticketLegticketLegs.

ticketLegs[]

object (TicketLeg)

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 ticketLeg. Bạn không thể đặt cả ticketLegticketLegs.

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.

tripType

enum (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

string

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

string

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
(deprecated)

string (int64 format)

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

state

enum (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 inactive được di chuyển đến mục "Thẻ và vé đã hết hạn".

barcode

object (Barcode)

Loại và giá trị mã vạch.

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.

validTimeInterval

object (TimeInterval)

Khoảng thời gian mà đối tượng này sẽ là active và có thể sử dụng đối tượng. Trạng thái của một đối tượng sẽ được thay đổi thành expired khi khoảng thời gian này trôi qua.

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ý.

hasUsers

boolean

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

string

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 enableSmartTapredemptionIssuers đúng cách để thẻ/vé hỗ trợ tính năng Chạm thông minh. Chỉ hỗ trợ các ký tự ASCII.

hasLinkedDevice

boolean

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

boolean

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 messages là gì. Theo mặc định, trường này được đặt thành false.

Hiện tại, bạn chỉ có thể đặt mục này cho ưu đãi.

infoModuleData

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.

activationStatus

object (ActivationStatus)

Trạng thái kích hoạt của đối tượng. Bắt buộc nếu lớp đã đặt activationOptions.

rotatingBarcode

object (RotatingBarcode)

Loại và giá trị mã vạch xoay vòng.

deviceContext

object (DeviceContext)

Ngữ cảnh thiết bị được liên kết với đối tượ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ó 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

object (GroupingInfo)

Thông tin kiểm soát cách nhóm các thẻ và vé lại với nhau.

passConstraints

object (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 SINGLE_PASSENGER. Không dùng nữa.

MULTIPLE_PASSENGERS
multiplePassengers

Bí danh cũ của MULTIPLE_PASSENGERS. Không dùng nữa.

TicketStatus

Enum
TICKET_STATUS_UNSPECIFIED
USED
used

Bí danh cũ của USED. Không dùng nữa.

REFUNDED
refunded

Bí danh cũ của REFUNDED. Không dùng nữa.

EXCHANGED
exchanged

Bí danh cũ của EXCHANGED. Không dùng nữa.

ConcessionCategory

Enum
CONCESSION_CATEGORY_UNSPECIFIED
ADULT
adult

Bí danh cũ của ADULT. Không dùng nữa.

CHILD
child

Bí danh cũ của CHILD. Không dùng nữa.

SENIOR
senior

Bí danh cũ của SENIOR. Không dùng nữa.

TicketRestrictions

Biểu diễn dưới dạng JSON
{
  "routeRestrictions": {
    object (LocalizedString)
  },
  "routeRestrictionsDetails": {
    object (LocalizedString)
  },
  "timeRestrictions": {
    object (LocalizedString)
  },
  "otherRestrictions": {
    object (LocalizedString)
  }
}
Trường
routeRestrictions

object (LocalizedString)

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

object (LocalizedString)

Thông tin khác về routeRestrictions ở trên.

timeRestrictions

object (LocalizedString)

Quy định hạn chế về thời gian sử dụng vé này.

otherRestrictions

object (LocalizedString)

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 (TicketCost)
  }
}
Trường
purchaseReceiptNumber

string

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

string

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ụ:

1985-04-12T23:20:50.52Z sẽ là 20 phút 50, 52 giây sau giờ 23 của ngày 12 tháng 4 năm 1985 theo giờ UTC.

1985-04-12T19:20:50.52-04:00 sẽ là 20 phút 50, 52 giây sau giờ thứ 19 của ngày 12 tháng 4 năm 1985, 4 giờ trước UTC (cùng thời điểm với ví dụ trên). Nếu sự kiện diễn ra ở New York, giờ này sẽ tương đương với Giờ ban ngày miền Đông (EDT). Hãy nhớ rằng mức chênh lệch sẽ khác nhau ở các khu vực tuân theo Giờ mùa hè (hoặc Giờ mùa hè), tuỳ thuộc vào thời gian trong năm.

1985-04-12T19:20:50.52 sẽ là 20 phút 50, 52 giây sau giờ thứ 19 của ngày 12 tháng 4 năm 1985 nếu không có thông tin về thời gian bù trừ.

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

string

Mã tài khoản đã dùng để mua vé.

confirmationCode

string

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

object (TicketCost)

Chi phí vé.

TicketCost

Biểu diễn dưới dạng JSON
{
  "faceValue": {
    object (Money)
  },
  "purchasePrice": {
    object (Money)
  },
  "discountMessage": {
    object (LocalizedString)
  }
}
Trường
faceValue

object (Money)

Mệnh giá vé.

purchasePrice

object (Money)

Giá mua thực tế của vé, sau khi trừ thuế và/hoặc chiết khấu.

discountMessage

object (LocalizedString)

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 (LocalizedString)
  },
  "destinationStationCode": string,
  "destinationName": {
    object (LocalizedString)
  },
  "departureDateTime": string,
  "arrivalDateTime": string,
  "fareName": {
    object (LocalizedString)
  },
  "carriage": string,
  "platform": string,
  "zone": string,
  "ticketSeat": {
    object (TicketSeat)
  },
  "ticketSeats": [
    {
      object (TicketSeat)
    }
  ],
  "transitOperatorName": {
    object (LocalizedString)
  },
  "transitTerminusName": {
    object (LocalizedString)
  }
}
Trường
originStationCode

string

Mã trạm khởi hành. Đây là yêu cầu bắt buộc nếu destinationStationCode có hoặc không có originName.

originName

object (LocalizedString)

Tên của trạm khởi hành. Đây là yêu cầu bắt buộc nếu desinationName có hoặc không có originStationCode.

destinationStationCode

string

Mã trạm đích.

destinationName

object (LocalizedString)

Tên đích đến.

departureDateTime

string

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ụ:

1985-04-12T23:20:50.52Z sẽ là 20 phút 50, 52 giây sau giờ 23 của ngày 12 tháng 4 năm 1985 theo giờ UTC.

1985-04-12T19:20:50.52-04:00 sẽ là 20 phút 50, 52 giây sau giờ thứ 19 của ngày 12 tháng 4 năm 1985, 4 giờ trước UTC (cùng thời điểm với ví dụ trên). Nếu sự kiện diễn ra ở New York, giờ này sẽ tương đương với Giờ ban ngày miền Đông (EDT). Hãy nhớ rằng mức chênh lệch sẽ khác nhau ở các khu vực tuân theo Giờ mùa hè (hoặc Giờ mùa hè), tuỳ thuộc vào thời gian trong năm.

1985-04-12T19:20:50.52 sẽ là 20 phút 50, 52 giây sau giờ thứ 19 của ngày 12 tháng 4 năm 1985 nếu không có thông tin về thời gian bù trừ.

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à 2018-06-05T20:00:00. Nếu ngày/giờ địa phương tại trạm khởi hành là 4 giờ trước giờ UTC, thì có thể thông tin chênh lệch là -04:00 sẽ được thêm vào.

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

string

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ụ:

1985-04-12T23:20:50.52Z sẽ là 20 phút 50, 52 giây sau giờ 23 của ngày 12 tháng 4 năm 1985 theo giờ UTC.

1985-04-12T19:20:50.52-04:00 sẽ là 20 phút 50, 52 giây sau giờ thứ 19 của ngày 12 tháng 4 năm 1985, 4 giờ trước UTC (cùng thời điểm với ví dụ trên). Nếu sự kiện diễn ra ở New York, giờ này sẽ tương đương với Giờ ban ngày miền Đông (EDT). Hãy nhớ rằng mức chênh lệch sẽ khác nhau ở các khu vực tuân theo Giờ mùa hè (hoặc Giờ mùa hè), tuỳ thuộc vào thời gian trong năm.

1985-04-12T19:20:50.52 sẽ là 20 phút 50, 52 giây sau giờ thứ 19 của ngày 12 tháng 4 năm 1985 nếu không có thông tin về thời gian bù trừ.

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à 2018-06-05T20:00:00. Nếu ngày/giờ địa phương tại trạm đích là 4 giờ trước giờ UTC, thì giá trị chênh lệch có thể là -04:00.

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

object (LocalizedString)

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

string

Tên/số tàu hoặc số tàu mà hành khách cần lên máy bay.

platform

string

Bệ đỡ hoặc cổng nơi hành khách có thể lên tàu.

zone

string

Khu vực lên tàu trong nền tảng.

ticketSeat

object (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. Bạn không thể đặt cả ticketSeatticketSeats.

ticketSeats[]

object (TicketSeat)

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 ticketSeat. Bạn không thể đặt cả ticketSeatticketSeats.

transitOperatorName

object (LocalizedString)

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

object (LocalizedString)

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 (FareClass),
  "customFareClass": {
    object (LocalizedString)
  },
  "coach": string,
  "seat": string,
  "seatAssignment": {
    object (LocalizedString)
  }
}
Trường
fareClass

enum (FareClass)

Hạng giá vé của ghế có bán vé.

customFareClass

object (LocalizedString)

Hạng vé tuỳ chỉnh sẽ được sử dụng nếu không áp dụng fareClass. Bạn không thể đặt cả fareClasscustomFareClass.

coach

string

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

string

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 seatAssigment.

seatAssignment

object (LocalizedString)

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 seat.

FareClass

Enum
FARE_CLASS_UNSPECIFIED
ECONOMY
economy

Bí danh cũ của ECONOMY. Không dùng nữa.

FIRST
first

Bí danh cũ của FIRST. Không dùng nữa.

BUSINESS
business

Bí danh cũ của BUSINESS. Không dùng nữa.

TripType

Enum
TRIP_TYPE_UNSPECIFIED
ROUND_TRIP
roundTrip

Bí danh cũ của ROUND_TRIP. Không dùng nữa.

ONE_WAY
oneWay

Bí danh cũ của ONE_WAY. Không dùng nữ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 (State)
}
Trường
state

enum (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 NOT_ACTIVATED. Không dùng nữa.

ACTIVATED Kích hoạt
activated

Bí danh cũ của ACTIVATED. Không dùng nữ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

string

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

addmessage

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.

get

Trả về đối tượng chuyển tuyến có mã đối tượng đã cho.

insert

Chèn một đối tượng chuyển tuyến có mã nhận dạng và thuộc tính đã cho.

list

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.

patch

Cập nhật đối tượng chuyển tuyến được tham chiếu theo mã đối tượng đã cho.

update

Cập nhật đối tượng chuyển tuyến được tham chiếu theo mã đối tượng đã cho.