REST Resource: loyaltyobject

Kaynak: LoyaltyObject

JSON gösterimi 
{
  "kind": string,
  "classReference": {
    object (LoyaltyClass)
  },
  "accountName": string,
  "accountId": string,
  "loyaltyPoints": {
    object (LoyaltyPoints)
  },
  "linkedOfferIds": [
    string
  ],
  "secondaryLoyaltyPoints": {
    object (LoyaltyPoints)
  },
  "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#loyaltyObject" sabit dizesi.
classReference

object (LoyaltyClass)

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

string

Bağlılık hesabı sahibinin adı (ör. "Can Demir"). Dizenin tamamının daha küçük ekranlarda gösterilmesi için önerilen maksimum uzunluk 20 karakterdir.
accountId

string

Bağlılık hesabı tanımlayıcısı. Maksimum uzunluk 20 karakterdir.
loyaltyPoints

object (LoyaltyPoints)

Bağlılık ödül puanı etiketi, bakiyesi ve türü.
linkedOfferIds[]

string

Bu bağlılık kartına bağlı fırsat nesnelerinin listesi. Teklif nesneleri zaten mevcut olmalıdır.

Teklif nesne kimlikleri issuer ID biçimini izlemelidir.identifier burada Google tarafından verilir, ikincisi ise sizin tarafınızdan seçilir.
secondaryLoyaltyPoints

object (LoyaltyPoints)

İkincil bağlılık ödül puanı etiketi, bakiyesi ve türü. Birincil bağlılık puanlarına ek olarak gösterilir.
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, 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österilen bir mesaj dizisi. Bu nesnenin tüm kullanıcıları, ilişkili mesajları alır. Bu alanlar en fazla 10 tane olabilir.
validTimeInterval

object (TimeInterval)

Bu nesnenin active olacağı ve nesnenin kullanılabileceği dönem. Bu dönem geçtikten sonra bir nesnenin durumu expired olarak değiştirilir.
locations[]
(deprecated)

object (LatLongPoint)

Not: Şu anda bu alan, coğrafi bildirimleri tetiklemek için desteklenmemektedir.
hasUsers

boolean

Nesnenin kullanıcısı olup olmadığını belirtir. Bu alan platform tarafından ayarlanır.
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.

Bu değer ayarlanmazsa ancak sınıf düzeyindeki enableSmartTap ve redemptionIssuers alanları doğru şekilde ayarlanmışsa barcode.value veya accountId alanları (varsa) yedek olarak kullanılır.
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 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ı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. 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ü alma davranışlarını sınırlandırır.
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 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 bağlılık 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 listesidir. Kullanıcı bu bağlılık 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ı alma ayarını devre dışı bırakmadığı sürece).

LinkedObjectId öğelerindeki nesnelerin eklenmiş olduğundan emin olun. Ekli değilse ç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 YAMA veya GÜNCELLEME isteğinde 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.

LoyaltyPoints

JSON gösterimi 
{
  "label": string,
  "balance": {
    object (LoyaltyPointsBalance)
  },
  "localizedLabel": {
    object (LocalizedString)
  }
}
Alanlar
label

string

"Puanlar" gibi bağlılık puanları etiketi. Önerilen maksimum uzunluk 9 karakterdir.
balance

object (LoyaltyPointsBalance)

Hesap sahibinin bağlılık puanı bakiyesi ("500" veya "10, 00 TL" gibi). Maksimum uzunluk 7 karakterdir. Bu, loyaltyPoints ve secondaryLoyaltyPoints için zorunlu bir alandır.
localizedLabel

object (LocalizedString)

Etiketin çevrilmiş dizeleri. Önerilen maksimum uzunluk 9 karakterdir.

LoyaltyPointsBalance

JSON gösterimi 
{
  "string": string,
  "int": integer,
  "double": number,
  "money": {
    object (Money)
  }
}
Alanlar
string

string

Bakiyenin dize biçimi. Bu alt türlerden yalnızca biri (dize, int, çift, para) doldurulmalıdır.
int

integer

Bakiyenin tam sayı biçimi. Bu alt türlerden yalnızca biri (dize, int, çift, para) doldurulmalıdır.
double

number

Bakiyenin çifte formu. Bu alt türlerden yalnızca biri (dize, int, çift, para) doldurulmalıdır.
money

object (Money)

Bakiyenin para biçimi. Bu alt türlerden yalnızca biri (dize, int, çift, para) doldurulmalıdır.

Yöntemler

addmessage

 Belirtilen nesne kimliği tarafından referans verilen bağlılık nesnesine bir mesaj ekler.

get

 Belirtilen nesne kimliğine sahip bağlılık nesnesini döndürür.

insert

 Belirtilen kimliğe ve özelliklere sahip bir bağlılık nesnesi ekler.

list

 Belirli bir düzenleyen kimliği için tüm bağlılık nesnelerinin listesini döndürür.

modifylinkedofferobjects

 Belirtilen kimlikle bağlılık nesnesi için bağlı teklif nesnelerini değiştirir.

patch

 Belirtilen nesne kimliğinin referans verdiği bağlılık nesnesini günceller.

update

 Belirtilen nesne kimliğinin referans verdiği bağlılık nesnesini günceller.