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)
  },
  "appLinkData": {
    object (AppLinkData)
  }
}
Alanlar
kind
(deprecated)

string

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

programName

string

Zorunlu. Program adı; ör. "Adem Giyim". Uygulama, tüm dizenin daha küçük ekranlarda gösterilmesini sağlamak için ilk 20 karakterden sonra üç nokta görüntüleyebilir.

accountNameLabel

string

"Üye Adı" gibi hesap adı etiketi. Dizenin tamamının daha küçük ekranlarda gösterilmesi için önerilen maksimum uzunluk 15 karakterdir.

accountIdLabel

string

"Üye Kimliği" gibi hesap kimliği etiketi. Dizenin tamamının daha küçük ekranlarda gösterilmesi için önerilen maksimum uzunluk 15 karakterdir.

rewardsTierLabel

string

"Ödül Katmanı" gibi ödül katmanı etiketi. Tam dizenin daha küçük ekranlarda gösterilmesi için önerilen maksimum uzunluk 9 karakterdir.

rewardsTier

string

Ödül katmanı (ör. "Altın") veya "Platin". Tam dizenin daha küçük ekranlarda gösterilmesi için önerilen maksimum uzunluk 7 karakterdir.

localizedProgramName

object (LocalizedString)

programName için çevrilmiş dizeler. Uygulama, tüm dizenin daha küçük ekranlarda gösterilmesini sağlamak için ilk 20 karakterden sonra üç nokta görüntüleyebilir.

localizedAccountNameLabel

object (LocalizedString)

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

localizedAccountIdLabel

object (LocalizedString)

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

localizedRewardsTierLabel

object (LocalizedString)

RewardsTierLabel için çevrilmiş dizeler. Tam dizenin daha küçük ekranlarda gösterilmesi için önerilen maksimum uzunluk 9 karakterdir.

localizedRewardsTier

object (LocalizedString)

RewardsTier için çevrilmiş dizeler. Tam dizenin daha küçük ekranlarda gösterilmesi için önerilen maksimum uzunluk 7 karakterdir.

secondaryRewardsTierLabel

string

"Ödül Katmanı" gibi ikincil ödül katmanı etiketi.

localizedSecondaryRewardsTierLabel

object (LocalizedString)

İkincil ÖdüllerTierLabel için çevrilen dizeler.

secondaryRewardsTier

string

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

localizedSecondaryRewardsTier

object (LocalizedString)

sFTPsTier için çevrilmiş dizeler.

discoverableProgram

object (DiscoverableProgram)

Sınıfın Google Pay uygulamasında nasıl keşfedilebileceği ve örneklendirilebileceği hakkında bilgiler.

classTemplateInfo

object (ClassTemplateInfo)

Sınıfın nasıl gösterileceğiyle ilgili şablon bilgileri. Politika ayarlanmazsa Google, gösterilecek varsayılan bir grup alana döner.

id

string

Zorunlu. Bir sınıfın benzersiz tanımlayıcısıdır. Bu kimlik, bir kartı veren kuruluşa ait tüm sınıflarda 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ınız yalnızca alfanümerik karakterler, ".", "_" veya "-" içermelidir.

version
(deprecated)

string (int64 format)

Kullanımdan kaldırıldı

issuerName

string

Zorunlu. Kartı veren kuruluşun adı. Dizenin tamamının daha küçük ekranlarda gösterilmesi için önerilen maksimum uzunluk 20 karakterdir.

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.

allowMultipleUsersPerObject
(deprecated)

boolean

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

homepageUri

object (Uri)

Uygulamanızın ana sayfasının URI'sı. Bu alandaki URI'nın doldurulması, linksModuleData içinde bir URI'nin doldurulmasıyla tam olarak aynı davranışla sonuçlanır (bir nesne oluşturulduğunda, genellikle nesnenin linksModuleData bölümü olarak düşünülen ana sayfada bir bağlantı gösterilir).

locations[]

object (LatLongPoint)

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

reviewStatus

enum (ReviewStatus)

Zorunlu. Sınıfın durumu. Bu alan; ekleme, yama veya güncelleme API çağrıları kullanılarak draft ya da underReview olarak ayarlanabilir. draft olan inceleme durumu değiştirildikten sonra tekrar draft olarak değiştirilemez.

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

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

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

review

object (Review)

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

infoModuleData
(deprecated)

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.

redemptionIssuers[]

string (int64 format)

Kartı, Akıllı Dokunma ile kullanmak isteyen kartı veren kuruluşları tanımlar. Tekliften yararlanan kuruluşlar, kartı veren kuruluş kimlikleriyle tanımlanır. Tekliften yararlanan kuruluşların yapılandırılmış en az bir Akıllı Dokunma anahtarı olmalıdır.

Kartın Akıllı Dokunma'yı desteklemesi için enableSmartTap ve nesne düzeyindeki smartTapRedemptionValue özelliklerinden biri olan barkod.value, oraccountId" alanlarının da doğru şekilde ayarlanması gerekir.

countryCode

string

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

heroImage

object (Image)

Kartın ön tarafında görüntülenen isteğe bağlı banner resmi. Etiket yoksa hiçbir şey gösterilmez. Resim, %100 genişlikte görüntülenir.

wordMark
(deprecated)

object (Image)

Kullanımdan kaldırıldı.

enableSmartTap

boolean

Bu sınıfın Akıllı Dokunma'yı destekleyip desteklemediğini tanımlar. Kartın Akıllı Dokunma'yı desteklemesi için redemptionIssuers ve nesne düzeyindeki smartTapRedemptionLevel özelliklerinden biri olan barkod.value, or accountId" alanlarının da doğru şekilde ayarlanması gerekir.

hexBackgroundColor

string

Kartın arka plan rengi. Ayarlanmadan önce hero resmin baskın rengi kullanılır ve hero resim ayarlanmadıysa logonun baskın rengi kullanılır. Biçim, #rrggbb şeklindedir. Burada rrggbb, #ffcc00 gibi onaltılık bir RGB üçlü bileşenidir. Ayrıca, RGB üçlüsünün #rgb olan kısa sürümünü de kullanabilirsiniz (ör. #fc0).

localizedIssuerName

object (LocalizedString)

Veren ismi için çevrilen dizeler. Dizenin tamamının daha küçük ekranlarda gösterilmesi için önerilen maksimum uzunluk 20 karakterdir.

multipleDevicesAndHoldersAllowedStatus

enum (MultipleDevicesAndHoldersAllowedStatus)

Birden fazla kullanıcının ve cihazın, bu sınıfa referans veren aynı nesneyi kaydedip kaydetmeyeceğini belirler.

callbackOptions

object (CallbackOptions)

Son kullanıcı tarafından bu sınıftaki bir nesnenin her kaydedildiğinde/silindiğinde kartı vereni geri çağırmak için kullanılan geri arama 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 ayarlanırsa kart ayrıntılarında bir güvenlik animasyonu oluşturulur.

viewUnlockRequirement

enum (ViewUnlockRequirement)

Bağlılık kartı için Kilit Açma koşulu seçeneklerini görüntüleyin.

DiscoverableProgram

Google Pay uygulamasında sınıfların nasıl keşfedilebileceği ve örneklenebileceği hakkında bilgiler. Bu işlem, bağlılık veya hediye kartı programı aranıp taranarak ya da manuel olarak girilerek yapılır.

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

object (DiscoverableProgramMerchantSignupInfo)

Satıcı sitesi üzerinden kaydolabilme ve bu program için değerli bir araç ekleme hakkında bilgiler. MERCHANT_HOSTED_SIGNUP etkinleştirildiğinde kullanılır.

merchantSigninInfo

object (DiscoverableProgramMerchantSigninInfo)

Oturum açma ve satıcı sitesi üzerinden bu program için değerli eklemeler hakkında bilgiler. MERCHANT_HOSTED_SIGNIN etkinleştirildiğinde kullanılır.

state

enum (State)

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

DiscoverableProgramMerchantSignupInfo

Bir program için 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)

Satıcının kayıt sitesi için kullanıcının yönlendirileceği URL.

signupSharedDatas[]

enum (SharedDataType)

Kayıt web sitesinin URL'sine bir POST isteğinde gönderilen kullanıcı verileri. Bu bilgiler kodlanır ve ardından satıcının web sitesinin, kullanıcıyı bulunabilir programa kaydetmek için kullanılan alanları önceden doldurabilmesi için paylaşılır.

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)

Kullanıcının oturum açma sitesi için kullanıcıyı yönlendireceği URL.

Eyalet

Sıralamalar
STATE_UNSPECIFIED
TRUSTED_TESTERS Yalnızca kartı veren kuruluşun 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 görebilir.
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 kimlik ve özelliklere sahip bir bağlılık sınıfı ekler.

list

Belirli bir düzenleyen 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ği tarafından referans verilen bağlılık sınıfını günceller.

update

Belirtilen sınıf kimliği tarafından referans verilen bağlılık sınıfını günceller.