REST Resource: giftcardclass

Referensi: HadiahCardClass

Representasi JSON 
{
  "kind": string,
  "merchantName": string,
  "programLogo": {
    object (Image)
  },
  "pinLabel": string,
  "eventNumberLabel": string,
  "allowBarcodeRedemption": boolean,
  "localizedMerchantName": {
    object (LocalizedString)
  },
  "localizedPinLabel": {
    object (LocalizedString)
  },
  "localizedEventNumberLabel": {
    object (LocalizedString)
  },
  "cardNumberLabel": string,
  "localizedCardNumberLabel": {
    object (LocalizedString)
  },
  "classTemplateInfo": {
    object (ClassTemplateInfo)
  },
  "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)
  },
  "viewUnlockRequirement": enum (ViewUnlockRequirement),
  "wideProgramLogo": {
    object (Image)
  }
}
Kolom
kind
(deprecated)

string

Mengidentifikasi jenis resource ini. Nilai: string tetap "walletobjects#giftCardClass".
merchantName

string

Nama penjual, seperti "Pakaian Adam". Aplikasi mungkin menampilkan elipsis setelah 20 karakter pertama untuk memastikan string lengkap ditampilkan di layar yang lebih kecil.
pinLabel

string

Label yang akan ditampilkan untuk PIN, seperti "PIN 4 digit".
eventNumberLabel

string

Label yang akan ditampilkan untuk nomor peristiwa, seperti "Peristiwa Target #".
allowBarcodeRedemption

boolean

Menentukan apakah penjual mendukung penukaran kartu voucher menggunakan kode batang. Jika true (benar), aplikasi akan menampilkan kode batang untuk kartu voucher di layar detail Kartu voucher. Jika nilainya adalah salah, kode batang tidak akan ditampilkan.
localizedMerchantName

object (LocalizedString)

String yang diterjemahkan untuk merchantName. Aplikasi mungkin menampilkan elipsis setelah 20 karakter pertama untuk memastikan string lengkap ditampilkan di layar yang lebih kecil.
localizedPinLabel

object (LocalizedString)

String yang diterjemahkan untuk pinLabel.
localizedEventNumberLabel

object (LocalizedString)

Menerjemahkan string untuk eventNumberLabel.
cardNumberLabel

string

Label yang ditampilkan untuk nomor kartu, seperti "Nomor Kartu".
localizedCardNumberLabel

object (LocalizedString)

Menerjemahkan string untuk cardNumberLabel.
classTemplateInfo

object (ClassTemplateInfo)

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

string

Wajib. ID unik untuk class. ID ini harus unik di semua class dari penerbit. Nilai ini harus mengikuti format issuer ID.identifier jika yang pertama diterbitkan oleh Google dan yang kedua dipilih oleh Anda. ID unik Anda 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 dalam aplikasi. Semua pengguna objek ini akan menerima pesan yang terkait. 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 di kolom ini menghasilkan perilaku yang sama persis seperti mengisi URI di linksModuleData (saat objek dirender, link ke halaman beranda akan ditampilkan dalam tempat 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 penyisipan, patch, atau update. Setelah status peninjauan diubah dari draft, status tidak dapat diubah kembali menjadi 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 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 menetapkan kolom ini ke underReview.
review

object (Review)

Komentar ulasan yang ditetapkan oleh platform saat kelas 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 ini yang ditampilkan adalah 1 dari tingkat objek dan 1 untuk tingkat objek kelas.
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 kunci 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 (saat 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 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 kelas 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 diatur warna dominan gambar utama yang 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 singkat dari triplet RGB yaitu #rgb, seperti #fc0.
localizedIssuerName

object (LocalizedString)

String yang diterjemahkan untuk penerbitName. 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 mereferensikan class ini.
callbackOptions

object (CallbackOptions)

Opsi callback yang akan digunakan untuk memanggil kembali penerbit 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 disetel, animasi keamanan akan dirender pada detail kartu.
viewUnlockRequirement

enum (ViewUnlockRequirement)

Lihat opsi Persyaratan Buka Kunci untuk kartu voucher.

Metode

addmessage

 Menambahkan pesan ke kelas kartu voucher yang dirujuk oleh ID kelas yang diberikan.

get

 Menampilkan class kartu voucher dengan ID kelas yang diberikan.

insert

 Menyisipkan class kartu voucher dengan ID dan properti yang diberikan.

list

 Menampilkan daftar semua class kartu voucher untuk ID penerbit tertentu.

patch

 Memperbarui kelas kartu voucher yang dirujuk oleh ID kelas tertentu.

update

 Memperbarui kelas kartu voucher yang dirujuk oleh ID kelas tertentu.