Zasób REST: 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)
  }
}
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ą programu lojalnościowego. 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

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

Lista lokalizacji, w których można użyć obiektu. Platforma wykorzystuje te informacje do aktywowania powiadomień dla użytkowników przy użyciu geolokalizacji. Pamiętaj, że lokalizacje w obiekcie zastępują lokalizacje w klasie, które z kolei zastępują lokalizacje w identyfikatorze Miejsc Google.

hasUsers

boolean

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

smartTapRedemptionValue

string

Dostępne tylko dla partnerów obsługujących technologię smart tap. W razie wątpliwości skontaktuj się z działem pomocy.

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. Przeznaczone do użytku przez wybranych partnerów. W przypadku wątpliwości skontaktuj się z dział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 false.

Obecnie można je ustawiać tylko dla ofert specjalnych.

infoModuleData

object (InfoModuleData)

Wycofano. W zamian 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.

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 USD”. 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.