REST Resource: offerobject

Resource: OfferObject

Representasi JSON
{
  "kind": string,
  "classReference": {
    object (OfferClass)
  },
  "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)
  }
}
Kolom
kind
(deprecated)

string

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

classReference

object (OfferClass)

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

id

string

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

classId

string

Wajib. Class yang terkait dengan objek ini. Class harus memiliki jenis yang sama dengan objek ini, harus sudah ada, dan harus disetujui.

ID class harus mengikuti format issuer ID.identifier file yang pertama diterbitkan oleh Google dan versi kedua dipilih oleh Anda.

version
(deprecated)

string (int64 format)

Tidak digunakan lagi

state

enum (State)

Wajib. Status objek. Kolom ini digunakan untuk menentukan cara objek ditampilkan di aplikasi. Misalnya, objek inactive dipindahkan ke bagian "Masa berlaku kartu habis".

barcode

object (Barcode)

Jenis dan nilai kode batang.

messages[]

object (Message)

Array pesan yang ditampilkan di aplikasi. Semua pengguna objek ini akan menerima pesan terkaitnya. 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 class enableSmartTap dan redemptionIssuers juga harus disiapkan dengan benar agar kartu dapat 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, 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), terlepas dari kolom messages, notifikasi habisnya masa berlaku kepada pengguna akan disembunyikan. Secara default, kolom ini ditetapkan ke false.

Saat ini, setelan ini hanya dapat ditetapkan 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 ditetapkan pada 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 yang ditampilkan di bagian depan kartu. Jika tidak ada satu pun, gambar utama kelas, jika ada, akan ditampilkan. Jika banner besar class juga tidak ada, tidak ada yang akan ditampilkan.

groupingInfo

object (GroupingInfo)

Informasi yang mengontrol cara kartu dikelompokkan bersama.

passConstraints

object (PassConstraints)

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

Metode

addmessage

Menambahkan pesan ke objek penawaran yang dirujuk oleh ID objek yang diberikan.

get

Menampilkan objek penawaran dengan ID objek yang diberikan.

insert

Menyisipkan objek penawaran dengan ID dan properti yang diberikan.

list

Menampilkan daftar semua objek penawaran untuk ID penerbit tertentu.

patch

Memperbarui objek penawaran yang dirujuk oleh ID objek yang diberikan.

update

Memperbarui objek penawaran yang dirujuk oleh ID objek yang diberikan.