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

string

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

object (OfferClass)

Salinan kolom yang diwarisi 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 dengan yang pertama diterbitkan oleh Google dan yang kedua dipilih oleh Anda. ID unik hanya boleh menyertakan karakter alfanumerik, '.', '_', atau '-'.
classId

string

Wajib. 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 dengan yang pertama diterbitkan oleh Google dan yang 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 "Kartu yang sudah tidak berlaku".
barcode

object (Barcode)

Jenis dan nilai kode batang.
messages[]

object (Message)

Array pesan yang ditampilkan di aplikasi. Semua pengguna objek ini akan menerima pesan 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 setelah jangka waktu ini 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 dikirim 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, yang menautkannya ke perangkat mereka. Dimaksudkan 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 salah (false).

Saat ini, opsi 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 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.
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 hero class, jika ada, akan ditampilkan. Jika gambar hero 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)

Pembatasan 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, pembatasan baru tidak akan diterapkan ke kartu yang sudah disimpan.
linkedObjectIds[]

string

linkedObjectIds adalah daftar objek lain seperti tiket acara, loyalitas, penawaran, umum, kartu voucher, multi-trip, dan boarding pass yang harus otomatis dilampirkan ke objek penawaran ini. Jika pengguna telah menyimpan penawaran ini, linkedObjectIds ini akan otomatis dikirim ke dompet pengguna (kecuali jika pengguna menonaktifkan setelan untuk menerima kartu tertaut tersebut).

Pastikan objek yang ada di linkedObjectIds sudah disisipkan - jika tidak, panggilan akan gagal. Setelah ditautkan, objek yang ditautkan tidak dapat dibatalkan tautannya. Anda tidak dapat menautkan objek milik penerbit lain. Ada batas jumlah objek yang dapat ditautkan ke satu objek. Setelah batas ini tercapai, objek tertaut baru dalam panggilan akan diabaikan tanpa pemberitahuan.

ID objek harus mengikuti format issuer ID.identifier dengan yang pertama diterbitkan oleh Google dan yang kedua dipilih oleh Anda.
notifyPreference

enum (NotificationSettingsForUpdates)

Apakah pembaruan kolom pada objek ini harus memicu notifikasi atau tidak. Jika ditetapkan ke NOTIFY, kami akan mencoba memicu notifikasi update kolom kepada pengguna. Notifikasi ini hanya akan dikirim kepada pengguna jika kolomnya merupakan bagian dari daftar yang diizinkan. Jika disetel ke DO_NOT_NOTIFY atau NOTIFICATION_SETTINGS_UNSPECIFIED, 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 pada objek.

Metode

addmessage

 Menambahkan pesan ke objek penawaran yang direferensikan 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.