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

string

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

object (LoyaltyClass)

Kopia odziedziczonych 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 w programie lojalnościowym.
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)

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

string

To pole jest wymagane. 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

To pole jest wymagane. 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)

To pole jest wymagane. 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[]

object (LatLongPoint)

Uwaga: to pole nie jest obecnie obsługiwane w przypadku wyświetlania powiadomień geograficznych.
hasUsers

boolean

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

string

Wartość, która będzie przesyłana do terminala z certyfikatem Smart Tap przez NFC dla tego obiektu. Aby karta obsługiwała smart tap, pola enableSmartTap i redemptionIssuers na poziomie zajęć również muszą być odpowiednio skonfigurowane. Obsługiwane są tylko znaki ASCII.

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

boolean

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

boolean

Wskazuje, czy powiadomienia powinny być jawnie pomijane. Jeśli to pole ma wartość Prawda, niezależnie od pola messages powiadomienia o wygaśnięciu wysyłane do użytkownika będą pomijane. Domyślnie to pole ma wartość false (fałsz).

Obecnie można to zrobić tylko w przypadku ofert.
infoModuleData

object (InfoModuleData)

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

object (ImageModuleData)

Dane modułu obrazów. Maksymalna liczba wyświetlanych pól to 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 to 10 z obiektu i 10 z klasy.
rotatingBarcode

object (RotatingBarcode)

Typ i wartość kodu kreskowego obracającego się.
heroImage

object (Image)

Opcjonalny obraz banera wyświetlany z przodu karty. Jeśli go nie ma, wyświetli się baner powitalny zajęć (jeśli jest dostępny). Jeśli nie znajdziesz też banera powitalnego zajęć, nic się nie wyświetli.
groupingInfo

object (GroupingInfo)

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

object (PassConstraints)

Przekazywanie ograniczeń obiektu. Obejmuje to ograniczenie możliwości NFC i wykonywania zrzutów ekranu.

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 właściciela 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łumaczony tekst etykiety. 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. Musisz wypełnić tylko jeden z tych podtypów (ciąg znaków, int, podwójna, pieniężna).
int

integer

Saldo w postaci liczby całkowitej. Musisz wypełnić tylko jeden z tych podtypów (ciąg znaków, int, podwójna, pieniężna).
double

number

Saldo w postaci liczby podwójnej precyzji. Musisz wypełnić tylko jeden z tych podtypów (ciąg znaków, int, podwójna, pieniężna).
money

object (Money)

Forma środków pieniężnych. Musisz wypełnić tylko jeden z tych podtypów (ciąg znaków, int, podwójna, pieniężna).

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.