REST Resource: loyaltyclass

Resource: LoyaltyClass

Representasi JSON 
{
  "kind": string,
  "programName": string,
  "programLogo": {
    object (Image)
  },
  "accountNameLabel": string,
  "accountIdLabel": string,
  "rewardsTierLabel": string,
  "rewardsTier": string,
  "localizedProgramName": {
    object (LocalizedString)
  },
  "localizedAccountNameLabel": {
    object (LocalizedString)
  },
  "localizedAccountIdLabel": {
    object (LocalizedString)
  },
  "localizedRewardsTierLabel": {
    object (LocalizedString)
  },
  "localizedRewardsTier": {
    object (LocalizedString)
  },
  "secondaryRewardsTierLabel": string,
  "localizedSecondaryRewardsTierLabel": {
    object (LocalizedString)
  },
  "secondaryRewardsTier": string,
  "localizedSecondaryRewardsTier": {
    object (LocalizedString)
  },
  "discoverableProgram": {
    object (DiscoverableProgram)
  },
  "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#loyaltyClass".
programName

string

Wajib. Nama program, seperti "Adam's Apparel". Aplikasi mungkin menampilkan elipsis setelah 20 karakter pertama untuk memastikan string lengkap ditampilkan pada layar yang lebih kecil.
accountNameLabel

string

Label nama akun, seperti "Nama Anggota". Panjang maksimum yang direkomendasikan adalah 15 karakter untuk memastikan string lengkap ditampilkan di layar yang lebih kecil.
accountIdLabel

string

Label ID akun, seperti "ID Anggota". Panjang maksimum yang disarankan adalah 15 karakter untuk memastikan string lengkap ditampilkan di layar yang lebih kecil.
rewardsTierLabel

string

Label tingkat reward, seperti "Tingkat Reward". Panjang maksimum yang disarankan adalah 9 karakter untuk memastikan string lengkap ditampilkan di layar yang lebih kecil.
rewardsTier

string

Tingkat reward, seperti "Gold" atau "Platinum". Panjang maksimum yang disarankan adalah 7 karakter untuk memastikan string lengkap ditampilkan di layar yang lebih kecil.
localizedProgramName

object (LocalizedString)

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

object (LocalizedString)

String terjemahan untuk accountNameLabel. Panjang maksimum yang disarankan adalah 15 karakter untuk memastikan string lengkap ditampilkan di layar yang lebih kecil.
localizedAccountIdLabel

object (LocalizedString)

String terjemahan untuk accountIdLabel. Panjang maksimum yang direkomendasikan adalah 15 karakter untuk memastikan string lengkap ditampilkan di layar yang lebih kecil.
localizedRewardsTierLabel

object (LocalizedString)

String terjemahan untuk rewardsTierLabel. Panjang maksimum yang disarankan adalah 9 karakter untuk memastikan string lengkap ditampilkan di layar yang lebih kecil.
localizedRewardsTier

object (LocalizedString)

String yang diterjemahkan untuk rewardTier. Panjang maksimum yang direkomendasikan adalah 7 karakter untuk memastikan string lengkap ditampilkan di layar yang lebih kecil.
secondaryRewardsTierLabel

string

Label tingkat reward sekunder, seperti "Tingkat Reward".
localizedSecondaryRewardsTierLabel

object (LocalizedString)

String yang diterjemahkan untuk sekunderRewardsTierLabel.
secondaryRewardsTier

string

Tingkat reward sekunder, seperti "Gold" atau "Platinum".
localizedSecondaryRewardsTier

object (LocalizedString)

String terjemahan untuk secondaryRewardsTier.
discoverableProgram

object (DiscoverableProgram)

Informasi tentang cara class dapat ditemukan dan dibuat instance-nya dari dalam aplikasi Google Pay.
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 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 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 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 Anda yakin class ini 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 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 Ketuk Smart yang dikonfigurasi.

Kolom enableSmartTap dan salah satu kolom smartTapRedemptionValue tingkat objek, barcode.value, oraccountId` 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 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 salah satu kolom tingkat objek smartTapRedemptionLevel, barcode.value, or accountId` 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 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 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 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 kebijakan ini disetel, animasi keamanan akan dirender pada detail kartu.
viewUnlockRequirement

enum (ViewUnlockRequirement)

Lihat opsi Persyaratan Buka Kunci untuk kartu loyalitas.
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.

DiscoverableProgram

Informasi tentang cara class dapat ditemukan dan dibuat instance-nya dari dalam aplikasi Android Pay. Hal ini dilakukan dengan menelusuri program loyalitas atau kartu voucher, lalu memindai atau memasukkannya secara manual.

Representasi JSON 
{
  "merchantSignupInfo": {
    object (DiscoverableProgramMerchantSignupInfo)
  },
  "merchantSigninInfo": {
    object (DiscoverableProgramMerchantSigninInfo)
  },
  "state": enum (State)
}
Kolom
merchantSignupInfo

object (DiscoverableProgramMerchantSignupInfo)

Informasi tentang kemampuan untuk mendaftar dan menambahkan item berharga untuk program ini melalui situs penjual. Digunakan saat MERCHANT_HOSTED_SIGNUP diaktifkan.
merchantSigninInfo

object (DiscoverableProgramMerchantSigninInfo)

Informasi tentang kemampuan untuk login dan menambahkan item berharga untuk program ini melalui situs penjual. Digunakan saat MERCHANT_HOSTED_SIGNIN diaktifkan.
state

enum (State)

Status visibilitas program yang dapat ditemukan.

DiscoverableProgramMerchantSignupInfo

Informasi tentang alur pendaftaran yang dihosting penjual untuk program.

Representasi JSON 
{
  "signupWebsite": {
    object (Uri)
  },
  "signupSharedDatas": [
    enum (SharedDataType)
  ]
}
Kolom
signupWebsite

object (Uri)

URL yang akan dituju pengguna untuk situs pendaftaran penjual.
signupSharedDatas[]

enum (SharedDataType)

Data pengguna yang dikirim dalam permintaan POST ke URL situs pendaftaran. Informasi ini dienkode lalu dibagikan sehingga situs penjual dapat mengisi otomatis kolom yang digunakan untuk mendaftarkan pengguna ke program yang dapat ditemukan.

SharedDataType

Enum
SHARED_DATA_TYPE_UNSPECIFIED
FIRST_NAME
LAST_NAME
STREET_ADDRESS isian alamat satu baris
ADDRESS_LINE_1 kolom alamat multi-baris
ADDRESS_LINE_2
ADDRESS_LINE_3
CITY
STATE
ZIPCODE
COUNTRY
EMAIL
PHONE

DiscoverableProgramMerchantSigninInfo

Informasi tentang alur login yang dihosting penjual untuk suatu program.

Representasi JSON 
{
  "signinWebsite": {
    object (Uri)
  }
}
Kolom
signinWebsite

object (Uri)

URL yang akan mengarahkan pengguna ke situs login penjual.

Negara Bagian

Enum
STATE_UNSPECIFIED
TRUSTED_TESTERS Hanya dapat dilihat oleh penguji yang memiliki akses ke akun penerbit.
trustedTesters

Alias lama untuk TRUSTED_TESTERS. Tidak digunakan lagi.
LIVE Dapat dilihat oleh semua orang.
live

Alias lama untuk LIVE. Tidak digunakan lagi.
DISABLED Tidak terlihat.
disabled

Alias lama untuk DISABLED. Tidak digunakan lagi.

Metode

addmessage

 Menambahkan pesan ke class loyalitas yang dirujuk oleh ID class yang diberikan.

get

 Menampilkan class loyalitas dengan ID class yang diberikan.

insert

 Menyisipkan class loyalitas dengan ID dan properti yang diberikan.

list

 Menampilkan daftar semua kelas loyalitas untuk ID penerbit tertentu.

patch

 Memperbarui class loyalitas yang dirujuk oleh ID class yang diberikan.

update

 Memperbarui class loyalitas yang dirujuk oleh ID class yang diberikan.