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

string

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

string

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

enum (RedemptionChannel)

Wajib. Saluran penukaran yang berlaku untuk penawaran ini.
provider

string

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

object (Image)

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

string

Detail penawaran.
finePrint

string

Cetakan kecil atau persyaratan penawaran, seperti "Diskon 20% untuk semua kaus 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 direkomendasikan adalah 60 karakter untuk memastikan string lengkap ditampilkan di layar yang lebih kecil.
localizedProvider

object (LocalizedString)

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

object (LocalizedString)

String terjemahan untuk detailnya.
localizedFinePrint

object (LocalizedString)

String terjemahan 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 direkomendasikan adalah 20 karakter.
localizedShortTitle

object (LocalizedString)

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

object (ClassTemplateInfo)

Informasi template tentang cara kelas ditampilkan. Jika tidak disetel, Google akan kembali ke kumpulan kolom default yang akan 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 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 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[]
(deprecated)

object (LatLongPoint)

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

enum (ReviewStatus)

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

Anda harus menyimpan kolom ini tetap draft saat class 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 ini 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 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 jika konten tidak tersedia di lokalitas 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 dapat 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 heksadesimal, seperti #ffcc00. Anda juga dapat menggunakan versi singkatan triplet RGB yang berupa #rgb, seperti #fc0.
localizedIssuerName

object (LocalizedString)

String terjemahan untuk issuerName. 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 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 kebijakan ini disetel, animasi keamanan akan dirender pada detail kartu.
viewUnlockRequirement

enum (ViewUnlockRequirement)

Lihat opsi Persyaratan Buka Kunci untuk penawaran.
wideTitleImage

object (Image)

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

enum (NotificationSettingsForUpdates)

Apakah pembaruan kolom pada 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 harus disetel 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 kartu dari objek.

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 class penawaran yang dirujuk oleh ID class 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.