REST Resource: loyaltyobject

Zasób: LoyaltyObject

Zapis JSON 
{
  "kind": string,
  "classReference": {
    object (LoyaltyClass)
  },
  "accountName": string,
  "accountId": string,
  "loyaltyPoints": {
    object (LoyaltyPoints)
  },
  "linkedOfferIds": [
    string
  ],
  "secondaryLoyaltyPoints": {
    object (LoyaltyPoints)
  },
  "id": string,
  "classId": string,
  "version": string,
  "state": enum (State),
  "barcode": {
    object (Barcode)
  },
  "messages": [
    {
      object (Message)
    }
  ],
  "validTimeInterval": {
    object (TimeInterval)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "hasUsers": boolean,
  "smartTapRedemptionValue": string,
  "hasLinkedDevice": boolean,
  "disableExpirationNotification": boolean,
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "appLinkData": {
    object (AppLinkData)
  },
  "rotatingBarcode": {
    object (RotatingBarcode)
  },
  "heroImage": {
    object (Image)
  },
  "groupingInfo": {
    object (GroupingInfo)
  },
  "passConstraints": {
    object (PassConstraints)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  },
  "linkedObjectIds": [
    string
  ],
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ],
  "merchantLocations": [
    {
      object (MerchantLocation)
    }
  ]
}
Pola
kind
(deprecated)

string

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

object (LoyaltyClass)

Kopia dziedziczonych pól klasy nadrzędnej. Te pola są pobierane podczas żądania GET.
accountName

string

Nazwa właściciela konta programu lojalnościowego, na przykład „Jan Kowalski”. Zalecana maksymalna długość to 20 znaków, aby zapewnić możliwość wyświetlania pełnego ciągu znaków na mniejszych ekranach.
accountId

string

Identyfikator konta programu lojalnościowego. Zalecana maksymalna długość to 20 znaków.
loyaltyPoints

object (LoyaltyPoints)

Etykieta, saldo i typ punktów lojalnościowych.
linkedOfferIds[]

string

Lista obiektów oferty połączonych z tą kartą lojalnościową. Obiekty oferty muszą już istnieć.

Identyfikatory obiektów oferty powinny mieć format issuer ID.identifier, gdzie pierwszy identyfikator jest wystawiany przez Google, a drugi jest wybierany przez Ciebie.
secondaryLoyaltyPoints

object (LoyaltyPoints)

Dodatkowa etykieta, saldo i typ punktów lojalnościowych. Wyświetlane oprócz podstawowych punktów lojalnościowych.
id

string

Wymagany. Unikalny identyfikator obiektu. Ten identyfikator musi być unikalny wśród wszystkich obiektów 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 „-”.
classId

string

Wymagany. Klasa powiązana z tym obiektem. Klasa musi być tego samego typu co ten obiekt, musi już istnieć i musi być zatwierdzona.

Identyfikatory klas powinny mieć format issuer ID.identifier, gdzie pierwszy identyfikator jest wystawiany przez Google, a drugi jest wybierany przez Ciebie.
version
(deprecated)

string (int64 format)

Wycofano
state

enum (State)

Wymagany. Stan obiektu. To pole służy do określania sposobu wyświetlania obiektu w aplikacji. Na przykład obiekt inactive jest przenoszony do sekcji „Karty, które straciły ważność”.
barcode

object (Barcode)

Typ i wartość kodu kreskowego.
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.
validTimeInterval

object (TimeInterval)

Okres, przez jaki ten obiekt będzie active i będzie można go używać. Po upływie tego czasu stan obiektu zostanie zmieniony na expired.
locations[]
(deprecated)

object (LatLongPoint)

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

boolean

Wskazuje, czy obiekt ma użytkowników. To pole jest ustawiane przez platformę.
smartTapRedemptionValue

string

Wartość, która zostanie przesłana do terminala z certyfikatem Smart Tap przez NFC dla tego obiektu. Aby karty obsługiwały funkcję smart tap, pola poziomu klasy enableSmartTap i redemptionIssuers muszą być też prawidłowo skonfigurowane. Obsługiwane są tylko znaki ASCII.

Jeśli ta wartość nie jest skonfigurowana, ale pola na poziomie klasy enableSmartTap i redemptionIssuers są prawidłowo skonfigurowane, jako wartości zastępcze są używane pola barcode.value lub accountId (jeśli są dostępne).
hasLinkedDevice

boolean

Wskazuje, czy ten obiekt jest aktualnie połączony z jednym urządzeniem. To pole jest ustawiane przez platformę, gdy użytkownik zapisuje obiekt, łącząc go ze swoim urządzeniem. Przeznaczony do użytku przez wybranych partnerów. Aby uzyskać więcej informacji, skontaktuj się z zespołem pomocy.
disableExpirationNotification

boolean

Wskazuje, czy powiadomienia powinny być jawnie pomijane. Jeśli to pole jest ustawione na wartość true, niezależnie od pola messages powiadomienia o utracie ważności kierowane do użytkownika będą pomijane. Domyślnie to pole jest ustawione na fałsz.

Obecnie można go ustawiać tylko dla ofert.
infoModuleData

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.
rotatingBarcode

object (RotatingBarcode)

Typ i wartość kodu kreskowego, który się obraca.
heroImage

object (Image)

Opcjonalny obraz banera wyświetlany z przodu karty. Jeśli nie ma żadnego obrazu, wyświetli się obraz banera powitalnego (jeśli jest dostępny). Jeśli nie ma też obrazu banera powitalnego klasy, nic się nie wyświetli.
groupingInfo

object (GroupingInfo)

Informacje określające sposób grupowania kart.
passConstraints

object (PassConstraints)

Przekazywanie ograniczeń dotyczących obiektu. Obejmuje to ograniczenie działania NFC i zrzutów ekranu.
saveRestrictions

object (SaveRestrictions)

Ograniczenia obiektu, które muszą zostać zweryfikowane, zanim użytkownik spróbuje zapisać kartę. Pamiętaj, że te ograniczenia będą obowiązywać tylko podczas zapisywania. Jeśli ograniczenia zmienią się po zapisaniu dokumentu, nowe ograniczenia nie zostaną zastosowane do już zapisanego dokumentu.
linkedObjectIds[]

string

linkedObjectIds to lista innych obiektów, takich jak bilet na wydarzenie, karta lojalnościowa, oferta, karta podarunkowa, karta pokładowa i karta na przejazd, które powinny być automatycznie dołączone do tego obiektu karty lojalnościowej. Jeśli użytkownik zapisze tę kartę lojalnościową, te identyfikatory połączonych obiektów zostaną automatycznie przesłane do portfela użytkownika (chyba że wyłączy ustawienie otrzymywania takich połączonych kart).

Upewnij się, że obiekty w linkedObjectIds zostały już wstawione. W przeciwnym razie wywołania nie powiedzą się. Po połączeniu połączonych obiektów nie można ich odłączyć. Nie możesz łączyć obiektów należących do innego wystawcy. Liczba obiektów, które można połączyć z jednym obiektem, jest ograniczona. Gdy zostanie osiągnięty limit, nowe połączone obiekty w rozmowie będą ignorowane.

Identyfikatory obiektów powinny mieć format issuer ID.identifier, gdzie pierwszy identyfikator jest wystawiany przez Google, a drugi jest wybierany przez Ciebie.
notifyPreference

enum (NotificationSettingsForUpdates)

Określa, czy aktualizacje pól tego obiektu mają wyzwalać powiadomienia. Gdy ustawisz opcję NOTIFY (powiadamiaj), spróbujemy uruchomić 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 ustawisz wartość DO_NOT_NOTIFY lub NOTIFICATION_SETTINGS_UNSPECIFIED, nie zostanie wywołane ż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 obiekt.
merchantLocations[]

object (MerchantLocation)

Lokalizacje sprzedawcy. Obiekt może mieć maksymalnie 10 elementów. Wszystkie dodatkowe MerchantLocations dodane po przekroczeniu limitu 10 są odrzucane. Te lokalizacje będą wywoływać powiadomienia, gdy użytkownik znajdzie się w określonym przez Google promieniu od punktu. To pole zastępuje wycofane pole LatLongPoints.

LoyaltyPoints

Zapis JSON 
{
  "label": string,
  "balance": {
    object (LoyaltyPointsBalance)
  },
  "localizedLabel": {
    object (LocalizedString)
  }
}
Pola
label

string

Etykieta punktów lojalnościowych, na przykład „Punkty”. Zalecana maksymalna długość to 9 znaków.
balance

object (LoyaltyPointsBalance)

Saldo punktów lojalnościowych posiadacza konta, na przykład „500” lub „10,00 PLN”. Zalecana maksymalna długość to 7 znaków. To pole jest wymagane w przypadku loyaltyPoints i secondaryLoyaltyPoints.
localizedLabel

object (LocalizedString)

Przetłumaczona wartość pola label. Zalecana maksymalna długość to 9 znaków.

LoyaltyPointsBalance

Zapis JSON 
{
  "string": string,
  "int": integer,
  "double": number,
  "money": {
    object (Money)
  }
}
Pola
string

string

Saldo w postaci ciągu znaków. Powinien być wypełniony tylko jeden z tych podtypów (string, int, double, money).
int

integer

Saldo w postaci liczby całkowitej. Powinien być wypełniony tylko jeden z tych podtypów (string, int, double, money).
double

number

Saldo w postaci liczby podwójnej precyzji. Powinien być wypełniony tylko jeden z tych podtypów (string, int, double, money).
money

object (Money)

Saldo w postaci wartości walutowej. Powinien być wypełniony tylko jeden z tych podtypów (string, int, double, money).

Metody

addmessage

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

get

 Zwraca obiekt programu lojalnościowego o podanym identyfikatorze obiektu.

insert

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

list

 Zwraca listę wszystkich obiektów programu lojalnościowego dla podanego identyfikatora wydawcy.

modifylinkedofferobjects

 Modyfikuje obiekty połączonej oferty dla obiektu programu lojalnościowego o podanym identyfikatorze.

patch

 Aktualizuje obiekt programu lojalnościowego, do którego odwołuje się podany identyfikator obiektu.

update

 Aktualizuje obiekt programu lojalnościowego, do którego odwołuje się podany identyfikator obiektu.