REST Resource: offerobject

Zasób: OfferObject

Zapis JSON
{
  "kind": string,
  "classReference": {
    object (OfferClass)
  },
  "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#offerObject".

classReference

object (OfferClass)

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

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 do aktywowania powiadomień dotyczących lokalizacji geograficznej.

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 dla tego obiektu. Aby karta obsługiwała smart tap, pola na poziomie zajęć enableSmartTap i redemptionIssuers też muszą być prawidłowo skonfigurowane. Obsługiwane są tylko znaki ASCII.

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ć wyraźnie 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 to ustawienie można ustawić tylko dla ofert.

infoModuleData

object (InfoModuleData)

Rola wycofana. Zamiast tego 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.

rotatingBarcode

object (RotatingBarcode)

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

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 ma też banera powitalnego zajęć, nic nie zostanie wyświetlone.

groupingInfo

object (GroupingInfo)

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

passConstraints

object (PassConstraints)

Ograniczenia dotyczące obiektu. Obejmuje to ograniczenie możliwości NFC i zrzutów ekranu.

Metody

addmessage

Dodaje komunikat do obiektu oferty, do którego odwołuje się podany identyfikator obiektu.

get

Zwraca obiekt oferty o podanym identyfikatorze obiektu.

insert

Wstawia obiekt oferty o podanym identyfikatorze i właściwościach.

list

Zwraca listę wszystkich obiektów ofert dla podanego identyfikatora wydawcy.

patch

Aktualizuje obiekt oferty, do którego odwołuje się podany identyfikator obiektu.

update

Aktualizuje obiekt oferty, do którego odwołuje się podany identyfikator obiektu.