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)
  },
  "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#giftCardClass" sabit dizesi.
merchantName

string

Satıcı 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.
pinLabel

string

PIN için gösterilecek etiket ("4 haneli PIN" gibi).
eventNumberLabel

string

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

boolean

Satıcının, hediye kartını barkod kullanarak kullanmayı destekleyip desteklemediğini belirler. Doğru ise uygulama, hediye kartı ayrıntıları ekranında hediye kartının barkodunu gösterir. Yanlış ise barkod gösterilmez.
localizedMerchantName

object (LocalizedString)

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

object (LocalizedString)

pinLabel için çevrilmiş dizeler.
localizedEventNumberLabel

object (LocalizedString)

eventNumberLabel için çevrilmiş dizeler.
cardNumberLabel

string

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

object (LocalizedString)

cardNumberLabel için çevrilmiş dizeler.
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ı genelinde 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üzeyi smartTapRedemptionLevel alanları da 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üzeyi smartTapRedemptionLevel alanları da 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)

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

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 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ğinin referans verdiği hediye kartı sınıfını günceller.

update

 Belirtilen sınıf kimliğinin referans verdiği hediye kartı sınıfını günceller.