REST Resource: transitobject

Resource: TransitObject

Representasi 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)
  }
}
Kolom
classReference

object (TransitClass)

Salinan kolom yang diwariskan dari class induk. Kolom ini diambil selama GET.
ticketNumber

string

Nomor tiket. ID unik untuk tiket dalam sistem operator transportasi umum.
passengerType

enum (PassengerType)

Jumlah penumpang.
passengerNames

string

Nama penumpang yang diberikan tiket. Kolom passengerType di atas dimaksudkan untuk memberikan konteks kepada Google terkait kolom ini.
tripId

string

ID ini digunakan untuk mengelompokkan tiket jika pengguna telah menyimpan beberapa tiket untuk perjalanan yang sama.
ticketStatus

enum (TicketStatus)

Status tiket. Untuk status yang memengaruhi tampilan, gunakan kolom state.
customTicketStatus

object (LocalizedString)

Status kustom yang akan digunakan untuk nilai status tiket jika ticketStatus tidak memberikan opsi yang tepat. ticketStatus dan customTicketStatus mungkin tidak ditetapkan.
concessionCategory

enum (ConcessionCategory)

Kategori konsesi untuk tiket.
customConcessionCategory

object (LocalizedString)

Kategori diskon kustom yang akan digunakan jika concessionCategory tidak memberikan opsi yang tepat. concessionCategory dan customConcessionCategory mungkin tidak ditetapkan.
ticketRestrictions

object (TicketRestrictions)

Informasi tentang jenis batasan yang ada terkait penggunaan tiket ini. Misalnya, pada hari apa kendaraan harus digunakan, atau rute yang boleh diambil.
purchaseDetails

object (PurchaseDetails)

Detail pembelian untuk tiket ini.
ticketLeg

object (TicketLeg)

Satu segmen tiket berisi informasi keberangkatan dan kedatangan beserta informasi naik turun dan tempat duduk. Jika lebih dari satu segmen akan ditentukan, gunakan kolom ticketLegs. ticketLeg dan ticketLegs mungkin tidak ditetapkan.
ticketLegs[]

object (TicketLeg)

Setiap tiket dapat berisi satu atau beberapa segmen. Setiap segmen berisi informasi keberangkatan dan kedatangan beserta informasi boarding dan tempat duduk. Jika hanya satu segmen yang akan ditentukan, gunakan kolom ticketLeg. ticketLeg dan ticketLegs mungkin tidak ditetapkan.
hexBackgroundColor

string

Warna latar belakang kartu. Jika tidak disetel, warna dominan gambar utama akan digunakan, dan jika gambar utama tidak ditetapkan, warna dominan logo akan digunakan. Formatnya adalah #rrggbb dengan rrggbb adalah triplet RGB heksadesimal, seperti #ffcc00. Anda juga dapat menggunakan versi singkat triplet RGB yang #rgb, seperti #fc0.
tripType

enum (TripType)

Wajib. Jenis perjalanan yang diwakili oleh objek transportasi umum ini. Digunakan untuk menentukan judul kartu dan/atau simbol mana yang akan digunakan antara tempat asal dan tujuan.
id

string

Wajib. ID unik untuk objek. ID ini harus unik di semua objek dari penerbit. Nilai ini harus mengikuti format issuer ID.identifier file yang pertama diterbitkan oleh Google dan versi kedua dipilih oleh Anda. ID unik hanya boleh berisi karakter alfanumerik, '.', '_', atau '-'.
classId

string

Wajib. Class yang terkait dengan objek ini. Class harus memiliki jenis yang sama dengan objek ini, harus sudah ada, dan harus disetujui.

ID class harus mengikuti format issuer ID.identifier file yang pertama diterbitkan oleh Google dan versi kedua dipilih oleh Anda.
version
(deprecated)

string (int64 format)

Tidak digunakan lagi
state

enum (State)

Wajib. Status objek. Kolom ini digunakan untuk menentukan cara objek ditampilkan di aplikasi. Misalnya, objek inactive dipindahkan ke bagian "Masa berlaku kartu habis".
barcode

object (Barcode)

Jenis dan nilai kode batang.
messages[]

object (Message)

Array pesan yang ditampilkan di aplikasi. Semua pengguna objek ini akan menerima pesan terkaitnya. Jumlah maksimum kolom ini adalah 10.
validTimeInterval

object (TimeInterval)

Jangka waktu objek ini akan menjadi active dan objek dapat digunakan. Status objek akan diubah menjadi expired jika jangka waktu ini telah berlalu.
locations[]

object (LatLongPoint)

Catatan: Kolom ini saat ini tidak didukung untuk memicu notifikasi geografis.
hasUsers

boolean

Menunjukkan apakah objek memiliki pengguna. Kolom ini ditetapkan oleh platform.
smartTapRedemptionValue

string

Nilai yang akan dikirimkan ke terminal bersertifikasi Smart Tap melalui NFC untuk objek ini. Kolom tingkat class enableSmartTap dan redemptionIssuers juga harus disiapkan dengan benar agar kartu dapat mendukung Smart Tap. Hanya karakter ASCII yang didukung.
hasLinkedDevice

boolean

Apakah objek ini saat ini ditautkan ke satu perangkat. Kolom ini ditetapkan oleh platform saat pengguna menyimpan objek, menautkannya ke perangkat mereka. Ditujukan untuk digunakan oleh partner tertentu. Hubungi dukungan untuk mendapatkan informasi tambahan.
disableExpirationNotification

boolean

Menunjukkan apakah notifikasi harus disembunyikan secara eksplisit. Jika kolom ini disetel ke benar (true), terlepas dari kolom messages, notifikasi habisnya masa berlaku kepada pengguna akan disembunyikan. Secara default, kolom ini ditetapkan ke false.

Saat ini, setelan ini hanya dapat ditetapkan untuk penawaran.
infoModuleData

object (InfoModuleData)

Tidak digunakan lagi. Sebagai gantinya, gunakan textModulesData.
imageModulesData[]

object (ImageModuleData)

Data modul gambar. Jumlah maksimum kolom yang ditampilkan adalah 1 dari tingkat objek dan 1 untuk tingkat objek class.
textModulesData[]

object (TextModuleData)

Data modul teks. Jika data modul teks juga ditetapkan pada class, keduanya akan ditampilkan. Jumlah maksimum kolom yang ditampilkan adalah 10 dari objek dan 10 dari class.
activationStatus

object (ActivationStatus)

Status aktivasi untuk objek. Wajib ada jika class telah menetapkan activationOptions.
rotatingBarcode

object (RotatingBarcode)

Jenis dan nilai kode batang yang berputar.
deviceContext

object (DeviceContext)

Konteks perangkat yang terkait dengan objek.
heroImage

object (Image)

Gambar banner opsional yang ditampilkan di bagian depan kartu. Jika tidak ada satu pun, gambar utama kelas, jika ada, akan ditampilkan. Jika banner besar class juga tidak ada, tidak ada yang akan ditampilkan.
groupingInfo

object (GroupingInfo)

Informasi yang mengontrol cara kartu dikelompokkan bersama.
passConstraints

object (PassConstraints)

Meneruskan batasan untuk objek. Termasuk membatasi perilaku NFC dan screenshot.

PassengerType

Enum
PASSENGER_TYPE_UNSPECIFIED
SINGLE_PASSENGER
singlePassenger

Alias lama untuk SINGLE_PASSENGER. Tidak digunakan lagi.
MULTIPLE_PASSENGERS
multiplePassengers

Alias lama untuk MULTIPLE_PASSENGERS. Tidak digunakan lagi.

TicketStatus

Enum
TICKET_STATUS_UNSPECIFIED
USED
used

Alias lama untuk USED. Tidak digunakan lagi.
REFUNDED
refunded

Alias lama untuk REFUNDED. Tidak digunakan lagi.
EXCHANGED
exchanged

Alias lama untuk EXCHANGED. Tidak digunakan lagi.

ConcessionCategory

Enum
CONCESSION_CATEGORY_UNSPECIFIED
ADULT
adult

Alias lama untuk ADULT. Tidak digunakan lagi.
CHILD
child

Alias lama untuk CHILD. Tidak digunakan lagi.
SENIOR
senior

Alias lama untuk SENIOR. Tidak digunakan lagi.

TicketRestrictions

Representasi JSON 
{
  "routeRestrictions": {
    object (LocalizedString)
  },
  "routeRestrictionsDetails": {
    object (LocalizedString)
  },
  "timeRestrictions": {
    object (LocalizedString)
  },
  "otherRestrictions": {
    object (LocalizedString)
  }
}
Kolom
routeRestrictions

object (LocalizedString)

Batasan tentang rute yang mungkin diambil. Misalnya, string ini mungkin adalah string "Hanya kereta yang dicadangkan CrossCountry".
routeRestrictionsDetails

object (LocalizedString)

Detail selengkapnya tentang routeRestrictions di atas.
timeRestrictions

object (LocalizedString)

Batasan waktu penggunaan tiket ini.
otherRestrictions

object (LocalizedString)

Pembatasan tambahan yang tidak termasuk dalam kategori "rute" atau "waktu".

PurchaseDetails

Representasi JSON 
{
  "purchaseReceiptNumber": string,
  "purchaseDateTime": string,
  "accountId": string,
  "confirmationCode": string,
  "ticketCost": {
    object (TicketCost)
  }
}
Kolom
purchaseReceiptNumber

string

Nomor/ID tanda terima untuk melacak pembelian tiket melalui badan penjual tiket.
purchaseDateTime

string

Tanggal/waktu pembelian tiket.

Ini adalah tanggal/waktu format ISO 8601 yang diperpanjang, dengan atau tanpa offset. Waktu dapat ditentukan hingga presisi nanodetik. Offset dapat ditentukan dengan presisi detik (meskipun detik offset bukan bagian dari ISO 8601).

Contoh:

1985-04-12T23:20:50.52Z adalah 20 menit 50, 52 detik setelah jam ke-23 pada 12 April 1985 dalam UTC.

1985-04-12T19:20:50.52-04:00 adalah 20 menit 50, 52 detik setelah jam ke-19 pada 12 April 1985, 4 jam sebelum UTC (waktu yang sama seketika seperti contoh di atas). Jika acara berada di New York, waktu ini akan setara dengan Waktu Musim Panas Timur (EDT). Ingatlah bahwa kompensasi bervariasi di wilayah yang mengikuti Waktu Musim Panas (atau Waktu Musim Panas), tergantung pada waktu dalam setahun.

1985-04-12T19:20:50.52 adalah 20 menit 50, 52 detik setelah jam ke-19 12 April 1985 tanpa informasi offset.

Tanpa informasi offset, beberapa fitur lengkap mungkin tidak tersedia.
accountId

string

ID akun yang digunakan untuk membeli tiket.
confirmationCode

string

Kode konfirmasi untuk pembelian. Hal ini mungkin sama untuk beberapa tiket yang berbeda dan digunakan untuk mengelompokkan tiket secara bersamaan.
ticketCost

object (TicketCost)

Biaya tiket.

TicketCost

Representasi JSON 
{
  "faceValue": {
    object (Money)
  },
  "purchasePrice": {
    object (Money)
  },
  "discountMessage": {
    object (LocalizedString)
  }
}
Kolom
faceValue

object (Money)

Harga asli tiket.
purchasePrice

object (Money)

Harga pembelian tiket yang sebenarnya, setelah pajak dan/atau diskon.
discountMessage

object (LocalizedString)

Pesan yang menjelaskan jenis diskon apa pun yang diterapkan.

TicketLeg

Representasi 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)
  }
}
Kolom
originStationCode

string

Kode stasiun asal. Hal ini diperlukan jika destinationStationCode ada atau jika originName tidak ada.
originName

object (LocalizedString)

Nama stasiun asal. Hal ini diperlukan jika desinationName ada atau jika originStationCode tidak ada.
destinationStationCode

string

Kode stasiun tujuan.
destinationName

object (LocalizedString)

Nama tujuan.
departureDateTime

string

Tanggal/waktu keberangkatan. Hal ini diperlukan jika interval waktu validitas tidak ditetapkan pada objek transportasi umum.

Ini adalah tanggal/waktu format ISO 8601 yang diperpanjang, dengan atau tanpa offset. Waktu dapat ditentukan hingga presisi nanodetik. Offset dapat ditentukan dengan presisi detik (meskipun detik offset bukan bagian dari ISO 8601).

Contoh:

1985-04-12T23:20:50.52Z adalah 20 menit 50, 52 detik setelah jam ke-23 pada 12 April 1985 dalam UTC.

1985-04-12T19:20:50.52-04:00 adalah 20 menit 50, 52 detik setelah jam ke-19 pada 12 April 1985, 4 jam sebelum UTC (waktu yang sama seketika seperti contoh di atas). Jika acara berada di New York, waktu ini akan setara dengan Waktu Musim Panas Timur (EDT). Ingatlah bahwa kompensasi bervariasi di wilayah yang mengikuti Waktu Musim Panas (atau Waktu Musim Panas), tergantung pada waktu dalam setahun.

1985-04-12T19:20:50.52 adalah 20 menit 50, 52 detik setelah jam ke-19 12 April 1985 tanpa informasi offset.

Bagian tanggal/waktu tanpa selisih dianggap sebagai "tanggal/waktu lokal". Nilai ini harus berupa tanggal/waktu lokal di stasiun asal. Misalnya, jika keberangkatan terjadi pada jam ke-20 pada 5 Juni 2018 di stasiun asal, bagian tanggal/waktu lokal harus 2018-06-05T20:00:00. Jika tanggal/waktu lokal di stasiun asal adalah 4 jam sebelum UTC, offset -04:00 dapat ditambahkan.

Tanpa informasi offset, beberapa fitur lengkap mungkin tidak tersedia.
arrivalDateTime

string

Tanggal/waktu kedatangan.

Ini adalah tanggal/waktu format ISO 8601 yang diperpanjang, dengan atau tanpa offset. Waktu dapat ditentukan hingga presisi nanodetik. Offset dapat ditentukan dengan presisi detik (meskipun detik offset bukan bagian dari ISO 8601).

Contoh:

1985-04-12T23:20:50.52Z adalah 20 menit 50, 52 detik setelah jam ke-23 pada 12 April 1985 dalam UTC.

1985-04-12T19:20:50.52-04:00 adalah 20 menit 50, 52 detik setelah jam ke-19 pada 12 April 1985, 4 jam sebelum UTC (waktu yang sama seketika seperti contoh di atas). Jika acara berada di New York, waktu ini akan setara dengan Waktu Musim Panas Timur (EDT). Ingatlah bahwa kompensasi bervariasi di wilayah yang mengikuti Waktu Musim Panas (atau Waktu Musim Panas), tergantung pada waktu dalam setahun.

1985-04-12T19:20:50.52 adalah 20 menit 50, 52 detik setelah jam ke-19 12 April 1985 tanpa informasi offset.

Bagian tanggal/waktu tanpa selisih dianggap sebagai "tanggal/waktu lokal". Nilai ini harus merupakan tanggal/waktu lokal di stasiun tujuan. Misalnya, jika peristiwa terjadi pada jam ke-20 pada 5 Juni 2018 di stasiun tujuan, bagian tanggal/waktu lokal harus 2018-06-05T20:00:00. Jika tanggal/waktu lokal di stasiun tujuan adalah 4 jam sebelum UTC, offset -04:00 dapat ditambahkan.

Tanpa informasi offset, beberapa fitur lengkap mungkin tidak tersedia.
fareName

object (LocalizedString)

Deskripsi singkat/nama harga tiket untuk segmen perjalanan ini. Misalnya, "Kapan Saja Sekali Pakai".
carriage

string

Nama/nomor kereta atau kapal yang harus naik penumpang.
platform

string

Peron atau gerbang tempat penumpang dapat naik gerbong.
zone

string

Zona boarding di dalam platform.
ticketSeat

object (TicketSeat)

Kursi yang direservasi untuk penumpang. Jika lebih dari satu slot yang akan ditentukan, gunakan kolom ticketSeats. ticketSeat dan ticketSeats mungkin tidak ditetapkan.
ticketSeats[]

object (TicketSeat)

Kursi yang direservasi untuk penumpang. Jika hanya satu kursi yang akan ditentukan, gunakan kolom ticketSeat. ticketSeat dan ticketSeats mungkin tidak ditetapkan.
transitOperatorName

object (LocalizedString)

Nama operator transportasi umum yang mengoperasikan segmen perjalanan ini.
transitTerminusName

object (LocalizedString)

Stasiun terakhir atau tujuan kereta/bus/dll.

TicketSeat

Representasi JSON 
{
  "fareClass": enum (FareClass),
  "customFareClass": {
    object (LocalizedString)
  },
  "coach": string,
  "seat": string,
  "seatAssignment": {
    object (LocalizedString)
  }
}
Kolom
fareClass

enum (FareClass)

Jenis tiket untuk kursi bertiket.
customFareClass

object (LocalizedString)

Jenis tarif khusus yang akan digunakan jika tidak ada fareClass yang berlaku. fareClass dan customFareClass mungkin tidak ditetapkan.
coach

string

ID gerbong atau gerbong kereta tempat kursi bertiket berada. Misalnya, "10"
seat

string

ID tempat kursi bertiket berada. Misalnya, "42". Jika tidak ada ID khusus, gunakan seatAssigment.
seatAssignment

object (LocalizedString)

Penetapan kursi penumpang. Misalnya, "tidak ada kursi tertentu". Untuk digunakan saat tidak ada ID khusus untuk digunakan di seat.

FareClass

Enum
FARE_CLASS_UNSPECIFIED
ECONOMY
economy

Alias lama untuk ECONOMY. Tidak digunakan lagi.
FIRST
first

Alias lama untuk FIRST. Tidak digunakan lagi.
BUSINESS
business

Alias lama untuk BUSINESS. Tidak digunakan lagi.

TripType

Enum
TRIP_TYPE_UNSPECIFIED
ROUND_TRIP
roundTrip

Alias lama untuk ROUND_TRIP. Tidak digunakan lagi.
ONE_WAY
oneWay

Alias lama untuk ONE_WAY. Tidak digunakan lagi.

ActivationStatus

Status aktivasi objek. Kolom ini mencakup status aktivasi jika bernilai mendukung aktivasi.

Representasi JSON 
{
  "state": enum (State)
}
Kolom
state

enum (State)

Negara Bagian

Enum
UNKNOWN_STATE
NOT_ACTIVATED Tidak Diaktifkan, ini adalah status default
not_activated

Alias lama untuk NOT_ACTIVATED. Tidak digunakan lagi.
ACTIVATED Diaktifkan
activated

Alias lama untuk ACTIVATED. Tidak digunakan lagi.

DeviceContext

Konteks perangkat yang terkait dengan objek.

Representasi JSON 
{
  "deviceToken": string
}
Kolom
deviceToken

string

Jika ditetapkan, informasi penukaran hanya akan dikembalikan ke perangkat yang diberikan setelah objek diaktifkan. ID ini tidak boleh digunakan sebagai ID yang stabil untuk melacak perangkat pengguna. Batas ini dapat berubah di berbagai kartu untuk perangkat yang sama atau bahkan di berbagai aktivasi untuk perangkat yang sama. Saat menyetelnya, pemanggil juga harus menetapkan hasLinkedDevice pada objek yang diaktifkan.

Metode

addmessage

 Menambahkan pesan ke objek transportasi umum yang direferensikan oleh ID objek yang diberikan.

get

 Menampilkan objek transportasi umum dengan ID objek yang diberikan.

insert

 Menyisipkan objek transportasi umum dengan ID dan properti yang diberikan.

list

 Menampilkan daftar semua objek transportasi umum untuk ID penerbit yang diberikan.

patch

 Mengupdate objek transportasi umum yang dirujuk oleh ID objek yang diberikan.

update

 Mengupdate objek transportasi umum yang dirujuk oleh ID objek yang diberikan.