REST Resource: offerclass

Resource: OfferClass

Representasi JSON 
{
  "kind": string,
  "title": string,
  "redemptionChannel": enum (RedemptionChannel),
  "provider": string,
  "titleImage": {
    object (Image)
  },
  "details": string,
  "finePrint": string,
  "helpUri": {
    object (Uri)
  },
  "localizedTitle": {
    object (LocalizedString)
  },
  "localizedProvider": {
    object (LocalizedString)
  },
  "localizedDetails": {
    object (LocalizedString)
  },
  "localizedFinePrint": {
    object (LocalizedString)
  },
  "shortTitle": string,
  "localizedShortTitle": {
    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),
  "wideTitleImage": {
    object (Image)
  },
  "appLinkData": {
    object (AppLinkData)
  }
}
Kolom
kind
(deprecated)

string

Mengidentifikasi jenis resource ini. Nilai: string tetap "walletobjects#offerClass".
title

string

Wajib diisi. Judul penawaran, seperti "Diskon 20% untuk kaus apa pun". Panjang maksimum yang disarankan adalah 60 karakter untuk memastikan string lengkap ditampilkan di layar yang lebih kecil.
redemptionChannel

enum (RedemptionChannel)

Wajib diisi. Saluran penukaran yang berlaku untuk penawaran ini.
provider

string

Wajib diisi. Penyedia penawaran (baik nama agregator atau nama penjual). Panjang maksimum yang disarankan adalah 12 karakter untuk memastikan string lengkap ditampilkan di layar yang lebih kecil.
titleImage

object (Image)

Gambar judul penawaran. Gambar ini ditampilkan dalam tampilan detail dan daftar aplikasi.
details

string

Detail penawaran.
finePrint

string

Cetakan kecil atau persyaratan penawaran, seperti "Diskon 20% untuk kaus apa pun di Adam's Apparel".
helpUri

object (Uri)

Link bantuan untuk penawaran, seperti http://myownpersonaldomain.com/help
localizedTitle

object (LocalizedString)

String terjemahan untuk judul. Panjang maksimum yang disarankan adalah 60 karakter untuk memastikan string lengkap ditampilkan di layar yang lebih kecil.
localizedProvider

object (LocalizedString)

Menerjemahkan string untuk penyedia. Panjang maksimum yang disarankan adalah 12 karakter untuk memastikan string lengkap ditampilkan di layar yang lebih kecil.
localizedDetails

object (LocalizedString)

Menerjemahkan string untuk mengetahui detailnya.
localizedFinePrint

object (LocalizedString)

String yang diterjemahkan untuk finePrint.
shortTitle

string

Versi singkat dari judul penawaran, seperti "Diskon 20%", yang ditampilkan kepada pengguna sebagai referensi cepat ke konten penawaran. Panjang maksimum yang disarankan adalah 20 karakter.
localizedShortTitle

object (LocalizedString)

String terjemahan untuk judul singkat. Panjang maksimum yang disarankan adalah 20 karakter.
classTemplateInfo

object (ClassTemplateInfo)

Informasi template tentang cara class harus ditampilkan. Jika tidak disetel, Google akan kembali ke kumpulan kolom default yang akan ditampilkan.
id

string

Wajib diisi. ID unik untuk kelas. ID ini harus unik di semua kelas dari penerbit. Nilai ini harus mengikuti format issuer ID.identifier 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 diisi. Nama penerbit. Panjang maksimum yang disarankan 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 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 di bagian yang biasanya dianggap sebagai bagian linksModuleData objek).
locations[]

object (LatLongPoint)

Catatan: Kolom ini saat ini tidak didukung untuk memicu notifikasi geografis.
reviewStatus

enum (ReviewStatus)

Wajib diisi. Status kelas. Kolom ini dapat disetel ke draft atau Status class. Kolom ini dapat ditetapkan ke draft atau underReview menggunakan panggilan API penyisipan, patch, atau update. Setelah diubah dari draft, status peninjauan tidak dapat diubah kembali menjadi draft.

Anda harus menyimpan kolom ini ke draft saat class dalam pengembangan. Class draft tidak dapat digunakan untuk membuat objek apa pun.

Anda harus menetapkan kolom ini ke underReview jika Anda yakin class ini siap digunakan. Platform akan otomatis menetapkan kolom ini ke approved dan dapat segera digunakan untuk membuat atau memigrasikan objek.

Saat memperbarui class approved yang sudah ada, Anda harus tetap menyetel kolom ini ke underReview.
review

object (Review)

Komentar ulasan yang ditetapkan oleh platform saat class ditandai 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 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 mana 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 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 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 kartu. Jika tidak menetapkan warna dominan, gambar utama akan digunakan, dan jika tidak ada gambar utama 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 disarankan 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 dengan 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 disetel, animasi keamanan akan dirender pada detail kartu.
viewUnlockRequirement

enum (ViewUnlockRequirement)

Lihat opsi Persyaratan Buka Kunci untuk penawaran ini.
wideTitleImage

object (Image)

Gambar judul yang lebar dari penawaran. Jika disediakan, gambar ini akan digunakan sebagai pengganti gambar judul di kiri atas tampilan kartu.

RedemptionChannel

Enum
REDEMPTION_CHANNEL_UNSPECIFIED
INSTORE
instore

Alias lama untuk INSTORE. Tidak digunakan lagi.
ONLINE
online

Alias lama untuk ONLINE. Tidak digunakan lagi.
BOTH
both

Alias lama untuk BOTH. Tidak digunakan lagi.
TEMPORARY_PRICE_REDUCTION
temporaryPriceReduction

Alias lama untuk TEMPORARY_PRICE_REDUCTION. Tidak digunakan lagi.

Metode

addmessage

 Menambahkan pesan ke kelas penawaran yang direferensikan oleh ID kelas yang diberikan.

get

 Menampilkan kelas penawaran dengan ID kelas yang diberikan.

insert

 Menyisipkan class penawaran dengan ID dan properti yang diberikan.

list

 Menampilkan daftar semua class penawaran untuk ID penerbit tertentu.

patch

 Memperbarui kelas penawaran yang dirujuk oleh ID kelas yang diberikan.

update

 Memperbarui kelas penawaran yang dirujuk oleh ID kelas yang diberikan.