REST Resource: genericobject

Resource: GenericObject

Objek Generik

Representasi JSON
{
  "genericType": enum (GenericType),
  "cardTitle": {
    object (LocalizedString)
  },
  "subheader": {
    object (LocalizedString)
  },
  "header": {
    object (LocalizedString)
  },
  "logo": {
    object (Image)
  },
  "hexBackgroundColor": string,
  "notifications": {
    object (Notifications)
  },
  "id": string,
  "classId": string,
  "barcode": {
    object (Barcode)
  },
  "heroImage": {
    object (Image)
  },
  "validTimeInterval": {
    object (TimeInterval)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "appLinkData": {
    object (AppLinkData)
  },
  "groupingInfo": {
    object (GroupingInfo)
  },
  "smartTapRedemptionValue": string,
  "rotatingBarcode": {
    object (RotatingBarcode)
  },
  "state": enum (State),
  "hasUsers": boolean,
  "messages": [
    {
      object (Message)
    }
  ],
  "passConstraints": {
    object (PassConstraints)
  },
  "wideLogo": {
    object (Image)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ],
  "linkedObjectIds": [
    string
  ]
}
Kolom
genericType

enum (GenericType)

Tentukan GenericType yang digunakan kartu.

cardTitle

object (LocalizedString)

Wajib. Header kartu. Nama ini biasanya merupakan nama Bisnis seperti "XXX Gym", "Asuransi AAA". Kolom ini wajib diisi dan muncul di baris header di bagian paling atas kartu.

subheader

object (LocalizedString)

Label judul kartu, seperti lokasi tempat kartu ini dapat digunakan. Muncul tepat di atas judul dalam baris judul di tampilan detail kartu.

header

object (LocalizedString)

Wajib. Judul kartu, seperti "Kupon diskon 50%" atau "Kartu perpustakaan" atau "Voucher". Kolom ini wajib diisi dan muncul di baris judul tampilan detail kartu.

hexBackgroundColor

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. Jika logo tidak ditetapkan, warna akan dipilih oleh Google.

notifications

object (Notifications)

Setelan notifikasi yang diaktifkan untuk objek ini.

id

string

Wajib. ID unik untuk objek. ID ini harus unik di semua objek dari penerbit. Nilai ini harus mengikuti format issuerID.identifier di mana issuerID diterbitkan oleh Google dan identifier dipilih oleh Anda. ID unik hanya dapat berisi karakter alfanumerik, ., _, atau -.

classId

string

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

ID class harus mengikuti format issuerID.identifier dengan issuerID dikeluarkan oleh Google dan identifier dipilih oleh Anda.

barcode

object (Barcode)

Jenis dan nilai kode batang. Jika kartu tidak memiliki kode batang, kami dapat mengizinkan penerbit menyetel Barcode.alternate_text dan hanya menampilkannya.

heroImage

object (Image)

Gambar banner yang ditampilkan di bagian depan kartu jika ada. Gambar akan ditampilkan dengan lebar 100%.

validTimeInterval

object (TimeInterval)

Jangka waktu objek ini akan dianggap valid atau dapat digunakan. Jika jangka waktu berlalu, objek akan dianggap sudah tidak berlaku, yang akan memengaruhi rendering di perangkat pengguna.

imageModulesData[]

object (ImageModuleData)

Data modul gambar. Hanya satu gambar dari class dan satu dari tingkat objek yang akan dirender saat keduanya ditetapkan.

textModulesData[]

object (TextModuleData)

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

groupingInfo

object (GroupingInfo)

Informasi yang mengontrol cara kartu dikelompokkan.

smartTapRedemptionValue

string

Nilai yang akan dikirim 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.

rotatingBarcode

object (RotatingBarcode)

Setelan/detail kode batang yang berputar.

state

enum (State)

Status objek. Kolom ini digunakan untuk menentukan cara objek ditampilkan di aplikasi. Misalnya, objek inactive dipindahkan ke bagian "Kartu yang sudah tidak berlaku". Jika tidak disediakan, objek akan dianggap ACTIVE.

hasUsers

boolean

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

messages[]

object (Message)

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

passConstraints

object (PassConstraints)

Teruskan batasan untuk objek. Termasuk membatasi 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, pembatasan baru tidak akan diterapkan ke kartu yang sudah disimpan.

valueAddedModuleData[]

object (ValueAddedModuleData)

Data modul nilai tambah opsional. Maksimum sepuluh pada objek.

linkedObjectIds[]

string

linkedObjectIds adalah daftar objek lain seperti tiket acara, loyalitas, penawaran, generik, voucher, multi-trip, dan boarding pass yang harus otomatis dilampirkan ke objek generik ini. Jika pengguna telah menyimpan kartu generik ini, linkedObjectIds ini akan otomatis didorong 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 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.

GenericType

Jenis kartu generik.

Enum
GENERIC_TYPE_UNSPECIFIED Jenis generik tidak ditentukan.
GENERIC_SEASON_PASS Tiket masuk musim
GENERIC_UTILITY_BILLS Tagihan utilitas
GENERIC_PARKING_PASS Kartu parkir
GENERIC_VOUCHER Voucher
GENERIC_GYM_MEMBERSHIP Kartu keanggotaan gym
GENERIC_LIBRARY_MEMBERSHIP Kartu keanggotaan perpustakaan
GENERIC_RESERVATIONS Reservasi
GENERIC_AUTO_INSURANCE Kartu asuransi mobil
GENERIC_HOME_INSURANCE Kartu asuransi rumah
GENERIC_ENTRY_TICKET Tiket masuk
GENERIC_RECEIPT Tanda Terima
GENERIC_LOYALTY_CARD Kartu loyalitas. Perhatikan bahwa sebaiknya gunakan jenis kartu Loyalty khusus, bukan jenis umum ini. Jenis kartu loyalitas khusus menawarkan lebih banyak fitur dan fungsi daripada jenis kartu umum.
GENERIC_OTHER Jenis lainnya

Notifikasi

Menunjukkan apakah objek perlu mengaktifkan notifikasi. Kami hanya mendukung salah satu dari ExpiryNotification/UpcomingNotification. expiryNotification lebih diutamakan daripada upcomingNotification. Dengan kata lain, jika expiryNotification ditetapkan, kita akan mengabaikan kolom upcomingNotification.

Representasi JSON
{
  "expiryNotification": {
    object (ExpiryNotification)
  },
  "upcomingNotification": {
    object (UpcomingNotification)
  }
}
Kolom
expiryNotification

object (ExpiryNotification)

Notifikasi akan dipicu pada waktu tertentu sebelum kartu berakhir masa berlakunya.

upcomingNotification

object (UpcomingNotification)

Notifikasi akan dipicu pada waktu tertentu sebelum kartu dapat digunakan.

ExpiryNotification

Menunjukkan bahwa penerbit ingin Google Wallet mengirim notifikasi habis masa berlaku 2 hari sebelum masa berlaku kartu berakhir.

Representasi JSON
{
  "enableNotification": boolean
}
Kolom
enableNotification

boolean

Menunjukkan apakah objek harus mengaktifkan notifikasi habis masa berlaku.

UpcomingNotification

Menunjukkan bahwa penerbit ingin Google Wallet mengirim notifikasi masa berlaku kartu mendatang 1 hari sebelum kartu menjadi valid/dapat digunakan.

Representasi JSON
{
  "enableNotification": boolean
}
Kolom
enableNotification

boolean

Menunjukkan apakah notifikasi mendatang harus diaktifkan untuk objek.

Metode

addmessage

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

get

Menampilkan objek generik dengan ID objek yang diberikan.

insert

Menyisipkan objek generik dengan ID dan properti yang diberikan.

list

Menampilkan daftar semua objek generik untuk ID penerbit tertentu.

patch

Memperbarui objek generik yang dirujuk oleh ID objek yang diberikan.

update

Memperbarui objek generik yang dirujuk oleh ID objek yang diberikan.