REST Resource: giftcardclass

Referensi: GIFCardClass

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 jumlah peristiwa, seperti "Target Peristiwa #".
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 (false), kode batang tidak akan ditampilkan.
localizedMerchantName

object (LocalizedString)

Menerjemahkan string 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 akan ditampilkan untuk nomor kartu, seperti "Nomor Kartu".
localizedCardNumberLabel

object (LocalizedString)

Menerjemahkan string untuk cardNumberLabel.
classTemplateInfo

object (ClassTemplateInfo)

Informasi template tentang cara class harus 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 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.
viewUnlockRequirement

enum (ViewUnlockRequirement)

Lihat opsi Persyaratan Buka Kunci untuk kartu voucher.

Metode

addmessage

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

get

 Menampilkan kelas kartu voucher dengan ID kelas yang diberikan.

insert

 Menyisipkan kelas kartu voucher dengan ID dan properti yang diberikan.

list

 Menampilkan daftar semua kelas kartu voucher untuk ID penerbit tertentu.

patch

 Memperbarui class kartu voucher yang dirujuk oleh ID class yang diberikan.

update

 Memperbarui class kartu voucher yang dirujuk oleh ID class yang diberikan.