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

string

Bunun ne tür bir kaynak 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 işlemi sırasında alınır.
accountName

string

Bağlılık hesabı sahibinin adı (ör. "Can Demir"). Tam dizenin daha küçük ekranlarda gösterilmesini sağlamak 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ı teklif nesnelerinin listesi. Teklif nesneleri halihazırda mevcut olmalıdır.

Teklif nesne kimlikleri issuer ID biçiminde olmalıdır.identifier: İlk sertifika Google tarafından verilir, ikincisini siz seçersiniz.
secondaryLoyaltyPoints

object (LoyaltyPoints)

İkincil bağlılık ödülü puanları 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 verenin tüm nesneleri genelinde benzersiz olmalıdır. Bu değer issuer ID biçiminde olmalıdır.identifier: İlk sertifika Google tarafından verilir, ikincisini siz seçersiniz. Benzersiz tanımlayıcı sadece alfanümerik karakterler, '.', '_' veya '-' içermelidir.
classId

string

Zorunlu. Bu nesneyle ilişkilendirilen sınıf. Sınıf bu nesne ile aynı türde olmalı, hâlihazırda mevcut olmalı ve onaylanmalıdır.

Sınıf kimlikleri issuer ID biçiminde olmalıdır.identifier: İlk sertifika Google tarafından verilir, ikincisini siz seçersiniz.
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örüntülenen mesaj dizisi. Bu nesnenin tüm kullanıcıları, ilgili mesajları alacaktır. Bu alanların maksimum sayısı 10'dur.
validTimeInterval

object (TimeInterval)

Bu nesnenin active olarak kullanılabileceği dönem. Bu süre geçtikten sonra bir nesnenin durumu expired olarak değiştirilir.
locations[]

object (LatLongPoint)

Not: Şu anda bu alanın coğrafi bildirimleri tetiklemesi desteklenmemektedir.
hasUsers

boolean

Nesnede kullanıcı olup olmadığını gösterir. Bu alan, platform tarafından ayarlanır.
smartTapRedemptionValue

string

Bu nesne için NFC üzerinden Akıllı Dokunma onaylı bir terminale iletilecek değer. Kartın Akıllı Dokunma'yı desteklemesi için enableSmartTap ve redemptionIssuers sınıf düzeyindeki alanları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 ayarlandıysa 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ının kullanması için tasarlanmıştır. Ek 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 geçerlilik sonu bildirimleri gizlenir. Varsayılan olarak, bu alan "false" (yanlış) değerine ayarlanır.

Bu ayar şu anda 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 alanlardan en fazla 1 tanesi nesne düzeyinde, 1'i sınıf nesne düzeyinde gösterilir.
textModulesData[]

object (TextModuleData)

Metin modülü verileri. Sınıfta metin modülü verileri de tanımlanmışsa her ikisi de gösterilir. Bu alanlardan en fazla 10 tanesi nesneden, 10'u ise sınıftan görüntülenebilir.
rotatingBarcode

object (RotatingBarcode)

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

object (Image)

Kartın ön kısmında gösterilen isteğe bağlı banner resmi. Herhangi bir sınıf yoksa sınıfın hero resmi (varsa) gösterilir. Sınıfa ait hero resim de yoksa hiçbir şey görüntülenmez.
groupingInfo

object (GroupingInfo)

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

object (PassConstraints)

Nesne için kısıtlamaları geçirin. Sınırlayıcı NFC ve ekran görüntüsü davranışlarını içerir.

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. Bu, loyaltyPoints ve secondaryLoyaltyPoints için zorunlu bir alandır.
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, tam, çift, para) doldurulmalıdır.
int

integer

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

number

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

object (Money)

Bakiyenin para şeklidir. Bu alt türlerden yalnızca biri (dize, tam, çift, para) doldurulmalıdır.

Yöntemler

addmessage

 Belirtilen nesne kimliği tarafından başvurulan bağlılık nesnesine bir ileti 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 yayıncı kimliği için tüm bağlılık nesnelerinin listesini döndürür.

modifylinkedofferobjects

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

patch

 Belirtilen nesne kimliğinin başvurduğu bağlılık nesnesini günceller.

update

 Belirtilen nesne kimliğinin başvurduğu bağlılık nesnesini günceller.