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)
  },
  "appLinkData": {
    object (AppLinkData)
  }
}
Alanlar
kind
(deprecated)

string

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

title

string

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

redemptionChannel

enum (RedemptionChannel)

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

provider

string

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

titleImage

object (Image)

Teklifin başlık resmi. Bu resim, uygulamanın hem ayrıntılarında 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)

Teklif için yardım bağlantısı (ör. http://myownpersonaldomain.com/help)

localizedTitle

object (LocalizedString)

Başlık için çevrilmiş dizeler. Dizenin tamamının daha küçük ekranlarda gösterilmesi için önerilen maksimum uzunluk 60 karakterdir.

localizedProvider

object (LocalizedString)

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

localizedDetails

object (LocalizedString)

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

localizedFinePrint

object (LocalizedString)

fitPrint için çevrilmiş dizeler.

shortTitle

string

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

localizedShortTitle

object (LocalizedString)

Kısa başlığın çevrilmiş dizeleri. Önerilen maksimum uzunluk 20 karakterdir.

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, draft veya Sınıfın durumu olarak ayarlanabilir. 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)

Teklif için Kilit Açma Koşulu 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.

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ğinin referansta bulunduğu teklif 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

Verilen kimlik ve özelliklere sahip bir teklif sınıfı ekler.

list

Belirli bir veren kuruluş kimliğine ilişkin 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.