REST Resource: offerclass

Zasób: OfferClass

Zapis JSON 
{
  "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)
    }
  ]
}
Pola
kind
(deprecated)

string

Określa rodzaj danego zasobu. Wartość: ustalony ciąg znaków "walletobjects#offerClass".
title

string

Wymagane. Tytuł oferty specjalnej, na przykład „20% zniżki na dowolną koszulkę”. Zalecana maksymalna długość to 60 znaków, aby zapewnić możliwość wyświetlania pełnego ciągu znaków na mniejszych ekranach.
redemptionChannel

enum (RedemptionChannel)

Wymagane. Kanały wykorzystania mające zastosowanie do tej oferty.
provider

string

Wymagane. Dostawca oferty (nazwa pośrednika lub nazwa sprzedawcy). Zalecana maksymalna długość to 12 znaków, aby zapewnić możliwość wyświetlania pełnego ciągu znaków na mniejszych ekranach.
titleImage

object (Image)

Obraz tytułu oferty. Ten obraz jest wyświetlany w widoku szczegółów i widoku listy w aplikacji.
details

string

Szczegóły oferty.
finePrint

string

Drobny druk lub warunki oferty, na przykład „20% zniżki na dowolną koszulkę w sklepie Stroje Adama”.
helpUri

object (Uri)

Link pomocy do oferty specjalnej, na przykład http://myownpersonaldomain.com/help
localizedTitle

object (LocalizedString)

Przetłumaczone teksty tytułu. Zalecana maksymalna długość to 60 znaków, aby zapewnić możliwość wyświetlania pełnego ciągu znaków na mniejszych ekranach.
localizedProvider

object (LocalizedString)

Przetłumaczone teksty w polu dostawca. Zalecana maksymalna długość to 12 znaków, aby zapewnić możliwość wyświetlania pełnego ciągu znaków na mniejszych ekranach.
localizedDetails

object (LocalizedString)

Przetłumaczony tekst pola szczegółów.
localizedFinePrint

object (LocalizedString)

Przetłumaczone ciągi znaków w polufirePrint.
shortTitle

string

Skrócona wersja tytułu oferty specjalnej, np. „20% zniżki”, wyświetlana użytkownikom jako szybkie odniesienie do treści oferty. Zalecana maksymalna długość to 20 znaków.
localizedShortTitle

object (LocalizedString)

Przetłumaczone teksty skróconego tytułu. Zalecana maksymalna długość to 20 znaków.
classTemplateInfo

object (ClassTemplateInfo)

Informacje na temat szablonu wyświetlania klasy. Jeśli nie są ustawione, Google przyjmuje domyślny zestaw pól do wyświetlenia.
id

string

Wymagane. Unikalny identyfikator klasy. Ten identyfikator musi być unikalny wśród wszystkich klas wydawcy. Ta wartość powinna mieć format issuer ID.identifier, gdzie pierwszy identyfikator jest wystawiany przez Google, a drugi jest wybierany przez Ciebie. Unikalny identyfikator powinien zawierać tylko znaki alfanumeryczne oraz znaki „.”, „_” lub „-”.
version
(deprecated)

string (int64 format)

Wycofano
issuerName

string

Wymagane. Nazwa wydawcy. Zalecana maksymalna długość to 20 znaków, aby zapewnić możliwość wyświetlania pełnego ciągu znaków na mniejszych ekranach.
messages[]

object (Message)

Tablica komunikatów wyświetlanych w aplikacji. Wszyscy użytkownicy tego obiektu będą otrzymywać powiązane z nim komunikaty. Maksymalna liczba tych pól to 10.
allowMultipleUsersPerObject
(deprecated)

boolean

Rola wycofana. Zamiast tego użyj pola multipleDevicesAndHoldersAllowedStatus.
homepageUri

object (Uri)

Identyfikator URI strony głównej aplikacji. Wypełnienie identyfikatora URI w tym polu ma taki sam efekt, jak wypełnienie identyfikatora URI w linkiModuleData (gdy obiekt jest renderowany, link do strony głównej jest widoczny w miejscu, które można określić jako sekcję linksModuleData obiektu).
locations[]
(deprecated)

object (LatLongPoint)

Uwaga: to pole nie jest obecnie obsługiwane w przypadku wywoływania powiadomień geograficznych.
reviewStatus

enum (ReviewStatus)

Wymagane. Stan klasy. W tym polu można ustawić draft lub stan klasy. To pole można ustawić na draft lub underReview za pomocą wywołań interfejsu API insert, patch lub update. Po zmianie stanu weryfikacji draft na inny nie można go zmienić z powrotem na draft.

Należy zachować stan draft, gdy klasa jest w fazie rozwoju. Klasy w stanie draft nie można użyć do utworzenia żadnego obiektu.

Gdy uznasz, że klasa jest gotowa do użycia, ustaw to pole na underReview. Platforma automatycznie ustawi to pole na approved i będzie można go natychmiast używać do tworzenia lub migrowania obiektów.

Aktualizując klasę, która jest już w stanie approved, należy ustawiać to pole na underReview.
review

object (Review)

Komentarze do weryfikacji ustawione przez platformę, gdy klasa jest oznaczona jako approved lub rejected.
infoModuleData
(deprecated)

object (InfoModuleData)

Rola wycofana. Zamiast tego użyj textModulesData.
imageModulesData[]

object (ImageModuleData)

Dane modułu obrazu. Maksymalna liczba wyświetlanych pól wynosi 1 z poziomu obiektu i 1 dla poziomu obiektu klasy.
textModulesData[]

object (TextModuleData)

Dane modułu tekstowego. Jeśli dane modułu tekstowego są określone również w klasie, będą wyświetlane jedne i drugie. Maksymalna liczba wyświetlanych pól wynosi 10 z obiektu i 10 z klasy.
redemptionIssuers[]

string (int64 format)

Określa, którzy wydawcy elementów promocyjnych mogą wykorzystać kartę za pomocą smart tap. Wydawcy elementów promocyjnych są identyfikowani na podstawie identyfikatora wydawcy. Wydawca elementów promocyjnych musi mieć skonfigurowany co najmniej 1 klucz Smart Tap.

Aby karta obsługiwała smart tap, pola enableSmartTap i smartTapRedemptionLevel na poziomie obiektu też muszą być prawidłowo skonfigurowane.
countryCode

string

Kod kraju używany do wyświetlania kraju karty (gdy użytkownik nie przebywa w tym kraju), a także do wyświetlania zlokalizowanej treści, gdy treść nie jest dostępna w języku użytkownika.
heroImage

object (Image)

Opcjonalny obraz banera wyświetlany z przodu karty. Jeśli go nie ma, nic nie jest wyświetlane. Obraz wyświetla się w 100% szerokości.
wordMark
(deprecated)

object (Image)

Rola wycofana.
enableSmartTap

boolean

Określa, czy ta klasa obsługuje Smart Tap. Aby karta obsługiwała funkcję Smart Tap, pola redemptionIssuers i smartTapRedemptionLevel na poziomie obiektu muszą być też prawidłowo skonfigurowane.
hexBackgroundColor

string

Kolor tła karty. Jeśli nie jest ustawiony, używany jest dominujący kolor banera powitalnego, a jeśli nie jest ustawiony, używany jest dominujący kolor logo. Format to #rrggbb, gdzie rrggbb to szesnastkowy zapis RGB, taki jak #ffcc00. Możesz też używać skróconej wersji zapisu RGB w formacie #rgb, np. #fc0.
localizedIssuerName

object (LocalizedString)

Przetłumaczona wartość pola issuerName. Zalecana maksymalna długość to 20 znaków, aby zapewnić możliwość wyświetlania pełnego ciągu znaków na mniejszych ekranach.
multipleDevicesAndHoldersAllowedStatus

enum (MultipleDevicesAndHoldersAllowedStatus)

Wskazuje, czy wielu użytkowników i urządzeń zapisze ten sam obiekt odwołujący się do tej klasy.
callbackOptions

object (CallbackOptions)

Opcje wywołania zwrotnego, które mają być używane do wywoływania wydawcy przy każdym zapisie/usunięciu obiektu tej klasy przez użytkownika końcowego. Wszystkie obiekty tej klasy kwalifikują się do wywołania zwrotnego.
securityAnimation

object (SecurityAnimation)

Opcjonalne informacje o animacji dotyczącej bezpieczeństwa. Jeśli ta opcja jest ustawiona, animacja bezpieczeństwa zostanie wyświetlona w szczegółach dokumentu.
viewUnlockRequirement

enum (ViewUnlockRequirement)

Wyświetl opcje wymagań dotyczących odblokowania dla oferty.
wideTitleImage

object (Image)

Szeroki tytuł oferty. Jeśli zostanie podany, będzie używany zamiast obrazu tytułu w lewym górnym rogu widoku karty.
notifyPreference

enum (NotificationSettingsForUpdates)

Określa, czy powiadomienia mają być wysyłane w przypadku aktualizacji pól w danej klasie. Gdy ustawisz opcję NOTIFY (powiadamiaj), spróbujemy wywołać powiadomienie o zmianie pola dla użytkowników. Te powiadomienia będą wysyłane tylko do użytkowników, jeśli pole jest częścią listy dozwolonych. Jeśli nie podasz żadnej wartości, nie będzie wyświetlane żadne powiadomienie. To ustawienie jest tymczasowe i musi być ustawiane w ramach każdego żądania PATCH lub UPDATE, w przeciwnym razie powiadomienie nie zostanie wywołane.
valueAddedModuleData[]

object (ValueAddedModuleData)

Opcjonalne dane modułu wartości dodanej. Maksymalnie 10 na zajęcia. W przypadku karty wyświetli się tylko 10 kart, przy czym priorytet będą miały te z obiektu.

RedemptionChannel

Wartości w polu enum
REDEMPTION_CHANNEL_UNSPECIFIED
INSTORE
instore

Starsza wersja aliasu dla INSTORE. Rola wycofana.
ONLINE
online

Starsza wersja aliasu dla ONLINE. Rola wycofana.
BOTH
both

Starsza wersja aliasu dla BOTH. Rola wycofana.
TEMPORARY_PRICE_REDUCTION
temporaryPriceReduction

Starsza wersja aliasu dla TEMPORARY_PRICE_REDUCTION. Rola wycofana.

Metody

addmessage

 Dodaje komunikat do klasy oferty, do której odwołuje się podany identyfikator klasy.

get

 Zwraca klasę oferty o podanym identyfikatorze klasy.

insert

 Wstawia klasę oferty o podanym identyfikatorze i właściwościach.

list

 Zwraca listę wszystkich klas ofert specjalnych dla podanego identyfikatora wydawcy.

patch

 Aktualizuje klasę oferty specjalnej, do której odwołuje się podany identyfikator klasy.

update

 Aktualizuje klasę oferty specjalnej, do której odwołuje się podany identyfikator klasy.