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,
  "passConstraints": {
    object (PassConstraints)
  },
  "wideLogo": {
    object (Image)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  }
}
Kolom
genericType

enum (GenericType)

Tentukan GenericType yang mencakup kartu tersebut.

cardTitle

object (LocalizedString)

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

subheader

object (LocalizedString)

Label judul kartu, seperti lokasi penggunaan kartu ini. 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 kartu. Jika tidak disetel, warna dominan gambar utama akan digunakan, dan jika tidak ada banner besar yang ditetapkan, warna dominan logo akan digunakan dan jika logo tidak disetel, 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 dengan 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 Kelas harus mengikuti format issuerID.identifier dengan issuerID diterbitkan 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 untuk menyetel Barcode.alternate_text dan hanya menampilkannya.

heroImage

object (Image)

Gambar banner 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. Saat jangka waktu berlalu, objek akan dianggap sudah tidak berlaku, yang akan memengaruhi proses rendering di perangkat pengguna.

imageModulesData[]

object (ImageModuleData)

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

textModulesData[]

object (TextModuleData)

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

groupingInfo

object (GroupingInfo)

Informasi yang mengontrol cara kartu dikelompokkan bersama.

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.

rotatingBarcode

object (RotatingBarcode)

Setelan/detail kode batang yang berputar.

state

enum (State)

Status objek. Kolom ini digunakan untuk menentukan cara objek ditampilkan dalam aplikasi. Misalnya, objek inactive dipindahkan ke "Kartu yang habis masa berlakunya" bagian. Jika informasi ini tidak diberikan, objek akan dianggap sebagai ACTIVE.

hasUsers

boolean

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

passConstraints

object (PassConstraints)

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

saveRestrictions

object (SaveRestrictions)

Batasan 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.

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_OTHER Jenis lainnya

Notifikasi

Menunjukkan apakah objek perlu mengaktifkan notifikasi. Kami hanya mendukung salah satu dari ExpiryNotification/containerNotification. expiryNotification lebih diprioritaskan 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 masa berlaku kartu habis.

upcomingNotification

object (UpcomingNotification)

Notifikasi akan dipicu pada waktu tertentu sebelum kartu dapat digunakan.

ExpiryNotification

Menunjukkan bahwa penerbit ingin Google Wallet mengirimkan pemberitahuan habis masa berlaku 2 hari sebelum masa berlaku kartu habis.

Representasi JSON
{
  "enableNotification": boolean
}
Kolom
enableNotification

boolean

Menunjukkan apakah objek perlu mengaktifkan notifikasi masa berakhir.

UpcomingNotification

Menunjukkan bahwa penerbit ingin Google Wallet mengirimkan pemberitahuan validitas kartu yang akan datang 1 hari sebelum kartu valid/dapat digunakan.

Representasi JSON
{
  "enableNotification": boolean
}
Kolom
enableNotification

boolean

Menunjukkan apakah objek perlu mengaktifkan notifikasi mendatang.

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 umum yang dirujuk oleh ID objek yang diberikan.

update

Memperbarui objek umum yang dirujuk oleh ID objek yang diberikan.