REST Resource: giftcardobject

Kaynak: GiftCardObject

JSON gösterimi 
{
  "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)
  },
  "linkedObjectIds": [
    string
  ],
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
Alanlar
kind
(deprecated)

string

Bunun ne tür bir kaynak olduğunu tanımlar. Değer: "walletobjects#giftCardObject" sabit dizesi.
classReference

object (GiftCardClass)

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

string

Zorunlu. Kartın numarası.
pin

string

Kartın PIN'i.
balance

object (Money)

Kartın parasal bakiyesi.
balanceUpdateTime

object (DateTime)

Bakiyenin en son güncellendiği tarih ve saat.

Ofset gereklidir.

Denge güncellenirse ve bu özellik sağlanmazsa sistem varsayılan olarak mevcut saati kullanır.
eventNumber

string

Kartın etkinlik numarası. Bazı hediye kartları tarafından kullanılan isteğe bağlı bir alandı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 burada Google tarafından verilir, ikincisi ise sizin tarafınızdan seçilir. Benzersiz tanımlayıcı yalnızca alfanümerik karakterler, ".", "_" veya "-" işaretlerini içermelidir.
classId

string

Zorunlu. Bu nesneyle ilişkili sınıf. Sınıfın bu nesne ile aynı türde olması, zaten mevcut olması ve onaylanması gerekir.

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örüntüleneceğini belirlemek için kullanılır. Örneğin, bir inactive nesnesi "Süresi dolan kartlar" bölümüne taşınır.
barcode

object (Barcode)

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

object (Message)

Uygulamada gösterilen bir mesaj dizisi. Bu nesnenin tüm kullanıcıları, ilişkili 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[]
(deprecated)

object (LatLongPoint)

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

boolean

Nesnenin kullanıcı 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ı Ödeme'yi desteklemesi için enableSmartTap ve redemptionIssuers sınıf düzeyi alanlarının da doğru şekilde ayarlanması gerekir. 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ı tarafından kullanılmak üzere tasarlanmıştır. Daha fazla bilgi için destek ekibiyle iletişime geçin.
disableExpirationNotification

boolean

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

Şu anda bu ayar yalnızca fırsatlar 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ın gösterilen maksimum sayısı, nesne düzeyinde 1 ve sınıf nesnesi düzeyinde 1'dir.
textModulesData[]

object (TextModuleData)

Metin modülü verileri. Metin modülü verileri de sınıfta tanımlanmışsa her ikisi de gösterilir. Bu alanlar, nesneden en fazla 10 tane ve sınıftan en fazla 10 tane olmak üzere gösterilir.
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ı geçişi kaydetmeye çalışmadan önce doğrulanması gereken nesne kısıtlamaları. Bu kısıtlamaların yalnızca programdan yararlanıldığı sırada geçerli olacağını unutmayın. Kullanıcı geçişi kaydettikten sonra kısıtlamalar değişirse yeni kısıtlamalar, önceden kaydedilmiş geçişlere uygulanmaz.
linkedObjectIds[]

string

linkedObjectIds, bu hediye kartı 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. Kullanıcı bu hediye kartını kaydetmişse bu linkedObjectId'ler kullanıcının cüzdanına otomatik olarak aktarılır (bu tür bağlı kartları almak için ilgili ayarı devre dışı bırakmadığı sürece).

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 nesneyle ilgili alan güncellemelerinin bildirim tetiklemesi gerekip gerekmediği. NOTIFY olarak ayarlandığında, kullanıcılara alan güncelleme bildirimi göndermeye çalışırız. 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 hediye kartı nesnesine bir mesaj ekler.

get

 Belirtilen nesne kimliğine sahip hediye kartı nesnesini döndürür.

insert

 Belirtilen kimliğe ve özelliklere sahip bir hediye kartı nesnesi ekler.

list

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

patch

 Belirtilen nesne kimliğinin referansta bulunduğu hediye kartı nesnesini günceller.

update

 Belirtilen nesne kimliğinin referans verdiği hediye kartı nesnesini günceller.