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

string

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

merchantName

string

"Ali'nin Giyim" gibi bir satıcı 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.

pinLabel

string

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

eventNumberLabel

string

Etkinlik numarası için görüntülenecek etiket; örneğin, "Hedef Etkinlik #".

allowBarcodeRedemption

boolean

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

localizedMerchantName

object (LocalizedString)

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

localizedPinLabel

object (LocalizedString)

pinLabel için çevrilen dizeler.

localizedEventNumberLabel

object (LocalizedString)

eventNumberLabel için çevrilmiş 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ö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.

Geçişin Akıllı Dokunma'yı desteklemesi için enableSmartTap ve nesne düzeyindeki smartTapRedemptionLevel alanlarının da doğru ayarlanması gerekir.

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. Geçişin Akıllı Dokunma'yı desteklemesi için redemptionIssuers ve nesne düzeyindeki smartTapRedemptionLevel alanlarının da doğru ayarlanması gerekir.

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)

Hediye kartı için Kilit Açma Koşulu seçeneklerini görüntüleyin.

Yöntemler

addmessage

Belirtilen sınıf kimliğinin belirttiği 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 kuruluş 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 belirttiği hediye kartı sınıfını günceller.

update

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