REST Resource: giftcardclass

Resource: GiftCardClass

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)
  },
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "appLinkData": {
    object (AppLinkData)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
Kolom
kind
(deprecated)

string

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

string

Nama penjual, seperti "Adam's Apparel". Aplikasi dapat 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 salah, kode batang tidak akan ditampilkan.
localizedMerchantName

object (LocalizedString)

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

object (LocalizedString)

Menerjemahkan string untuk pinLabel.
localizedEventNumberLabel

object (LocalizedString)

String yang diterjemahkan untuk eventNumberLabel.
cardNumberLabel

string

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

object (LocalizedString)

String terjemahan untuk cardNumberLabel.
classTemplateInfo

object (ClassTemplateInfo)

Informasi template tentang cara kelas ditampilkan. Jika tidak ditetapkan, 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 dengan yang pertama diterbitkan oleh Google dan yang kedua dipilih oleh Anda. ID unik Anda hanya boleh menyertakan 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 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 akan menghasilkan perilaku yang sama persis dengan mengisi URI di linksModuleData (saat objek dirender, link ke halaman beranda ditampilkan di bagian yang biasanya dianggap sebagai bagian linksModuleData dari objek).
locations[]
(deprecated)

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 sisipan, patch, atau update. Setelah status peninjauan diubah dari draft, status tersebut 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 yakin class sudah siap digunakan. Platform akan otomatis menetapkan kolom ini ke approved dan dapat langsung digunakan untuk membuat atau memigrasikan objek.

Saat mengupdate class yang sudah approved, Anda harus terus menetapkan kolom ini ke underReview.
review

object (Review)

Komentar ulasan yang ditetapkan oleh platform saat kelas ditandai 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 class.
textModulesData[]

object (TextModuleData)

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

string (int64 format)

Mengidentifikasi penerbit penukaran yang dapat menukarkan kartu melalui Smart Tap. Penerbit penukaran diidentifikasi berdasarkan ID penerbitnya. Penerbit penukaran harus memiliki setidaknya satu kunci Smart Tap yang dikonfigurasi.

Kolom enableSmartTap dan smartTapRedemptionLevel tingkat 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 jika konten tidak tersedia dalam lokal pengguna.
heroImage

object (Image)

Gambar banner opsional yang ditampilkan di bagian depan kartu. Jika tidak ada, tidak ada yang akan 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 tingkat objek juga harus disiapkan dengan benar agar kartu mendukung Smart Tap.
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. Formatnya adalah #rrggbb dengan rrggbb adalah triplet RGB hex, seperti #ffcc00. Anda juga dapat menggunakan versi singkat 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 penerbit kembali setiap kali objek disimpan/dihapus untuk class ini oleh pengguna akhir. Semua objek class ini memenuhi syarat untuk callback.
securityAnimation

object (SecurityAnimation)

Informasi opsional tentang animasi keamanan. Jika ditetapkan, animasi keamanan akan dirender pada detail kartu.
viewUnlockRequirement

enum (ViewUnlockRequirement)

Lihat opsi Persyaratan Buka Kunci untuk kartu voucher.
notifyPreference

enum (NotificationSettingsForUpdates)

Apakah pembaruan kolom ke class ini akan memicu notifikasi atau tidak. Jika ditetapkan ke NOTIFY, kami akan mencoba memicu notifikasi pembaruan kolom kepada pengguna. Notifikasi ini hanya akan dikirim kepada pengguna jika kolom tersebut merupakan bagian dari daftar yang diizinkan. Jika tidak ditentukan, tidak ada notifikasi yang akan dipicu. Setelan ini bersifat sementara dan perlu ditetapkan dengan setiap permintaan PATCH atau UPDATE. Jika tidak, notifikasi tidak akan dipicu.
valueAddedModuleData[]

object (ValueAddedModuleData)

Data modul nilai tambah opsional. Maksimum sepuluh di kelas. Untuk kartu, hanya sepuluh yang akan ditampilkan, dengan memprioritaskan metrik dari objek.

Metode

addmessage

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

get

 Menampilkan class kartu voucher dengan ID class 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 class kartu voucher yang dirujuk oleh ID class yang diberikan.

update

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