REST Resource: loyaltyclass

Zasób: LoyaltyClass

Zapis JSON 
{
  "kind": string,
  "programName": string,
  "programLogo": {
    object (Image)
  },
  "accountNameLabel": string,
  "accountIdLabel": string,
  "rewardsTierLabel": string,
  "rewardsTier": string,
  "localizedProgramName": {
    object (LocalizedString)
  },
  "localizedAccountNameLabel": {
    object (LocalizedString)
  },
  "localizedAccountIdLabel": {
    object (LocalizedString)
  },
  "localizedRewardsTierLabel": {
    object (LocalizedString)
  },
  "localizedRewardsTier": {
    object (LocalizedString)
  },
  "secondaryRewardsTierLabel": string,
  "localizedSecondaryRewardsTierLabel": {
    object (LocalizedString)
  },
  "secondaryRewardsTier": string,
  "localizedSecondaryRewardsTier": {
    object (LocalizedString)
  },
  "discoverableProgram": {
    object (DiscoverableProgram)
  },
  "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)
  },
  "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#loyaltyClass".
programName

string

Wymagane. Nazwa programu, np. „Stroje Adama”. Aplikacja może wyświetlać wielokropek po pierwszych 20 znakach, aby zapewnić możliwość wyświetlania pełnego ciągu znaków na mniejszych ekranach.
accountNameLabel

string

Etykieta nazwy konta, np. „Nazwa użytkownika”. Zalecana maksymalna długość to 15 znaków, aby zapewnić możliwość wyświetlania pełnego ciągu znaków na mniejszych ekranach.
accountIdLabel

string

Etykieta identyfikatora konta, np. „Identyfikator członka”. Zalecana maksymalna długość to 15 znaków, aby zapewnić możliwość wyświetlania pełnego ciągu znaków na mniejszych ekranach.
rewardsTierLabel

string

Etykieta poziomu nagród, na przykład „Poziom nagród”. Zalecana maksymalna długość to 9 znaków, aby zapewnić możliwość wyświetlania pełnego ciągu znaków na mniejszych ekranach.
rewardsTier

string

Poziom nagród, np. „Złoty” lub „Platynowy”. Zalecana maksymalna długość to 7 znaków, aby zapewnić możliwość wyświetlania pełnego ciągu znaków na mniejszych ekranach.
localizedProgramName

object (LocalizedString)

Przetłumaczony tekst pola programName. Aplikacja może wyświetlać wielokropek po pierwszych 20 znakach, aby zapewnić możliwość wyświetlania pełnego ciągu znaków na mniejszych ekranach.
localizedAccountNameLabel

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

string

Etykieta dodatkowego poziomu nagród, na przykład „Poziom nagród”.
localizedSecondaryRewardsTierLabel

object (LocalizedString)

Przetłumaczona wartość pola secondaryRewardsTierLabel.
secondaryRewardsTier

string

Dodatkowy poziom nagród, na przykład „Złoty” lub „Platynowy”.
localizedSecondaryRewardsTier

object (LocalizedString)

Przetłumaczona wartość pola secondaryRewardsTier.
discoverableProgram

object (DiscoverableProgram)

Informacje o tym, jak można wykryć klasę i utworzyć jej instancję z poziomu aplikacji Google Pay.
classTemplateInfo

object (ClassTemplateInfo)

Informacje o szablonie 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. 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 draft nie można go zmienić z powrotem.

Zostaw to pole na poziomie draft, gdy klasa jest w trakcie opracowywania. 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. Wydawcy ofert muszą mieć skonfigurowany co najmniej 1 klucz Smart Tap.

Aby karta obsługiwała smart tap, musisz też prawidłowo skonfigurować pole enableSmartTap i jedno z pól obiektu smartTapRedemptionValue na poziomie obiektu, barcode.value, oraccountId`.
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

Wskazuje, czy ta klasa obsługuje smart tap. Aby karty obsługiwały funkcję Smart Tap, musisz też prawidłowo skonfigurować pole redemptionIssuers oraz jedno z pól na poziomie obiektu: smartTapRedemptionLevel, barcode.value, or accountId.
hexBackgroundColor

string

Kolor tła karty. Jeśli nie jest ustawiony, używany jest dominujący kolor obrazu banera powitalnego, a jeśli obraz banera powitalnego 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, jak w tym przykładzie: #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 są odpowiednie dla 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ń związanych z odblokowaniem w przypadku karty lojalnościowej.
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 określisz tej wartości, nie zostanie wysłane żadne powiadomienie. To ustawienie jest efemeryczne i należy je ustawiać dla 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.

DiscoverableProgram

Informacje o tym, jak można wykryć klasę i utworzyć jej instancję z poziomu aplikacji Android Pay. Robi się to poprzez wyszukanie programu lojalnościowego lub programu kart podarunkowych i zeskanowanie lub ręczne wprowadzenie.

Zapis JSON 
{
  "merchantSignupInfo": {
    object (DiscoverableProgramMerchantSignupInfo)
  },
  "merchantSigninInfo": {
    object (DiscoverableProgramMerchantSigninInfo)
  },
  "state": enum (State)
}
Pola
merchantSignupInfo

object (DiscoverableProgramMerchantSignupInfo)

Informacje o możliwości rejestracji i dodawania wartości na potrzeby tego programu za pośrednictwem witryny sprzedawcy. Używane, gdy włączona jest opcja MERCHANT_HOSTED_SIGNUP.
merchantSigninInfo

object (DiscoverableProgramMerchantSigninInfo)

Informacje o możliwości logowania i dodawania wartości dla tego programu za pośrednictwem witryny sprzedawcy. Używane, gdy włączona jest opcja MERCHANT_HOSTED_SIGNIN.
state

enum (State)

Stan widoczności wykrywalnego programu.

DiscoverableProgramMerchantSignupInfo

Informacje na temat hostowanej przez sprzedawcę rejestracji w programie.

Zapis JSON 
{
  "signupWebsite": {
    object (Uri)
  },
  "signupSharedDatas": [
    enum (SharedDataType)
  ]
}
Pola
signupWebsite

object (Uri)

Adres URL witryny rejestracji sprzedawcy, do której należy przekierować użytkownika.
signupSharedDatas[]

enum (SharedDataType)

Dane użytkownika wysyłane w żądaniu POST na adres URL witryny rejestracji. Informacje te są kodowane, a następnie udostępniane, dzięki czemu witryna sprzedawcy może wstępnie wypełnić pola używane do zarejestrowania użytkownika w wykrywalnym programie.

SharedDataType

Wartości w polu enum
SHARED_DATA_TYPE_UNSPECIFIED
FIRST_NAME
LAST_NAME
STREET_ADDRESS jednowierszowe pole adresu
ADDRESS_LINE_1 wielowierszowe pola adresu
ADDRESS_LINE_2
ADDRESS_LINE_3
CITY
STATE
ZIPCODE
COUNTRY
EMAIL
PHONE

DiscoverableProgramMerchantSigninInfo

Informacje na temat procedury hostowanego przez sprzedawcę logowania do programu.

Zapis JSON 
{
  "signinWebsite": {
    object (Uri)
  }
}
Pola
signinWebsite

object (Uri)

Adres URL witryny logowania sprzedawcy, do której należy przekierować użytkownika.

Stan

Wartości w polu enum
STATE_UNSPECIFIED
TRUSTED_TESTERS Widoczne tylko dla testerów, którzy mają dostęp do konta wydawcy.
trustedTesters

Starsza wersja aliasu dla TRUSTED_TESTERS. Rola wycofana.
LIVE Widoczny dla wszystkich.
live

Starsza wersja aliasu dla LIVE. Rola wycofana.
DISABLED Niewidoczne.
disabled

Starsza wersja aliasu dla DISABLED. Rola wycofana.

Metody

addmessage

 Dodaje komunikat do klasy programu lojalnościowego, do której odwołuje się podany identyfikator klasy.

get

 Zwraca klasę programu lojalnościowego o podanym identyfikatorze klasy.

insert

 Wstawia klasę programu lojalnościowego o podanym identyfikatorze i właściwościach.

list

 Zwraca listę wszystkich klas programu lojalnościowego dla podanego identyfikatora wydawcy.

patch

 Aktualizuje klasę programu lojalnościowego, do której odwołuje się podany identyfikator klasy.

update

 Aktualizuje klasę programu lojalnościowego, do której odwołuje się podany identyfikator klasy.