REST Resource: transitclass

Resource: TransitClass

Representasi JSON
{
  "transitOperatorName": {
    object (LocalizedString)
  },
  "logo": {
    object (Image)
  },
  "transitType": enum (TransitType),
  "watermark": {
    object (Image)
  },
  "languageOverride": string,
  "customTransitTerminusNameLabel": {
    object (LocalizedString)
  },
  "customTicketNumberLabel": {
    object (LocalizedString)
  },
  "customRouteRestrictionsLabel": {
    object (LocalizedString)
  },
  "customRouteRestrictionsDetailsLabel": {
    object (LocalizedString)
  },
  "customTimeRestrictionsLabel": {
    object (LocalizedString)
  },
  "customOtherRestrictionsLabel": {
    object (LocalizedString)
  },
  "customPurchaseReceiptNumberLabel": {
    object (LocalizedString)
  },
  "customConfirmationCodeLabel": {
    object (LocalizedString)
  },
  "customPurchaseFaceValueLabel": {
    object (LocalizedString)
  },
  "customPurchasePriceLabel": {
    object (LocalizedString)
  },
  "customDiscountMessageLabel": {
    object (LocalizedString)
  },
  "customCarriageLabel": {
    object (LocalizedString)
  },
  "customSeatLabel": {
    object (LocalizedString)
  },
  "customCoachLabel": {
    object (LocalizedString)
  },
  "customPlatformLabel": {
    object (LocalizedString)
  },
  "customZoneLabel": {
    object (LocalizedString)
  },
  "customFareClassLabel": {
    object (LocalizedString)
  },
  "customConcessionCategoryLabel": {
    object (LocalizedString)
  },
  "customFareNameLabel": {
    object (LocalizedString)
  },
  "classTemplateInfo": {
    object (ClassTemplateInfo)
  },
  "enableSingleLegItinerary": boolean,
  "id": string,
  "version": string,
  "issuerName": string,
  "messages": [
    {
      object (Message)
    }
  ],
  "allowMultipleUsersPerObject": boolean,
  "homepageUri": {
    object (Uri)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "reviewStatus": enum (ReviewStatus),
  "review": {
    object (Review)
  },
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "redemptionIssuers": [
    string
  ],
  "countryCode": string,
  "heroImage": {
    object (Image)
  },
  "wordMark": {
    object (Image)
  },
  "enableSmartTap": boolean,
  "hexBackgroundColor": string,
  "localizedIssuerName": {
    object (LocalizedString)
  },
  "multipleDevicesAndHoldersAllowedStatus": enum (MultipleDevicesAndHoldersAllowedStatus),
  "callbackOptions": {
    object (CallbackOptions)
  },
  "securityAnimation": {
    object (SecurityAnimation)
  },
  "activationOptions": {
    object (ActivationOptions)
  },
  "viewUnlockRequirement": enum (ViewUnlockRequirement),
  "wideLogo": {
    object (Image)
  }
}
Kolom
transitOperatorName

object (LocalizedString)

Nama operator transportasi umum.

transitType

enum (TransitType)

Wajib. Jenis transportasi umum yang diwakili oleh class ini, seperti "bus".

watermark

object (Image)

Gambar watermark untuk ditampilkan di perangkat pengguna.

languageOverride

string

Jika kolom ini ada, tiket transportasi umum yang ditayangkan ke perangkat pengguna akan selalu menggunakan bahasa ini. Mewakili tag bahasa BCP 47. Nilai contoh adalah "en-US", "en-GB", "de", atau "de-AT".

customTransitTerminusNameLabel

object (LocalizedString)

Label khusus yang digunakan untuk nilai nama terminal transportasi umum (transitObject.ticketLeg.transitTerminusName).

customTicketNumberLabel

object (LocalizedString)

Label khusus yang digunakan untuk nilai nomor tiket (transitObject.ticketNumber).

customRouteRestrictionsLabel

object (LocalizedString)

Label kustom yang akan digunakan untuk nilai batasan rute (transitObject.ticketRestrictions.routeRestrictions).

customRouteRestrictionsDetailsLabel

object (LocalizedString)

Label kustom yang akan digunakan untuk nilai detail pembatasan rute (transitObject.ticketRestrictions.routeRestrictionsDetails).

customTimeRestrictionsLabel

object (LocalizedString)

Label khusus yang akan digunakan untuk nilai detail batasan waktu (transitObject.ticketRestrictions.timeRestrictions).

customOtherRestrictionsLabel

object (LocalizedString)

Label khusus yang akan digunakan untuk nilai batasan lainnya (transitObject.ticketRestrictions.otherRestrictions).

customPurchaseReceiptNumberLabel

object (LocalizedString)

Label khusus yang digunakan untuk nilai nomor tanda terima pembelian (transitObject.purchaseDetails.purchaseReceiptNumber).

customConfirmationCodeLabel

object (LocalizedString)

Label khusus yang akan digunakan untuk nilai kode konfirmasi (transitObject.purchaseDetails.confirmationCode).

customPurchaseFaceValueLabel

object (LocalizedString)

Label khusus yang digunakan untuk nilai nominal pembelian (transitObject.purchaseDetails.ticketCost.faceValue).

customPurchasePriceLabel

object (LocalizedString)

Label khusus yang akan digunakan untuk nilai harga pembelian (transitObject.purchaseDetails.ticketCost.purchasePrice).

customDiscountMessageLabel

object (LocalizedString)

Label khusus yang akan digunakan untuk nilai pesan diskon transportasi umum (transitObject.purchaseDetails.ticketCost.discountMessage).

customCarriageLabel

object (LocalizedString)

Label khusus yang akan digunakan untuk nilai kereta (transitObject.ticketLeg.carriage).

customSeatLabel

object (LocalizedString)

Label kustom yang akan digunakan untuk nilai lokasi kursi (transitObject.ticketLeg.ticketSeat.seat).

customCoachLabel

object (LocalizedString)

Label khusus yang akan digunakan untuk nilai pelatih (transitObject.ticketLeg.ticketSeat.coach).

customPlatformLabel

object (LocalizedString)

Label khusus yang akan digunakan untuk nilai platform boarding (transitObject.ticketLeg.platform).

customZoneLabel

object (LocalizedString)

Label khusus yang akan digunakan untuk nilai zona naik turun (transitObject.ticketLeg.zone).

customFareClassLabel

object (LocalizedString)

Label khusus yang akan digunakan untuk nilai jenis tiket (transitObject.ticketLeg.ticketSeat.fareClass).

customConcessionCategoryLabel

object (LocalizedString)

Label khusus yang akan digunakan untuk nilai kategori diskon transportasi umum (transitObject.concessionCategory).

customFareNameLabel

object (LocalizedString)

Label khusus yang akan digunakan untuk nilai nama tarif transportasi umum (transitObject.ticketLeg.fareName).

classTemplateInfo

object (ClassTemplateInfo)

Informasi template tentang cara class harus ditampilkan. Jika tidak disetel, Google akan kembali ke kumpulan kolom default untuk ditampilkan.

enableSingleLegItinerary

boolean

Mengontrol tampilan itinerari satu segmen untuk kelas ini. Secara default, itinerari hanya akan ditampilkan untuk perjalanan multi-trip.

id

string

Wajib. ID unik untuk class. ID ini harus unik di semua class 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 '-'.

version
(deprecated)

string (int64 format)

Tidak digunakan lagi

issuerName

string

Wajib. Nama penerbit. Panjang maksimum yang direkomendasikan adalah 20 karakter untuk memastikan string lengkap ditampilkan di layar yang lebih kecil.

messages[]

object (Message)

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

allowMultipleUsersPerObject
(deprecated)

boolean

Tidak digunakan lagi. Sebagai gantinya, gunakan multipleDevicesAndHoldersAllowedStatus.

homepageUri

object (Uri)

URI halaman beranda aplikasi Anda. Mengisi URI dalam kolom ini menghasilkan perilaku yang sama persis dengan mengisi URI di linksModuleData (saat objek dirender, link ke halaman beranda ditampilkan dalam hal yang biasanya dianggap sebagai bagian linksModuleData dari objek).

locations[]

object (LatLongPoint)

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

reviewStatus

enum (ReviewStatus)

Wajib. Status class. Kolom ini dapat ditetapkan ke draft atau underReview menggunakan panggilan API insert, patch, atau update. Setelah diubah dari draft, status peninjauan tidak dapat diubah kembali ke draft.

Anda harus mempertahankan kolom ini ke draft saat class sedang dalam pengembangan. Class draft tidak dapat digunakan untuk membuat objek apa pun.

Anda harus menetapkan kolom ini ke underReview jika Anda yakin bahwa class sudah siap digunakan. Platform akan otomatis menetapkan kolom ini ke approved dan kolom ini dapat segera digunakan untuk membuat atau memigrasikan objek.

Saat memperbarui class approved yang sudah ada, Anda harus terus menyetel kolom ini ke underReview.

review

object (Review)

Komentar ulasan yang ditetapkan oleh platform saat class ditandai sebagai approved atau rejected.

infoModuleData
(deprecated)

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.

redemptionIssuers[]

string (int64 format)

Mengidentifikasi penerbit penukaran mana yang dapat menukarkan kartu melalui Smart Tap. Penerbit penukaran diidentifikasi berdasarkan ID penerbitnya. Penerbit penukaran harus mengonfigurasi setidaknya satu tombol Smart Tap.

Kolom enableSmartTap dan smartTapRedemptionLevel level objek juga harus disiapkan dengan benar agar kartu dapat mendukung Smart Tap.

countryCode

string

Kode negara yang digunakan untuk menampilkan negara kartu (jika pengguna tidak berada di negara tersebut), serta untuk menampilkan konten yang dilokalkan saat konten tidak tersedia di lokal pengguna.

heroImage

object (Image)

Gambar banner opsional yang ditampilkan di bagian depan kartu. Jika tidak ada, tidak ada yang ditampilkan. Gambar akan ditampilkan dengan lebar 100%.

wordMark
(deprecated)

object (Image)

Tidak digunakan lagi.

enableSmartTap

boolean

Mengidentifikasi apakah class ini mendukung Smart Tap. Kolom redemptionIssuers dan smartTapRedemptionLevel level objek juga harus disiapkan dengan benar agar kartu dapat mendukung Smart Tap.

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.

localizedIssuerName

object (LocalizedString)

Menerjemahkan string untuk publisherName. Panjang maksimum yang direkomendasikan adalah 20 karakter untuk memastikan string lengkap ditampilkan di layar yang lebih kecil.

multipleDevicesAndHoldersAllowedStatus

enum (MultipleDevicesAndHoldersAllowedStatus)

Mengidentifikasi apakah beberapa pengguna dan perangkat akan menyimpan objek yang sama yang merujuk class ini.

callbackOptions

object (CallbackOptions)

Opsi callback yang akan digunakan untuk memanggil penerbit kembali untuk setiap penyimpanan/penghapusan objek untuk class ini oleh pengguna akhir. Semua objek class ini memenuhi syarat untuk callback.

securityAnimation

object (SecurityAnimation)

Informasi opsional tentang animasi keamanan. Jika kebijakan ini disetel, animasi keamanan akan dirender pada detail kartu.

activationOptions

object (ActivationOptions)

Opsi aktivasi untuk tiket aktif.

viewUnlockRequirement

enum (ViewUnlockRequirement)

Lihat opsi Persyaratan Buka Kunci untuk tiket transportasi umum.

TransitType

Enum
TRANSIT_TYPE_UNSPECIFIED
BUS
bus

Alias lama untuk BUS. Tidak digunakan lagi.

RAIL
rail

Alias lama untuk RAIL. Tidak digunakan lagi.

TRAM
tram

Alias lama untuk TRAM. Tidak digunakan lagi.

FERRY
ferry

Alias lama untuk FERRY. Tidak digunakan lagi.

OTHER
other

Alias lama untuk OTHER. Tidak digunakan lagi.

ActivationOptions

AktivasiOptions untuk class

Representasi JSON
{
  "activationUrl": string,
  "allowReactivation": boolean
}
Kolom
activationUrl

string

URL HTTPS yang mendukung semantik REST. Akan digunakan untuk meminta aktivasi dari partner untuk nilai penting yang dipicu oleh pengguna.

allowReactivation

boolean

Tandai untuk mengizinkan pengguna melakukan panggilan aktivasi dari perangkat lain. Hal ini memungkinkan klien untuk merender tombol aktivasi yang diaktifkan meskipun meskipun status aktivasi ActivateD diaktifkan tetapi perangkat yang diminta berbeda dengan perangkat saat ini.

Metode

addmessage

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

get

Menampilkan class transportasi umum dengan ID class yang diberikan.

insert

Menyisipkan class transportasi umum dengan ID dan properti yang diberikan.

list

Menampilkan daftar semua class transportasi umum untuk ID penerbit tertentu.

patch

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

update

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