REST Resource: transitobject

{
  "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)
    }
  ]
}

object (TransitClass)

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

string

Nomor tiket. Ini adalah ID unik untuk tiket di sistem operator transportasi umum.

enum (PassengerType)

Jumlah penumpang.

string

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

string

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

enum (TicketStatus)

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

object (LocalizedString)

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

enum (ConcessionCategory)

Kategori tiket diskon.

object (LocalizedString)

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

object (TicketRestrictions)

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

object (PurchaseDetails)

Detail pembelian untuk tiket ini.

object (TicketLeg)

Satu segmen tiket berisi informasi keberangkatan dan kedatangan beserta informasi boarding dan tempat duduk. Jika lebih dari satu segmen akan ditentukan, gunakan kolom ticketLegs. ticketLeg dan ticketLegs tidak boleh ditetapkan.

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.

string

Warna latar belakang untuk kartu. Jika tidak ditetapkan, warna dominan gambar hero akan digunakan, dan jika tidak ada gambar hero 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.

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.

string

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

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 dengan yang pertama diterbitkan oleh Google dan yang kedua dipilih oleh Anda.

string (int64 format)

Tidak digunakan lagi

enum (State)

Wajib. Status objek. Kolom ini digunakan untuk menentukan cara objek ditampilkan di aplikasi. Misalnya, objek inactive dipindahkan ke bagian "Kartu yang habis masa berlakunya".

object (Barcode)

Jenis dan nilai kode batang.

object (Message)

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

object (TimeInterval)

Jangka waktu objek ini akan menjadi active dan objek dapat digunakan. Status objek akan diubah menjadi expired setelah jangka waktu ini berlalu.

object (LatLongPoint)

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

boolean

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

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.

boolean

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

boolean

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

Saat ini, opsi ini hanya dapat ditetapkan untuk penawaran.

object (InfoModuleData)

Tidak digunakan lagi. Sebagai gantinya, gunakan textModulesData.

object (ImageModuleData)

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

object (TextModuleData)

Data modul teks. Jika data modul teks juga ditentukan di class, keduanya akan ditampilkan. Jumlah maksimum kolom ini yang ditampilkan adalah 10 dari objek dan 10 dari class.

object (LinksModuleData)

Menautkan data modul. Jika data modul link juga ditentukan di class, keduanya akan ditampilkan.

object (AppLinkData)

Link aplikasi atau situs opsional yang akan ditampilkan sebagai tombol di bagian depan kartu. Jika AppLinkData disediakan untuk objek class yang sesuai, hanya AppLinkData objek yang akan ditampilkan.

object (ActivationStatus)

Status aktivasi untuk objek. Wajib jika activationOptions telah disetel untuk class.

object (RotatingBarcode)

Jenis dan nilai kode batang yang berputar.

object (DeviceContext)

Konteks perangkat yang terkait dengan objek.

object (Image)

Gambar banner opsional yang ditampilkan di bagian depan kartu. Jika tidak ada, gambar hero class, jika ada, akan ditampilkan. Jika gambar hero kelas juga tidak ada, tidak ada yang akan ditampilkan.

object (GroupingInfo)

Informasi yang mengontrol cara kartu dikelompokkan.

object (PassConstraints)

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

object (SaveRestrictions)

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

string

linkedObjectIds adalah daftar objek lain seperti tiket acara, loyalitas, penawaran, umum, kartu voucher, transportasi umum, dan boarding pass yang harus otomatis dilampirkan ke objek transportasi umum ini. Jika pengguna telah menyimpan kartu multi-trip ini, tertautObjectId ini akan otomatis dimasukkan ke dompet pengguna (kecuali jika mereka 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 batasan jumlah objek yang dapat ditautkan ke satu objek. Setelah batas ini tercapai, objek tertaut baru dalam panggilan akan diabaikan tanpa pemberitahuan.

ID objek harus mengikuti format issuer ID.identifier jika dokumen yang pertama diterbitkan oleh Google dan dokumen yang terakhir dipilih oleh Anda.

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 ditetapkan ke DO_NOT_NOTIFY atau NOTIFICATION_SETTINGS_UNSPECIFIED, tidak ada notifikasi yang akan dipicu. Setelan ini bersifat sementara dan perlu ditetapkan dengan setiap permintaan PATCH atau UPDATE. Jika tidak, notifikasi tidak akan dipicu.

object (ValueAddedModuleData)

Data modul nilai tambah opsional. Maksimum sepuluh pada objek.

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

object (LocalizedString)

Batasan tentang rute yang dapat diambil. Misalnya, hal ini dapat berupa string "Khusus kereta CrossCountry yang dicadangkan".

object (LocalizedString)

Detail selengkapnya tentang routeRestrictions di atas.

object (LocalizedString)

Batasan mengenai waktu penggunaan tiket ini.

object (LocalizedString)

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

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

string

Nomor/ID tanda terima untuk melacak pembelian tiket melalui organisasi yang menjual tiket.

string

Tanggal/waktu pembelian tiket.

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 dan 50,52 detik setelah jam ke-23 pada 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 peristiwa terjadi di New York, waktunya akan sama dengan Waktu Musim Panas Timur (EDT). Perlu diingat bahwa offset bervariasi 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.

Tanpa informasi offset, beberapa fitur lengkap mungkin tidak tersedia.

string

ID akun yang digunakan untuk membeli tiket.

string

Kode konfirmasi untuk pembelian. ID ini mungkin sama untuk beberapa tiket yang berbeda dan digunakan untuk mengelompokkan tiket.

object (TicketCost)

Biaya tiket.

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

object (Money)

Nilai nominal tiket.

object (Money)

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

object (LocalizedString)

Pesan yang menjelaskan jenis diskon apa pun yang diterapkan.

{
  "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)
  }
}

string

Kode stasiun asal. Ini diperlukan jika destinationStationCode ada atau jika originName tidak ada.

object (LocalizedString)

Nama stasiun asal. Ini diperlukan jika desinationName ada atau jika originStationCode tidak ada.

string

Kode stasiun tujuan.

object (LocalizedString)

Nama tujuan.

string

Tanggal/waktu keberangkatan. Ini diperlukan jika tidak ada interval waktu validitas yang ditetapkan pada objek transit.

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 dan 50,52 detik setelah jam ke-23 pada 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 peristiwa terjadi di New York, waktunya akan sama dengan Waktu Musim Panas Timur (EDT). Perlu diingat bahwa offset bervariasi 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". Tanggal/waktu ini harus berupa tanggal/waktu lokal di stasiun asal. Misalnya, jika keberangkatan terjadi pada jam ke-20 tanggal 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.

string

Tanggal/waktu kedatangan.

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 dan 50,52 detik setelah jam ke-23 pada 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 peristiwa terjadi di New York, waktunya akan sama dengan Waktu Musim Panas Timur (EDT). Perlu diingat bahwa offset bervariasi 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.

object (LocalizedString)

Deskripsi/nama singkat tarif untuk segmen perjalanan ini. Misalnya "Satu Kali Penggunaan Kapan Saja".

string

Nama/nomor kereta atau kapal yang harus dinaiki penumpang.

string

Platform atau gate tempat penumpang dapat naik ke gerbong.

string

Zona naik di dalam peron.

object (TicketSeat)

Kursi yang dipesan untuk penumpang. Jika lebih dari satu kursi akan ditentukan, gunakan kolom ticketSeats. ticketSeat dan ticketSeats tidak boleh ditetapkan.

object (TicketSeat)

Kursi yang dipesan untuk penumpang. Jika hanya satu kursi yang akan ditentukan, gunakan kolom ticketSeat. ticketSeat dan ticketSeats tidak boleh ditetapkan.

object (LocalizedString)

Nama operator transportasi umum yang mengoperasikan segmen perjalanan ini.

object (LocalizedString)

Stasiun pengakhir atau tujuan kereta/bus/dll.

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

enum (FareClass)

Kelas tarif kursi yang dibeli tiketnya.

object (LocalizedString)

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

string

ID gerbong kereta tempat kursi yang dibeli tiketnya berada. Misalnya, "10"

string

ID tempat kursi yang dibeli tiketnya berada. Misalnya, "42". Jika tidak ada ID spesifik, gunakan seatAssigment.

object (LocalizedString)

Penetapan kursi penumpang. Misalnya, "tidak ada kursi khusus". Untuk digunakan jika tidak ada ID spesifik yang akan digunakan di seat.

{
  "state": enum (State)
}

enum (State)

{
  "deviceToken": string
}

string

Jika ditetapkan, informasi penukaran hanya akan ditampilkan ke perangkat tertentu setelah objek diaktifkan. ID ini tidak boleh digunakan sebagai ID stabil untuk melacak perangkat pengguna. Hal 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.