REST Resource: giftcardobject

Sumber daya: HadiahCardObject

Representasi JSON
{
  "kind": string,
  "classReference": {
    object (GiftCardClass)
  },
  "cardNumber": string,
  "pin": string,
  "balance": {
    object (Money)
  },
  "balanceUpdateTime": {
    object (DateTime)
  },
  "eventNumber": string,
  "id": string,
  "classId": string,
  "version": string,
  "state": enum (State),
  "barcode": {
    object (Barcode)
  },
  "messages": [
    {
      object (Message)
    }
  ],
  "validTimeInterval": {
    object (TimeInterval)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "hasUsers": boolean,
  "smartTapRedemptionValue": string,
  "hasLinkedDevice": boolean,
  "disableExpirationNotification": boolean,
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "appLinkData": {
    object (AppLinkData)
  },
  "rotatingBarcode": {
    object (RotatingBarcode)
  },
  "heroImage": {
    object (Image)
  },
  "groupingInfo": {
    object (GroupingInfo)
  },
  "passConstraints": {
    object (PassConstraints)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  }
}
Kolom
kind
(deprecated)

string

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

classReference

object (GiftCardClass)

Salinan kolom yang diwarisi dari class induk. Kolom ini diambil selama GET.

cardNumber

string

Wajib diisi. Nomor kartu.

pin

string

PIN kartu.

balance

object (Money)

Saldo uang kartu.

balanceUpdateTime

object (DateTime)

Tanggal dan waktu saldo terakhir diperbarui.

Offset wajib diisi.

Jika saldo diperbarui dan properti ini tidak diberikan, sistem akan ditetapkan secara default ke waktu saat ini.

eventNumber

string

Nomor peristiwa kartu, kolom opsional yang digunakan oleh beberapa kartu voucher.

id

string

Wajib diisi. ID unik untuk objek. ID ini harus unik di semua objek dari penerbit. Nilai ini harus mengikuti format issuer ID.identifier yang pertama diterbitkan oleh Google, dan yang kedua dipilih oleh Anda. ID unik hanya boleh berisi karakter alfanumerik, '.', '_', atau '-'.

classId

string

Wajib diisi. Class yang terkait dengan objek ini. Class harus berjenis sama dengan objek ini, harus sudah ada, dan harus disetujui.

ID Class harus mengikuti format issuer ID.identifier yang pertama diterbitkan oleh Google, dan yang kedua dipilih oleh Anda.

version
(deprecated)

string (int64 format)

Tidak digunakan lagi

state

enum (State)

Wajib diisi. Status objek. Kolom ini digunakan untuk menentukan cara objek ditampilkan dalam aplikasi. Misalnya, objek inactive dipindahkan ke "Kartu yang habis masa berlakunya" bagian.

barcode

object (Barcode)

Jenis dan nilai kode batang.

messages[]

object (Message)

Array pesan yang ditampilkan di aplikasi. Semua pengguna objek ini akan menerima pesan yang terkait. Jumlah maksimum kolom ini adalah 10.

validTimeInterval

object (TimeInterval)

Jangka waktu objek ini akan menjadi active dan objek dapat digunakan. Status objek akan diubah menjadi expired jika jangka waktu ini telah berlalu.

locations[]

object (LatLongPoint)

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

hasUsers

boolean

Menunjukkan apakah objek memiliki pengguna. Kolom ini ditetapkan oleh platform.

smartTapRedemptionValue

string

Nilai yang akan dikirimkan ke terminal bersertifikasi Smart Tap melalui NFC untuk objek ini. Kolom tingkat kelas enableSmartTap dan redemptionIssuers juga harus disiapkan dengan benar agar kartu mendukung Smart Tap. Hanya karakter ASCII yang didukung.

hasLinkedDevice

boolean

Apakah objek ini saat ini ditautkan ke satu perangkat. Kolom ini ditetapkan oleh platform saat pengguna menyimpan objek, yang menautkannya ke perangkat mereka. Ditujukan untuk digunakan oleh partner tertentu. Hubungi dukungan untuk mendapatkan informasi tambahan.

disableExpirationNotification

boolean

Menunjukkan apakah notifikasi harus disembunyikan secara eksplisit. Jika kolom ini disetel ke benar (true), notifikasi tentang masa berlaku kepada pengguna akan disembunyikan, terlepas dari kolom messages. Secara default, kolom ini ditetapkan ke false.

Saat ini, setelan ini hanya dapat disetel untuk penawaran.

infoModuleData

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.

rotatingBarcode

object (RotatingBarcode)

Jenis dan nilai kode batang yang berputar.

heroImage

object (Image)

Gambar banner opsional ditampilkan di bagian depan kartu. Jika tidak ada, gambar utama kelas, jika ada, akan ditampilkan. Jika banner besar kelas juga tidak ada, tidak ada yang akan ditampilkan.

groupingInfo

object (GroupingInfo)

Informasi yang mengontrol cara kartu dikelompokkan bersama.

passConstraints

object (PassConstraints)

Teruskan batasan untuk objek. Termasuk membatasi perilaku NFC dan screenshot.

saveRestrictions

object (SaveRestrictions)

Batasan pada objek yang perlu diverifikasi sebelum pengguna mencoba menyimpan kartu. Perhatikan bahwa batasan ini hanya akan diterapkan selama waktu penyimpanan. Jika pembatasan berubah setelah pengguna menyimpan kartu, batasan baru tidak akan diterapkan ke kartu yang sudah disimpan.

Metode

addmessage

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

get

Menampilkan objek kartu voucher dengan ID objek yang diberikan.

insert

Menyisipkan objek kartu voucher dengan ID dan properti yang diberikan.

list

Menampilkan daftar semua objek kartu voucher untuk ID penerbit yang diberikan.

patch

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

update

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