REST Resource: giftcardobject

Zasób: GiftCardObject

Zapis JSON 
{
  "kind": string,
  "classReference": {
    object (GiftCardClass)
  },
  "cardNumber": string,
  "pin": string,
  "balance": {
    object (Money)
  },
  "balanceUpdateTime": {
    object (DateTime)
  },
  "eventNumber": string,
  "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)
    }
  ]
}
Pola
kind
(deprecated)

string

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

object (GiftCardClass)

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

string

Wymagany. Numer karty.
pin

string

Kod PIN karty.
balance

object (Money)

Saldo pieniężne karty.
balanceUpdateTime

object (DateTime)

Data i godzina ostatniej aktualizacji salda.

Wymagane jest przesunięcie.

Jeśli saldo zostanie zaktualizowane, a ta właściwość nie zostanie podana, system domyślnie ustawi bieżący czas.
eventNumber

string

Numer zdarzenia karty – opcjonalne pole używane przez niektóre karty podarunkowe.
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.
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 okresowa, które powinny być automatycznie dołączone do tego obiektu karty podarunkowej. Jeśli użytkownik zapisze tę kartę podarunkową, 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 (Powiadomienie), spróbujemy wywołać 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.

Metody

addmessage

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

get

 Zwraca obiekt karty podarunkowej o podanym identyfikatorze obiektu.

insert

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

list

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

patch

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

update

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