REST Resource: offerclass

Kaynak: OfferClass

JSON gösterimi
{
  "kind": string,
  "title": string,
  "redemptionChannel": enum (RedemptionChannel),
  "provider": string,
  "titleImage": {
    object (Image)
  },
  "details": string,
  "finePrint": string,
  "helpUri": {
    object (Uri)
  },
  "localizedTitle": {
    object (LocalizedString)
  },
  "localizedProvider": {
    object (LocalizedString)
  },
  "localizedDetails": {
    object (LocalizedString)
  },
  "localizedFinePrint": {
    object (LocalizedString)
  },
  "shortTitle": string,
  "localizedShortTitle": {
    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),
  "wideTitleImage": {
    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#offerClass" sabit dizesi.

title

string

Zorunlu. Teklifin başlığı (ör. "Tüm tişörtlerde% 20 indirim"). Küçük ekranlarda dizenin tamamının gösterilmesi için önerilen maksimum uzunluk 60 karakterdir.

redemptionChannel

enum (RedemptionChannel)

Zorunlu. Bu teklif için geçerli olan teklif kullanma kanalları.

provider

string

Zorunlu. Teklif sağlayıcı (toplayıcı adı veya satıcı adı). Daha küçük ekranlarda dizenin tamamının gösterilmesi için önerilen maksimum uzunluk 12 karakterdir.

titleImage

object (Image)

Teklifin başlık resmi. Bu resim, uygulamanın hem ayrıntı hem de liste görünümlerinde gösterilir.

details

string

Teklifin ayrıntıları.

finePrint

string

Açıklama metni veya teklifin şartları (ör. "Adem's Giyim'deki tüm tişörtlerde% 20 indirim").

helpUri

object (Uri)

Teklifin yardım bağlantısı (ör. http://myownpersonaldomain.com/help)

localizedTitle

object (LocalizedString)

Başlığın çevrilmiş dizeleri. Küçük ekranlarda dizenin tamamının gösterilmesi için önerilen maksimum uzunluk 60 karakterdir.

localizedProvider

object (LocalizedString)

Sağlayıcı için çevrilmiş dizeler. Daha küçük ekranlarda dizenin tamamının gösterilmesi için önerilen maksimum uzunluk 12 karakterdir.

localizedDetails

object (LocalizedString)

Ayrıntılar için çevrilmiş dizeler.

localizedFinePrint

object (LocalizedString)

İnce baskı için çevrilmiş dizeler.

shortTitle

string

Teklif başlığının, kullanıcılara teklif içeriğine hızlı bir referans olarak gösterilen "%20 indirim" gibi kısaltılmış hali. Maksimum uzunluk 20 karakterdir.

localizedShortTitle

object (LocalizedString)

Kısa başlık için çevrilmiş dizeler. Önerilen maksimum uzunluk 20 karakterdir.

classTemplateInfo

object (ClassTemplateInfo)

Sınıfın nasıl gösterileceğiyle ilgili şablon bilgileri. Ayarlanmazsa Google, gösterilecek varsayılan bir alan grubuna geçer.

id

string

Zorunlu. Sınıfın benzersiz tanımlayıcısı. Bu kimlik, bir verenin tüm sınıflarında 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ı. Daha küçük ekranlarda dizenin tamamının gösterilmesi için önerilen maksimum uzunluk 20 karakterdir.

messages[]

object (Message)

Uygulamada görüntülenen bir mesaj dizisi. Bu nesnenin tüm kullanıcıları, nesneyle ilişkilendirilmiş mesajları alı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ı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 draft veya Sınıfın durumu olarak ayarlanabilir. 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 değerine 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 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ı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, hero resmi 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. 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ı ve cihazın bu sınıfa atıfta bulunan aynı nesneyi kaydedip kaydetmeyeceğini tanımlar.

callbackOptions

object (CallbackOptions)

Son kullanıcının bu sınıfa ait bir nesneyi her kaydettiğinde/sildiğinde, yayıncıyı geri aramak için 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)

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

wideTitleImage

object (Image)

Teklifin geniş başlık resmi. Bu değer sağlandığında, kart görünümünün sol üst tarafındaki başlık resminin yerine kullanılır.

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ıfta en fazla on karakter olabilir. Kart için yalnızca on adet görüntü gösterilir ve nesnedeki seçeneklere öncelik verilir.

RedemptionChannel

Sıralamalar
REDEMPTION_CHANNEL_UNSPECIFIED
INSTORE
instore

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

ONLINE
online

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

BOTH
both

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

TEMPORARY_PRICE_REDUCTION
temporaryPriceReduction

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

Yöntemler

addmessage

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

get

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

insert

Belirtilen kimliğe ve özelliklere sahip bir teklif sınıfı ekler.

list

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

patch

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

update

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