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)
  }
}
Alanlar
kind
(deprecated)

string

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

object (LoyaltyClass)

Üst sınıfın devralınan alanlarının bir kopyası. Bu alanlar bir 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ı. Önerilen maksimum uzunluk 20 karakterdir.
loyaltyPoints

object (LoyaltyPoints)

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

string

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

Teklif nesne kimlikleri issuer ID biçiminde olmalıdır.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ıdır. Bu kimlik, bir kartı veren kuruluşa ait tüm nesneler 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çermelidir.
classId

string

Zorunlu. Bu nesneyle ilişkilendirilen 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çiminde olmalıdır.identifier burada 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 dolmuş kartlar"a taşınır bölümüne ekleyin.
barcode

object (Barcode)

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

object (Message)

Uygulamada görüntülenen bir dizi mesaj. Bu nesnenin tüm kullanıcıları, nesneyle 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[]

object (LatLongPoint)

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

boolean

Nesnenin kullanıcı 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 ayarlanmamışsa ancak sınıf düzeyi alanları enableSmartTap ve redemptionIssuers 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, bir kullanıcı nesneyi kaydettiğinde ve cihazı 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 "yanlış" değerine ayarlanır.

Şu anda bu ayar yalnızca fırsatlar için ayarlanabilir.
infoModuleData

object (InfoModuleData)

Kullanımdan kaldırıldı. Bunun yerine textModulesData 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. Metin modülü verileri de sınıfta tanımlanmışsa her ikisi de gösterilir. Bu alanlar, nesneden en fazla 10 ve sınıftan en fazla 10 adet alanda görüntülenir.
rotatingBarcode

object (RotatingBarcode)

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

object (Image)

Kartın ön tarafında görüntülenen isteğe bağlı banner resmi. Yoksa, varsa sınıfın hero resmi gösterilir. Sınıfın hero resmi de yoksa hiçbir şey gösterilmez.
groupingInfo

object (GroupingInfo)

Kartların birlikte nasıl gruplandırılacağını belirleyen bilgiler.
passConstraints

object (PassConstraints)

Nesne için kısıtlamaları aktarın. NFC ve ekran görüntüsü alma davranışlarını sınırlandırır.
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 programdan yararlanma süresi boyunca geçerli olacağını unutmayın. Kullanıcı kartı kaydettikten sonra kısıtlamalar değişirse yeni kısıtlamalar daha önce kaydedilmiş kartlara uygulanmaz.

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 (ör. "500") veya "10,00 TL". Önerilen maksimum uzunluk 7 karakterdir. loyaltyPoints ve secondaryLoyaltyPoints alanlarının doldurulması zorunludur.
localizedLabel

object (LocalizedString)

Etiket için çevrilmiş dizeler. Ö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 çift 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ğinin referansta bulunduğu 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 kimlik 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.