REST Resource: offerobject

Kaynak: OfferObject

JSON gösterimi 
{
  "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)
    }
  ]
}
Alanlar
kind
(deprecated)

string

Bu kaynağın ne tür olduğunu tanımlar. Değer: "walletobjects#offerObject" sabit dizesi.
classReference

object (OfferClass)

Üst sınıfın devralınan alanlarının bir kopyası. Bu alanlar GET sırasında alınır.
id

string

Zorunlu. Bir nesnenin benzersiz tanımlayıcısı. Bu kimlik, bir verenin tüm nesneleri arasında benzersiz olmalıdır. Bu değer issuer ID biçiminde olmalıdır.identifier. Bunlardan ilki Google tarafından verilir, ikincisi ise sizin tarafınızdan seçilir. Benzersiz tanımlayıcı yalnızca alfanümerik karakterler, ".", "_" veya "-" içermelidir.
classId

string

Zorunlu. Bu nesneyle ilişkili sınıf. Sınıf, bu nesneyle aynı türde olmalı, zaten mevcut olmalı ve onaylanmalıdır.

Sınıf kimlikleri issuer ID biçimini izlemelidir.identifier. Bunlardan ilki Google tarafından verilir, ikincisi ise sizin tarafınızdan seçilir.
version
(deprecated)

string (int64 format)

Kullanımdan kaldırıldı
state

enum (State)

Zorunlu. Nesnenin durumu. Bu alan, bir nesnenin uygulamada nasıl gösterileceğini belirlemek için kullanılır. Örneğin, bir inactive nesnesi "Süresi dolmuş kartlar" bölümüne taşınır.
barcode

object (Barcode)

Barkod türü ve değeri.
messages[]

object (Message)

Uygulamada görüntülenen bir mesaj dizisi. Bu nesnenin tüm kullanıcıları, nesneyle ilişkilendirilmiş mesajları alır. Bu alanların maksimum sayısı 10'dur.
validTimeInterval

object (TimeInterval)

Bu nesnenin active olacağı ve nesnenin kullanılabileceği dönem. Bu süre geçtiğinde nesnenin durumu expired olarak değiştirilir.
locations[]

object (LatLongPoint)

Not: Bu alan şu anda coğrafi bildirimleri tetiklemek için desteklenmemektedir.
hasUsers

boolean

Nesnenin kullanıcısı olup olmadığını belirtir. Bu alan platform tarafından belirlenir.
smartTapRedemptionValue

string

Bu nesne için NFC üzerinden Smart Tap sertifikalı bir terminale iletilecek değer. Kartın Akıllı Dokunma'yı desteklemesi için sınıf düzeyindeki enableSmartTap ve redemptionIssuers alanları da doğru şekilde ayarlanmalıdır. Yalnızca ASCII karakterler desteklenir.
hasLinkedDevice

boolean

Bu nesnenin şu anda tek bir cihaza bağlı olup olmadığı. Bu alan, kullanıcı nesneyi kaydedip cihazına bağladığında platform tarafından ayarlanır. Belirli iş ortaklarının kullanımına yöneliktir. Daha fazla bilgi için destek ekibiyle iletişime geçin.
disableExpirationNotification

boolean

Bildirimlerin açıkça engellenip engellenmeyeceğini belirtir. Bu alan doğru değerine ayarlanırsa messages alanından bağımsız olarak kullanıcıya gönderilen süre sonu bildirimleri atlanır. Bu alan varsayılan olarak "false" (yanlış) değerine ayarlıdır.

Bu özellik şu anda yalnızca teklifler için ayarlanabilir.
infoModuleData

object (InfoModuleData)

Kullanımdan kaldırıldı. Bunun yerine textModulesData parametresini kullanın.
imageModulesData[]

object (ImageModuleData)

Resim modülü verileri. Bu alanlar, nesne düzeyinde 1'i, sınıf nesnesi düzeyinde ise 1'i gösterebilir.
textModulesData[]

object (TextModuleData)

Metin modülü verileri. Sınıfta metin modülü verileri de tanımlanmışsa her ikisi de gösterilir. Bu alanların gösterilen maksimum sayısı, nesneden 10 ve sınıftan 10'dur.
rotatingBarcode

object (RotatingBarcode)

Dönen barkod türü ve değeri.
heroImage

object (Image)

Kartın ön tarafında gösterilen isteğe bağlı banner resmi. Hiçbiri yoksa sınıfın hero resmi (varsa) gösterilir. Sınıfın hero resmi de yoksa hiçbir şey gösterilmez.
groupingInfo

object (GroupingInfo)

Kartların nasıl gruplandırılacağını kontrol eden bilgiler.
passConstraints

object (PassConstraints)

Nesne için kısıtlamaları iletin. NFC ve ekran görüntüsü davranışlarını sınırlama da buna dahildir.
saveRestrictions

object (SaveRestrictions)

Kullanıcının kartı kaydetmeye çalışmadan önce doğrulanması gereken nesneyle ilgili kısıtlamalar. Bu kısıtlamaların yalnızca kayıt sırasında uygulanacağını unutmayın. Kullanıcı kartı kaydettikten sonra kısıtlamalar değişirse yeni kısıtlamalar daha önce kaydedilmiş kartlara uygulanmaz.
linkedObjectIds[]

string

linkedObjectIds, bu teklif nesnesine otomatik olarak eklenmesi gereken etkinlik bileti, bağlılık, teklif, genel, hediye kartı, toplu taşıma ve biniş kartı gibi diğer nesnelerin bir listesidir. Bir kullanıcı bu teklifi kaydettiyse bu linkedObjectIds, kullanıcının cüzdanına otomatik olarak gönderilir (bu tür bağlı kartları alma ayarını devre dışı bırakmadıysa).

linkedObjectIds'de bulunan nesnelerin zaten eklendiğinden emin olun. Aksi takdirde çağrılar başarısız olur. Bağlı nesnelerin bağlantısı kaldırılamaz. Başka bir verene ait nesneleri bağlayamazsınız. Tek bir nesneye bağlanabilecek nesne sayısı sınırlıdır. Sınıra ulaşıldığında görüşmedeki yeni bağlı nesneler sessizce yoksayılır.

Nesne kimlikleri issuer ID biçimini izlemelidir.identifier. Bunlardan ilki Google tarafından, ikincisi ise sizin tarafınızdan seçilir.
notifyPreference

enum (NotificationSettingsForUpdates)

Bu nesnede yapılan alan güncellemelerinin bildirimleri tetikleyip tetiklemeyeceğini belirler. BİLDİRİM olarak ayarlandığında kullanıcılara bir alan güncelleme bildirimi göndermeyi deneriz. Bu bildirimler yalnızca alan izin verilenler listesindeyse kullanıcılara gönderilir. DO_NOT_NOTIFY veya NOTIFICATION_SETTINGS_UNSPECIFIED olarak ayarlanırsa bildirim tetiklenmez. Bu ayar geçicidir ve her PATCH veya UPDATE isteğiyle birlikte ayarlanması gerekir. Aksi takdirde bildirim tetiklenmez.
valueAddedModuleData[]

object (ValueAddedModuleData)

İsteğe bağlı katma değer modülü verileri. Nesnede en fazla on tane olabilir.

Yöntemler

addmessage

 Belirtilen nesne kimliği tarafından referans verilen teklif nesnesine bir mesaj ekler.

get

 Belirtilen nesne kimliğine sahip teklif nesnesini döndürür.

insert

 Belirtilen kimliğe ve özelliklere sahip bir teklif nesnesi ekler.

list

 Belirli bir veren kimliği için tüm teklif nesnelerinin listesini döndürür.

patch

 Belirtilen nesne kimliğinin referansta bulunduğu teklif nesnesini günceller.

update

 Belirtilen nesne kimliğinin referansta bulunduğu teklif nesnesini günceller.