REST Resource: giftcardclass

Kaynak: GiftCardClass

JSON gösterimi
{
  "kind": string,
  "merchantName": string,
  "programLogo": {
    object (Image)
  },
  "pinLabel": string,
  "eventNumberLabel": string,
  "allowBarcodeRedemption": boolean,
  "localizedMerchantName": {
    object (LocalizedString)
  },
  "localizedPinLabel": {
    object (LocalizedString)
  },
  "localizedEventNumberLabel": {
    object (LocalizedString)
  },
  "cardNumberLabel": string,
  "localizedCardNumberLabel": {
    object (LocalizedString)
  },
  "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#giftCardClass" dizesi.

merchantName

string

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

pinLabel

string

PIN için görüntülenecek etiket (ör. "4 haneli PIN").

eventNumberLabel

string

Etkinlik numarası için görüntülenecek etiket (ör. "Hedef Etkinlik Numarası").

allowBarcodeRedemption

boolean

Satıcının, barkod kullanarak hediye kartı kullanımını destekleyip desteklemediğini belirler. Doğru değerine ayarlanırsa uygulama, Hediye kartı ayrıntıları ekranında hediye kartı için bir barkod görüntüler. Yanlış değerine ayarlanırsa barkod gösterilmez.

localizedMerchantName

object (LocalizedString)

merchantName 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.

localizedPinLabel

object (LocalizedString)

pinLabel için çevrilmiş dizeler.

localizedEventNumberLabel

object (LocalizedString)

eventNumberLabel için çevrilen dizeler.

cardNumberLabel

string

Kart numarası için gösterilecek etiket (ör. "Kart Numarası").

localizedCardNumberLabel

object (LocalizedString)

cardNumberLabel için çevrilmiş dizeler.

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ı Ödeme'yi desteklemesi için enableSmartTap ve nesne düzeyinde smartTapRedemptionLevel 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ı Ödeme'yi desteklemesi için redemptionIssuers ve nesne düzeyinde smartTapRedemptionLevel 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)

Hediye kartı için Kilit Açma Şartı seçeneklerini görüntüleyin.

Yöntemler

addmessage

Belirtilen sınıf kimliği tarafından referans verilen hediye kartı sınıfına bir mesaj ekler.

get

Belirtilen sınıf kimliğine sahip hediye kartı sınıfını döndürür.

insert

Belirtilen kimlik ve özelliklere sahip bir hediye kartı sınıfı ekler.

list

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

patch

Belirtilen sınıf kimliğinde referans verilen hediye kartı sınıfını günceller.

update

Belirtilen sınıf kimliğinde referans verilen hediye kartı sınıfını günceller.