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

string

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

title

string

To pole jest wymagane. Tytuł oferty, 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)

To pole jest wymagane. Kanały wykorzystania mające zastosowanie do tej oferty.

provider

string

To pole jest 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 zarówno w widoku szczegółów, jak i w widoku listy 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łumaczony tekst pola 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łumaczony tekst pola dostawcy. 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łumaczony tekst pola Upewnij się, że Drukarka jest dostępna.

shortTitle

string

Skrócona wersja tytułu oferty, 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łumaczony tekst krótkiego tytułu. Zalecana maksymalna długość to 20 znaków.

classTemplateInfo

object (ClassTemplateInfo)

Informacje o szablonie wyświetlania klasy. Jeśli zasada jest nieskonfigurowana, Google wyświetla domyślny zestaw pól.

id

string

To pole jest 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 „.”, „_” i „-”.

version
(deprecated)

string (int64 format)

Wycofano

issuerName

string

To pole jest 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. Użyj w zamian zasady multipleDevicesAndHoldersAllowedStatus.

homepageUri

object (Uri)

Identyfikator URI strony głównej aplikacji. Wypełnienie identyfikatora URI ma taki sam efekt jak wypełnienie identyfikatora URI w linksModuleData (podczas renderowania obiektu link do strony głównej jest widoczny w miejscu, które można określić jako sekcję linksModuleData obiektu).

locations[]

object (LatLongPoint)

Uwaga: to pole nie jest obecnie obsługiwane do aktywowania powiadomień dotyczących lokalizacji geograficznej.

reviewStatus

enum (ReviewStatus)

To pole jest wymagane. Stan zajęć. 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 z draft nie można go zmienić z powrotem na draft.

Należy zachować wartość draft w tym polu, gdy klasa jest na etapie programowania. Klasy w stanie draft nie można użyć do utworzenia żadnego obiektu.

Wpisz w tym polu wartość underReview, gdy uznasz, że klasa jest gotowa do użycia. 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żywaj 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. Wydawca elementów promocyjnych jest identyfikowany przez identyfikator wydawcy. Wydawca elementów promocyjnych musi mieć skonfigurowany co najmniej 1 klucz smart tap.

Pola enableSmartTap i smartTapRedemptionLevel na poziomie obiektu też muszą być odpowiednio skonfigurowane, aby karta obsługiwała smart tap.

countryCode

string

Kod kraju używany do wyświetlania kraju karty (gdy użytkownik nie znajduje się 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 nie ma żadnej wartości, 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. Pola redemptionIssuers i smartTapRedemptionLevel na poziomie obiektu też muszą być odpowiednio skonfigurowane, aby karta obsługiwała smart tap.

hexBackgroundColor

string

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

localizedIssuerName

object (LocalizedString)

Przetłumaczona wartość pola publisherName. 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 zabezpieczeń. Jeśli ta zasada jest skonfigurowana, w szczegółach karty wyświetlana jest animacja dotycząca zabezpieczeń.

viewUnlockRequirement

enum (ViewUnlockRequirement)

Wyświetl opcje wymagań dotyczących odblokowania w przypadku oferty.

wideTitleImage

object (Image)

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

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 dla podanego identyfikatora wydawcy.

patch

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

update

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