REST Resource: transitobject

Sumber daya: 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)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  },
  "linkedObjectIds": [
    string
  ],
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
Kolom
classReference

object (TransitClass)

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

string

Nomor tiket. Ini adalah 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 memberi Google konteks di 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 saat ticketStatus tidak memberikan opsi yang tepat. ticketStatus dan customTicketStatus mungkin tidak ditetapkan.
concessionCategory

enum (ConcessionCategory)

Kategori konsesi untuk tiket.
customConcessionCategory

object (LocalizedString)

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

object (TicketRestrictions)

Informasi tentang jenis batasan yang ada dalam penggunaan tiket ini. Misalnya, pada hari apa tujuan harus digunakan, atau rute mana yang diizinkan untuk diambil.
purchaseDetails

object (PurchaseDetails)

Detail pembelian untuk tiket ini.
ticketLeg

object (TicketLeg)

Satu segmen tiket berisi informasi keberangkatan dan kedatangan beserta informasi boarding dan tempat duduk. Jika lebih dari satu segmen harus ditentukan, gunakan kolom ticketLegs. ticketLeg dan ticketLegs tidak boleh 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 tidak boleh ditetapkan.
hexBackgroundColor

string

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

enum (TripType)

Wajib. Jenis perjalanan yang diwakili oleh objek transportasi umum ini. Digunakan untuk menentukan judul kartu dan/atau simbol yang akan digunakan antara 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 yang pertama diterbitkan oleh Google, dan yang 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 yang pertama diterbitkan oleh Google, dan yang 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 "Kartu yang sudah tidak berlaku".
barcode

object (Barcode)

Jenis dan nilai kode batang.
messages[]

object (Message)

Array pesan yang ditampilkan di aplikasi. Semua pengguna objek ini akan menerima pesan terkait. 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 setelah jangka waktu ini berlalu.
locations[]
(deprecated)

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 kelas enableSmartTap dan redemptionIssuers juga harus disiapkan dengan benar agar kartu 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, yang menautkannya ke perangkat mereka. Dimaksudkan 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), notifikasi tentang masa berlaku kepada pengguna akan disembunyikan, terlepas dari kolom messages. Secara default, kolom ini ditetapkan ke false.

Saat ini, setelan ini hanya dapat disetel 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 ditentukan di class, keduanya akan ditampilkan. Jumlah maksimum kolom yang ditampilkan adalah 10 dari objek dan 10 dari class.
activationStatus

object (ActivationStatus)

Status aktivasi objek. Wajib jika activationOptions telah disetel untuk class.
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, gambar utama kelas, jika ada, akan ditampilkan. Jika banner besar kelas juga tidak ada, tidak ada yang akan ditampilkan.
groupingInfo

object (GroupingInfo)

Informasi yang mengontrol cara kartu dikelompokkan.
passConstraints

object (PassConstraints)

Teruskan batasan untuk objek. Mencakup pembatasan perilaku NFC dan screenshot.
saveRestrictions

object (SaveRestrictions)

Pembatasan pada objek yang perlu diverifikasi sebelum pengguna mencoba menyimpan kartu. Perhatikan bahwa batasan ini hanya akan diterapkan selama waktu penyimpanan. Jika pembatasan berubah setelah pengguna menyimpan kartu, batasan baru tidak akan diterapkan ke kartu yang sudah disimpan.
linkedObjectIds[]

string

linkedObjectId adalah daftar objek lain seperti tiket acara, loyalitas, penawaran, generik, kartu voucher, transportasi umum, dan boarding pass yang harus disertakan secara otomatis ke objek transportasi umum ini. Jika pengguna telah menyimpan kartu multi-trip ini, linkedObjectIds ini akan otomatis dikirim ke dompet pengguna (kecuali jika pengguna menonaktifkan setelan untuk menerima kartu tertaut tersebut).

Pastikan objek yang ada di linkedObjectIds sudah dimasukkan - jika tidak, panggilan akan gagal. Setelah ditautkan, objek tertaut tidak dapat dibatalkan tautannya. Anda tidak dapat menautkan objek milik penerbit lain. Ada batas jumlah objek yang dapat ditautkan ke satu objek. Setelah batas tercapai, objek tertaut baru dalam panggilan akan diabaikan secara otomatis.

ID objek harus mengikuti format issuer ID.identifier dengan yang pertama diterbitkan oleh Google dan yang kedua dipilih oleh Anda.
notifyPreference

enum (NotificationSettingsForUpdates)

Apakah pembaruan kolom pada objek ini harus memicu notifikasi atau tidak. Jika ditetapkan ke NOTIFY, kami akan mencoba memicu notifikasi pembaruan kolom kepada pengguna. Notifikasi ini hanya akan dikirim kepada pengguna jika kolom tersebut merupakan bagian dari daftar yang diizinkan. Jika disetel ke DO_NOT_NOTIFY atau NOTIFICATION_SETTINGS_UNSPECIFIED, tidak ada notifikasi yang akan dipicu. Setelan ini bersifat sementara dan harus disetel dengan setiap permintaan PATCH atau UPDATE. Jika tidak, notifikasi tidak akan dipicu.
valueAddedModuleData[]

object (ValueAddedModuleData)

Data modul nilai tambah opsional. Maksimum sepuluh pada objek.

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 dapat diambil. Misalnya, ini mungkin string "Khusus kereta CrossCountry yang direservasi".
routeRestrictionsDetails

object (LocalizedString)

Detail selengkapnya tentang routeRestrictions di atas.
timeRestrictions

object (LocalizedString)

Batasan mengenai 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 organisasi yang menjual tiket.
purchaseDateTime

string

Tanggal/waktu pembelian tiket.

Ini adalah tanggal/waktu format tambahan ISO 8601, 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 akan menjadi 20 menit 50, 52 detik setelah jam ke-23 tanggal 12 April 1985 dalam UTC.

1985-04-12T19:20:50.52-04:00 akan menjadi 20 menit dan 50,52 detik setelah jam ke-19 pada 12 April 1985, 4 jam sebelum UTC (instan yang sama dengan contoh di atas). Jika acaranya berada di New York, waktu ini akan setara dengan Waktu Musim Panas Timur (EDT). Ingatlah bahwa ada perbedaan waktu di wilayah yang menerapkan Waktu Musim Panas (atau Waktu Musim Panas), bergantung pada waktu dalam setahun.

1985-04-12T19:20:50.52 akan menjadi 20 menit dan 50, 52 detik setelah jam ke-19 tanggal 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. ID ini mungkin sama untuk beberapa tiket yang berbeda dan digunakan untuk mengelompokkan tiket.
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. Ini diperlukan jika destinationStationCode ada atau jika originName tidak ada.
originName

object (LocalizedString)

Nama stasiun asal. 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. Ini diperlukan jika tidak ada interval waktu validitas yang ditetapkan pada objek transit.

Ini adalah tanggal/waktu format diperluas ISO 8601, 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 akan menjadi 20 menit 50, 52 detik setelah jam ke-23 tanggal 12 April 1985 dalam UTC.

1985-04-12T19:20:50.52-04:00 akan menjadi 20 menit dan 50,52 detik setelah jam ke-19 pada 12 April 1985, 4 jam sebelum UTC (instan yang sama dengan contoh di atas). Jika acaranya berada di New York, waktu ini akan setara dengan Waktu Musim Panas Timur (EDT). Ingatlah bahwa ada perbedaan waktu di wilayah yang menerapkan Waktu Musim Panas (atau Waktu Musim Panas), bergantung pada waktu dalam setahun.

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

Bagian tanggal/waktu tanpa offset dianggap sebagai "tanggal/waktu lokal". Ini harus berupa tanggal/waktu setempat di stasiun asal. Misalnya, jika keberangkatan terjadi pada jam 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 tambahan ISO 8601, 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 akan menjadi 20 menit 50, 52 detik setelah jam ke-23 tanggal 12 April 1985 dalam UTC.

1985-04-12T19:20:50.52-04:00 akan menjadi 20 menit dan 50,52 detik setelah jam ke-19 pada 12 April 1985, 4 jam sebelum UTC (instan yang sama dengan contoh di atas). Jika acaranya berada di New York, waktu ini akan setara dengan Waktu Musim Panas Timur (EDT). Ingatlah bahwa ada perbedaan waktu di wilayah yang menerapkan Waktu Musim Panas (atau Waktu Musim Panas), bergantung pada waktu dalam setahun.

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

Bagian tanggal/waktu tanpa offset dianggap sebagai "tanggal/waktu lokal". Ini harus berupa tanggal/waktu lokal di stasiun tujuan. Misalnya, jika peristiwa terjadi pada jam ke-20 tanggal 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/nama singkat tarif untuk segmen perjalanan ini. Misalnya, "Sekali Saja Penggunaan".
carriage

string

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

string

Platform atau gerbang tempat penumpang dapat naik gerbong.
zone

string

Zona naik di dalam peron.
ticketSeat

object (TicketSeat)

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

object (TicketSeat)

Kursi yang dipesan 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 pengakhir 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)

Kelas tarif kursi yang dibeli tiketnya.
customFareClass

object (LocalizedString)

Kelas tarif kustom yang akan digunakan jika tidak ada fareClass yang berlaku. fareClass dan customFareClass tidak boleh ditetapkan.
coach

string

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

string

ID lokasi kursi bertiket. Misalnya, "42". Jika tidak ada ID spesifik, gunakan seatAssigment.
seatAssignment

object (LocalizedString)

Penetapan kursi penumpang. Misalnya, "tidak ada kursi tertentu". Untuk digunakan jika tidak ada ID spesifik yang akan 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 aset berharga 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 ditampilkan ke perangkat tertentu setelah objek diaktifkan. ID ini tidak boleh digunakan sebagai ID yang stabil untuk melacak perangkat pengguna. Nilai 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 dirujuk 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

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

update

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