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

string

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

programName

string

Zorunlu. "Adem'in Giyim" gibi bir adı bulunan program adı. Uygulama, dizenin tamamının 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. Tam dizenin daha küçük ekranlarda gösterilmesini sağlamak için önerilen maksimum uzunluk 15 karakterdir.

accountIdLabel

string

"Üye Kimliği" gibi hesap kimliği etiketi. Tam dizenin daha küçük ekranlarda gösterilmesini sağlamak için önerilen maksimum uzunluk 15 karakterdir.

rewardsTierLabel

string

"Ödül Kademesi" gibi ödül katmanı etiketi. Tam dizenin daha küçük ekranlarda gösterilmesini sağlamak için önerilen maksimum uzunluk 9 karakterdir.

rewardsTier

string

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

localizedProgramName

object (LocalizedString)

programName için çevrilmiş dizeler. Uygulama, dizenin tamamının 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 çevrilen dizeler. Tam dizenin daha küçük ekranlarda gösterilmesini sağlamak için önerilen maksimum uzunluk 15 karakterdir.

localizedAccountIdLabel

object (LocalizedString)

accountIdLabel için çevrilmiş dizeler. Tam dizenin daha küçük ekranlarda gösterilmesini sağlamak için önerilen maksimum uzunluk 15 karakterdir.

localizedRewardsTierLabel

object (LocalizedString)

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

localizedRewardsTier

object (LocalizedString)

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

secondaryRewardsTierLabel

string

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

localizedSecondaryRewardsTierLabel

object (LocalizedString)

İkincilÖdülsTierLabel için çevrilmiş dizeler.

secondaryRewardsTier

string

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

localizedSecondaryRewardsTier

object (LocalizedString)

ikincilRewardsTier için çevrilmiş dizeler.

discoverableProgram

object (DiscoverableProgram)

Sınıfın Google Pay uygulamasında nasıl keşfedilip gösterilebileceği hakkında bilgi.

classTemplateInfo

object (ClassTemplateInfo)

Sınıfın nasıl görüntülenmesi gerektiğiyle ilgili şablon bilgileri. Politika ayarlanmazsa Google görüntülenecek varsayılan bir alan grubunu kullanır.

id

string

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

version
(deprecated)

string (int64 format)

Kullanımdan kaldırıldı

issuerName

string

Zorunlu. Veren kuruluş adı. Tam dizenin daha küçük ekranlarda gösterilmesini sağlamak için önerilen maksimum uzunluk 20 karakterdir.

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.

allowMultipleUsersPerObject
(deprecated)

boolean

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

homepageUri

object (Uri)

Uygulamanızın ana sayfasına ait URI. URI'nın bu alana doldurulması, linksModuleData içinde bir URI'nin doldurulmasıyla tam olarak aynı davranışla sonuçlanır (bir nesne oluşturulduğunda, genellikle linkModuleData bölümü olarak düşünülen kısımda ana sayfaya bir bağlantı gösterilir).

locations[]

object (LatLongPoint)

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

reviewStatus

enum (ReviewStatus)

Zorunlu. Sınıfın durumu. Bu alan; ekleme, yama veya güncelleme API çağrıları kullanılarak draft veya 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 tutmalısınız. draft sınıfı, 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 şeklinde ayarlar ve nesne oluşturmak veya taşımak için hemen kullanılabilir.

Halihazırda 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 yorum yorumları.

infoModuleData
(deprecated)

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.

redemptionIssuers[]

string (int64 format)

Kartı veren kuruluşlardan hangilerinin Akıllı Dokunma üzerinden kartı kullanabileceğini tanımlar. Teklif verenler, kartı veren kuruluş kimlikleriyle tanımlanır. Teklifi veren kuruluşlarda en az bir Akıllı Dokunma anahtarı yapılandırılmış olmalıdır.

Bir kartın 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 görüntülemek (kullanıcı söz konusu ülkede değilken) ve içerik kullanıcının yerel ayarında kullanılamadığında yerelleştirilmiş içeriği görüntülemek için kullanılan ülke kodu.

heroImage

object (Image)

Kartın ön kısmında gösterilen isteğe bağlı banner resmi. Herhangi bir şey yoksa herhangi 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 belirler. Bir kartın 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. Ayarlanmazsa hero resmin baskın rengi kullanılır ve hero resim ayarlanmamışsa logoda baskın renk kullanılır. Biçim, rrggbb. sıradadır; burada rrggbb, onaltılık bir RGB üçlüsüdür (ör. #ffcc00). RGB üçlüsünün rgb numarada olan (örneğin #fc0) kısaltılmış halini de kullanabilirsiniz.

localizedIssuerName

object (LocalizedString)

publisherName için çevrilmiş dizeler. Tam dizenin daha küçük ekranlarda gösterilmesini sağlamak için önerilen maksimum uzunluk 20 karakterdir.

multipleDevicesAndHoldersAllowedStatus

enum (MultipleDevicesAndHoldersAllowedStatus)

Birden çok kullanıcının ve cihazın, bu sınıfa referans veren aynı nesneyi kaydedip kaydetmeyeceğini tanımlar.

callbackOptions

object (CallbackOptions)

Bu sınıftaki bir nesnenin son kullanıcı tarafından her kaydedilmesi/silinmesi için vereni geri çağırmak amacıyla kullanılan geri çağırma seçenekleri. Bu sınıfın tüm nesneleri 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

Bir sınıfın Android Pay uygulamasında nasıl keşfedilip gösterilebileceğiyle ilgili bilgiler. Bu işlem için bağlılık veya hediye kartı programı aranır ve taranır ya da manuel olarak girilir.

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

object (DiscoverableProgramMerchantSignupInfo)

Kaydolma ve bir satıcı sitesi aracılığıyla bu program için değerli bir özellik ekleme hakkında bilgiler. MERCHANT_HOSTED_SIGNUP etkinleştirildiğinde kullanılır.

merchantSigninInfo

object (DiscoverableProgramMerchantSigninInfo)

Oturum açma ve bir satıcı sitesi üzerinden bu program için değerli bir özellik 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 programa satıcı tarafından barındırılan kayıt akışıyla ilgili bilgiler.

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

object (Uri)

Kullanıcının, satıcının kayıt sitesi için yönlendirileceği URL.

signupSharedDatas[]

enum (SharedDataType)

Kayıt web sitesi URL'sine POST isteğinde 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ı 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ışıyla ilgili bilgiler.

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

object (Uri)

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

Eyalet

Sıralamalar
STATE_UNSPECIFIED
TRUSTED_TESTERS Yalnızca kartı veren hesaba erişimi olan test kullanıcıları görebilir.
trustedTesters

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

LIVE Herkese görünür.
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ğinin başvurduğu bağlılık sınıfına bir ileti 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 yayıncı 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.