REST Resource: loyaltyclass

Kaynak: LoyaltyClass

JSON gösterimi 
{
  "kind": string,
  "programName": string,
  "programLogo": {
    object (Image)
  },
  "accountNameLabel": string,
  "accountIdLabel": string,
  "rewardsTierLabel": string,
  "rewardsTier": string,
  "localizedProgramName": {
    object (LocalizedString)
  },
  "localizedAccountNameLabel": {
    object (LocalizedString)
  },
  "localizedAccountIdLabel": {
    object (LocalizedString)
  },
  "localizedRewardsTierLabel": {
    object (LocalizedString)
  },
  "localizedRewardsTier": {
    object (LocalizedString)
  },
  "secondaryRewardsTierLabel": string,
  "localizedSecondaryRewardsTierLabel": {
    object (LocalizedString)
  },
  "secondaryRewardsTier": string,
  "localizedSecondaryRewardsTier": {
    object (LocalizedString)
  },
  "discoverableProgram": {
    object (DiscoverableProgram)
  },
  "classTemplateInfo": {
    object (ClassTemplateInfo)
  },
  "id": string,
  "version": string,
  "issuerName": string,
  "messages": [
    {
      object (Message)
    }
  ],
  "allowMultipleUsersPerObject": boolean,
  "homepageUri": {
    object (Uri)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "reviewStatus": enum (ReviewStatus),
  "review": {
    object (Review)
  },
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "redemptionIssuers": [
    string
  ],
  "countryCode": string,
  "heroImage": {
    object (Image)
  },
  "wordMark": {
    object (Image)
  },
  "enableSmartTap": boolean,
  "hexBackgroundColor": string,
  "localizedIssuerName": {
    object (LocalizedString)
  },
  "multipleDevicesAndHoldersAllowedStatus": enum (MultipleDevicesAndHoldersAllowedStatus),
  "callbackOptions": {
    object (CallbackOptions)
  },
  "securityAnimation": {
    object (SecurityAnimation)
  },
  "viewUnlockRequirement": enum (ViewUnlockRequirement),
  "wideProgramLogo": {
    object (Image)
  },
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "appLinkData": {
    object (AppLinkData)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
Alanlar
kind
(deprecated)

string

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

string

Zorunlu. Program adı (ör. "Adam's Apparel"). Uygulama, daha küçük ekranlarda dizenin tamamının gösterilmesini sağlamak için ilk 20 karakterden sonra üç nokta simgesi gösterebilir.
accountNameLabel

string

Hesap adı etiketi (ör. "Üye Adı"). Küçük ekranlarda dizenin tamamının gösterilmesi için önerilen maksimum uzunluk 15 karakterdir.
accountIdLabel

string

Hesap kimliği etiketi (ör. "Üye kimliği"). Küçük ekranlarda dizenin tamamının gösterilmesi için önerilen maksimum uzunluk 15 karakterdir.
rewardsTierLabel

string

Ödül katmanı etiketi ("Ödül Katmanı" gibi). Daha küçük ekranlarda dizenin tamamının gösterilmesi için önerilen maksimum uzunluk 9 karakterdir.
rewardsTier

string

"Altın" veya "Platin" gibi ödül katmanı. Daha küçük ekranlarda dizenin tamamının gösterilmesi için önerilen maksimum uzunluk 7 karakterdir.
localizedProgramName

object (LocalizedString)

programName için çevrilmiş dizeler. Uygulama, daha küçük ekranlarda dizenin tamamının gösterilmesini sağlamak için ilk 20 karakterden sonra üç nokta simgesi gösterebilir.
localizedAccountNameLabel

object (LocalizedString)

accountNameLabel için çevrilmiş dizeler. Küçük ekranlarda dizenin tamamının gösterilmesi için önerilen maksimum uzunluk 15 karakterdir.
localizedAccountIdLabel

object (LocalizedString)

accountIdLabel için çevrilmiş dizeler. Küçük ekranlarda dizenin tamamının gösterilmesi için önerilen maksimum uzunluk 15 karakterdir.
localizedRewardsTierLabel

object (LocalizedString)

rewardsTierLabel için çevrilmiş dizeler. Daha küçük ekranlarda dizenin tamamının gösterilmesi için önerilen maksimum uzunluk 9 karakterdir.
localizedRewardsTier

object (LocalizedString)

rewardsTier için çevrilmiş dizeler. Daha küçük ekranlarda dizenin tamamının gösterilmesi için önerilen maksimum uzunluk 7 karakterdir.
secondaryRewardsTierLabel

string

İkincil ödül katmanı etiketi ("Ödül Katmanı" gibi).
localizedSecondaryRewardsTierLabel

object (LocalizedString)

secondaryRewardsTierLabel için çevrilmiş dizeler.
secondaryRewardsTier

string

"Altın" veya "Platin" gibi ikincil ödül katmanı.
localizedSecondaryRewardsTier

object (LocalizedString)

secondaryRewardsTier için çevrilmiş dizeler.
discoverableProgram

object (DiscoverableProgram)

Sınıfın Google Pay uygulamasından nasıl bulunabileceği ve örneklendirilebileceği hakkında bilgi.
classTemplateInfo

object (ClassTemplateInfo)

Sınıfın nasıl gösterileceğiyle ilgili şablon bilgileri. Ayarlanmazsa Google, gösterilecek varsayılan bir alan grubuna geri döner.
id

string

Zorunlu. Sınıfın benzersiz tanımlayıcısı. Bu kimlik, bir verenin tüm sınıfları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ınız yalnızca alfanümerik karakterler, ".", "_" veya "-" işaretlerini içermelidir.
version
(deprecated)

string (int64 format)

Kullanımdan kaldırıldı
issuerName

string

Zorunlu. Veren kurumun adı. Küçük ekranlarda dizenin tamamının gösterilmesi için önerilen maksimum uzunluk 20 karakterdir.
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.
allowMultipleUsersPerObject
(deprecated)

boolean

Kullanımdan kaldırıldı. Bunun yerine multipleDevicesAndHoldersAllowedStatus kullanın.
homepageUri

object (Uri)

Uygulamanızın ana sayfasının URI'si. Bu alandaki URI'nin doldurulması, linksModuleData alanındaki URI'nin doldurulmasıyla tam olarak aynı davranışa neden olur (bir nesne oluşturulduğunda, genellikle nesnenin linksModuleData bölümü olarak düşünülen yerde ana sayfanın bağlantısı gösterilir).
locations[]
(deprecated)

object (LatLongPoint)

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

enum (ReviewStatus)

Zorunlu. Sınıfın durumu. Bu alan, insert, patch veya update API çağrıları kullanılarak draft veya underReview olarak ayarlanabilir. İnceleme durumu draft olarak değiştirildikten sonra draft olarak geri değiştirilemez.

Sınıf geliştirme aşamasındayken bu alanı draft olarak tutmanız gerekir. draft sınıfı, herhangi bir nesne oluşturmak için kullanılamaz.

Sınıfın kullanıma hazır olduğunu düşündüğünüzde bu alanı underReview olarak ayarlamanız gerekir. Platform bu alanı otomatik olarak approved olarak ayarlar ve nesne oluşturmak veya taşımak için hemen kullanılabilir.

Zaten approved sınıfı olan bir sınıfı güncellerken bu alanı underReview olarak ayarlamaya devam etmeniz gerekir.
review

object (Review)

Bir sınıf approved veya rejected olarak işaretlendiğinde platform tarafından ayarlanan yorumlar.
infoModuleData
(deprecated)

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.
redemptionIssuers[]

string (int64 format)

Akıllı Dokunma üzerinden geçişi hangi ödeme kartı sağlayıcılarının kullanabileceğini tanımlar. Kullanım kodu verenler, veren kimlikleriyle tanımlanır. Kullanım için ödeme yapanların en az bir Smart Tap anahtarı yapılandırılmış olmalıdır.

Bir geçişin Akıllı Dokunma'yı desteklemesi için enableSmartTap ve nesne düzeyindeki smartTapRedemptionValue, barcode.value, oraccountId` alanlarından biri de doğru şekilde ayarlanmalıdır.
countryCode

string

Kartın ülkesini (kullanıcı o ülkede değilken) görüntülemek ve içerik kullanıcının yerel dilinde mevcut olmadığında yerelleştirilmiş içerik görüntülemek için kullanılan ülke kodu.
heroImage

object (Image)

Kartın ön tarafında gösterilen isteğe bağlı banner resmi. Hiçbiri yoksa hiçbir şey görüntülenmez. Resim% 100 genişlikte gösterilir.
wordMark
(deprecated)

object (Image)

Kullanımdan kaldırıldı.
enableSmartTap

boolean

Bu sınıfın Akıllı Dokunma'yı destekleyip desteklemediğini belirtir. Bir geçişin Akıllı Dokunma'yı desteklemesi için redemptionIssuers ve nesne düzeyindeki smartTapRedemptionLevel, barcode.value, or accountId` alanlarından biri de doğru şekilde ayarlanmalıdır.
hexBackgroundColor

string

Kartın arka plan rengi. Ayarlanmamışsa hero resminin baskın rengi, ayarlanmamışsa logonun baskın rengi kullanılır. Biçim #rrggbb şeklindedir. Burada rrggbb, #ffcc00 gibi bir onaltılık RGB üçlüsüdür. RGB üçlüsünün kısaltılmış sürümünü de kullanabilirsiniz. Bu sürüm, #rgb şeklindedir (ör. #fc0).
localizedIssuerName

object (LocalizedString)

issuerName için çevrilmiş dizeler. Küçük ekranlarda dizenin tamamının gösterilmesi için önerilen maksimum uzunluk 20 karakterdir.
multipleDevicesAndHoldersAllowedStatus

enum (MultipleDevicesAndHoldersAllowedStatus)

Birden fazla kullanıcı ve cihazın bu sınıfa atıfta bulunan aynı nesneyi kaydedip kaydetmeyeceğini tanımlar.
callbackOptions

object (CallbackOptions)

Son kullanıcı tarafından bu sınıfa ait bir nesnenin her kaydedilmesi/sildirilmesi için yayıncıyı geri aramak üzere kullanılacak geri çağırma seçenekleri. Bu sınıftaki tüm nesneler geri çağırma için uygundur.
securityAnimation

object (SecurityAnimation)

Güvenlik animasyonu hakkında isteğe bağlı bilgiler. Bu ayar etkinleştirilirse geçiş ayrıntılarında bir güvenlik animasyonu oluşturulur.
viewUnlockRequirement

enum (ViewUnlockRequirement)

Bağlılık kartı için Kilit Açma Şartı seçeneklerini görüntüleyin.
notifyPreference

enum (NotificationSettingsForUpdates)

Bu sınıftaki 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. Belirtilmemişse 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. Sınıftaki maksimum öğrenci sayısı ondur. Bir geçiş için yalnızca on tane gösterilir ve nesneden gelenlere öncelik verilir.

DiscoverableProgram

Bir sınıfın Android Pay uygulamasından nasıl bulunabileceği ve oluşturulabileceği hakkında bilgi. Bu işlem, bağlılık veya hediye kartı programı aranıp taranarak ya da manuel olarak girerek yapılır.

JSON gösterimi 
{
  "merchantSignupInfo": {
    object (DiscoverableProgramMerchantSignupInfo)
  },
  "merchantSigninInfo": {
    object (DiscoverableProgramMerchantSigninInfo)
  },
  "state": enum (State)
}
Alanlar
merchantSignupInfo

object (DiscoverableProgramMerchantSignupInfo)

Satıcı sitesi üzerinden bu programa kaydolma ve program için değerli bir öğe ekleme hakkında bilgi. MERCHANT_HOSTED_SIGNUP etkinleştirildiğinde kullanılır.
merchantSigninInfo

object (DiscoverableProgramMerchantSigninInfo)

Bir satıcı sitesi üzerinden oturum açma ve bu program için değerli bir öğe ekleme hakkında bilgi. MERCHANT_HOSTED_SIGNIN etkinleştirildiğinde kullanılır.
state

enum (State)

Bulunabilir programın görünürlük durumu.

DiscoverableProgramMerchantSignupInfo

Bir programın satıcı tarafından barındırılan kayıt akışı hakkında bilgi.

JSON gösterimi 
{
  "signupWebsite": {
    object (Uri)
  },
  "signupSharedDatas": [
    enum (SharedDataType)
  ]
}
Alanlar
signupWebsite

object (Uri)

Kullanıcının, satıcının kayıt sitesine yönlendirileceği URL.
signupSharedDatas[]

enum (SharedDataType)

Kaydolma web sitesi URL'sine POST isteğiyle gönderilen kullanıcı verileri. Bu bilgiler kodlanır ve ardından paylaşılır. Böylece satıcının web sitesi, kullanıcıyı bulunabilir programa kaydetmek için kullanılan alanları önceden doldurabilir.

SharedDataType

Sıralamalar
SHARED_DATA_TYPE_UNSPECIFIED
FIRST_NAME
LAST_NAME
STREET_ADDRESS tek satırlık adres alanı
ADDRESS_LINE_1 çok satırlı adres alanları
ADDRESS_LINE_2
ADDRESS_LINE_3
CITY
STATE
ZIPCODE
COUNTRY
EMAIL
PHONE

DiscoverableProgramMerchantSigninInfo

Bir program için satıcı tarafından barındırılan oturum açma akışı hakkında bilgi.

JSON gösterimi 
{
  "signinWebsite": {
    object (Uri)
  }
}
Alanlar
signinWebsite

object (Uri)

Satıcının oturum açma sitesine yönlendirilecek URL.

Eyalet

Sıralamalar
STATE_UNSPECIFIED
TRUSTED_TESTERS Yalnızca ihraççı hesabına erişimi olan test kullanıcıları tarafından görülebilir.
trustedTesters

TRUSTED_TESTERS için eski takma ad. Kullanımdan kaldırıldı.
LIVE Herkes tarafından görülebilir.
live

LIVE için eski takma ad. Kullanımdan kaldırıldı.
DISABLED Görünmez.
disabled

DISABLED için eski takma ad. Kullanımdan kaldırıldı.

Yöntemler

addmessage

 Belirtilen sınıf kimliği tarafından referans verilen bağlılık sınıfına bir mesaj ekler.

get

 Belirtilen sınıf kimliğine sahip bağlılık sınıfını döndürür.

insert

 Belirtilen kimliğe ve özelliklere sahip bir bağlılık sınıfı ekler.

list

 Belirli bir kart veren kimliği için tüm bağlılık sınıflarının listesini döndürür.

patch

 Belirtilen sınıf kimliğinin referans verdiği bağlılık sınıfını günceller.

update

 Belirtilen sınıf kimliğinin referans verdiği bağlılık sınıfını günceller.