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)
  }
}
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 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)

Dodatkowa etykieta, saldo i typ dodatkowych punktów w programie lojalnościowym. Wyświetlane oprócz głównych punktów lojalnościowych.

id

string

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

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)

Wymagane. Stan obiektu. To pole służy do określania sposobu wyświetlania obiektu w aplikacji. Na przykład obiekt inactive jest przeniesiony 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 do aktywowania powiadomień geograficznych.

hasUsers

boolean

Wskazuje, czy obiekt ma 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 w przypadku tego obiektu. Aby karta obsługiwała smart tap, musisz też prawidłowo skonfigurować pola enableSmartTap i redemptionIssuers na poziomie klasy. Obsługiwane są tylko znaki ASCII.

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

hasLinkedDevice

boolean

Określa, 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. Przeznaczony do użytku przez wybranych partnerów. Aby uzyskać dodatkowe informacje, skontaktuj się z zespołem pomocy.

disableExpirationNotification

boolean

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

Obecnie można to ustawić tylko w przypadku 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 na poziomie 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ść zmieniającego się kodu kreskowego.

heroImage

object (Image)

Opcjonalny obraz banera wyświetlany z przodu karty. Jeśli takiego nie ma, wyświetli się baner powitalny zajęć, jeśli są dostępne. Jeśli nie ma też banera powitalnego zajęć, nic się nie wyświetli.

groupingInfo

object (GroupingInfo)

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

passConstraints

object (PassConstraints)

Przekazuj ograniczenia dla obiektu. Obejmuje ograniczenie możliwości korzystania z NFC i zrzutów ekranu.

saveRestrictions

object (SaveRestrictions)

Ograniczenia dotyczące obiektu, które musi zostać zweryfikowane, zanim użytkownik spróbuje zapisać kartę. Te ograniczenia będą stosowane tylko podczas zapisywania. Jeśli ograniczenia zmienią się po zapisaniu karty przez użytkownika, nowe ograniczenia nie zostaną zastosowane do zapisanej karty.

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. Wypełnij tylko jeden z tych podtypów (ciąg znaków, liczba całkowita, podwójna, wartość pieniężna).

int

integer

Saldo w postaci liczby całkowitej. Wypełnij tylko jeden z tych podtypów (ciąg znaków, liczba całkowita, podwójna, wartość pieniężna).

double

number

Saldo w postaci liczby zmiennoprzecinkowej. Wypełnij tylko jeden z tych podtypów (ciąg znaków, liczba całkowita, podwójna, wartość pieniężna).

money

object (Money)

Forma pieniężna salda. Wypełnij tylko jeden z tych podtypów (ciąg znaków, liczba całkowita, podwójna, wartość 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.