REST Resource: giftcardclass

Zasób: GiftCardClass

Zapis JSON
{
  "kind": string,
  "merchantName": string,
  "programLogo": {
    object (Image)
  },
  "pinLabel": string,
  "eventNumberLabel": string,
  "allowBarcodeRedemption": boolean,
  "localizedMerchantName": {
    object (LocalizedString)
  },
  "localizedPinLabel": {
    object (LocalizedString)
  },
  "localizedEventNumberLabel": {
    object (LocalizedString)
  },
  "cardNumberLabel": string,
  "localizedCardNumberLabel": {
    object (LocalizedString)
  },
  "classTemplateInfo": {
    object (ClassTemplateInfo)
  },
  "id": string,
  "version": string,
  "issuerName": string,
  "messages": [
    {
      object (Message)
    }
  ],
  "allowMultipleUsersPerObject": boolean,
  "homepageUri": {
    object (Uri)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "reviewStatus": enum (ReviewStatus),
  "review": {
    object (Review)
  },
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "redemptionIssuers": [
    string
  ],
  "countryCode": string,
  "heroImage": {
    object (Image)
  },
  "wordMark": {
    object (Image)
  },
  "enableSmartTap": boolean,
  "hexBackgroundColor": string,
  "localizedIssuerName": {
    object (LocalizedString)
  },
  "multipleDevicesAndHoldersAllowedStatus": enum (MultipleDevicesAndHoldersAllowedStatus),
  "callbackOptions": {
    object (CallbackOptions)
  },
  "securityAnimation": {
    object (SecurityAnimation)
  },
  "viewUnlockRequirement": enum (ViewUnlockRequirement),
  "wideProgramLogo": {
    object (Image)
  },
  "appLinkData": {
    object (AppLinkData)
  }
}
Pola
kind
(deprecated)

string

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

merchantName

string

Nazwa sprzedawcy, na przykład „Stroje Adama”. Aplikacja może wyświetlać wielokropek po pierwszych 20 znakach, aby zapewnić możliwość wyświetlania pełnego ciągu znaków na mniejszych ekranach.

pinLabel

string

Etykieta wyświetlana dla kodu PIN, na przykład „4-cyfrowy kod PIN”.

eventNumberLabel

string

Etykieta wyświetlana dla numeru zdarzenia, np. „Nr zdarzenia docelowego”.

allowBarcodeRedemption

boolean

Określa, czy sprzedawca obsługuje wykorzystanie karty podarunkowej za pomocą kodu kreskowego. Jeśli ma wartość prawda, aplikacja wyświetla kod kreskowy karty podarunkowej na ekranie z informacjami o niej. Jeśli ma wartość false (fałsz), kod kreskowy nie jest wyświetlany.

localizedMerchantName

object (LocalizedString)

Przetłumaczony tekst pola merchantName. Aplikacja może wyświetlać wielokropek po pierwszych 20 znakach, aby zapewnić możliwość wyświetlania pełnego ciągu znaków na mniejszych ekranach.

localizedPinLabel

object (LocalizedString)

Przetłumaczony tekst pola pinLabel.

localizedEventNumberLabel

object (LocalizedString)

Przetłumaczony tekst pola eventNumberLabel.

cardNumberLabel

string

Etykieta wyświetlana dla numeru karty, na przykład „Numer karty”.

localizedCardNumberLabel

object (LocalizedString)

Przetłumaczony tekst pola cardNumberLabel.

classTemplateInfo

object (ClassTemplateInfo)

Informacje o szablonie wyświetlania klasy. Jeśli nie jest skonfigurowana, Google skorzysta z domyślnego zestawu pól do wyświetlenia.

id

string

Wymagane. Unikalny identyfikator klasy. Ten identyfikator musi być unikalny wśród wszystkich klas 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 „-”.

version
(deprecated)

string (int64 format)

Wycofano

issuerName

string

Wymagane. Nazwa wydawcy. Zalecana maksymalna długość to 20 znaków, aby zapewnić możliwość wyświetlania pełnego ciągu znaków na mniejszych ekranach.

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.

allowMultipleUsersPerObject
(deprecated)

boolean

Rola wycofana. Użyj w zamian zasady multipleDevicesAndHoldersAllowedStatus.

homepageUri

object (Uri)

Identyfikator URI strony głównej aplikacji. Wypełnienie identyfikatora URI ma taki sam efekt jak wypełnienie identyfikatora URI w linksModuleData (gdy obiekt jest renderowany, link do strony głównej jest wyświetlany w miejscu, które można określić jako sekcja linksModuleData obiektu).

locations[]

object (LatLongPoint)

Uwaga: to pole nie jest obecnie obsługiwane do aktywowania powiadomień geograficznych.

reviewStatus

enum (ReviewStatus)

Wymagane. Stan zajęć. To pole można ustawić na draft lub underReview za pomocą wywołań interfejsu API insert, patch lub update. Po zmianie stanu weryfikacji draft na draft nie można go zmienić z powrotem.

Zostaw to pole na poziomie draft, gdy klasa jest w trakcie opracowywania. Klasy w stanie draft nie można użyć do utworzenia żadnego obiektu.

Ustaw to pole na underReview, gdy uznasz, że klasa jest gotowa do użycia. Platforma automatycznie ustawi to pole na approved i będzie można go natychmiast używać do tworzenia lub migrowania obiektów.

Aktualizując klasę, która jest już w stanie approved, należy ustawiać to pole na underReview.

review

object (Review)

Komentarze do weryfikacji ustawione przez platformę, gdy klasa jest oznaczona jako approved lub rejected.

infoModuleData
(deprecated)

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.

redemptionIssuers[]

string (int64 format)

Określa, którzy wydawcy elementów promocyjnych mogą wykorzystać kartę za pomocą smart tap. Wydawcy elementów promocyjnych są identyfikowani po identyfikatorze wydawcy. Wydawca elementów promocyjnych musi mieć skonfigurowany co najmniej 1 klucz Smart Tap.

Aby karta obsługiwała smart tap, pola enableSmartTap i smartTapRedemptionLevel na poziomie obiektu też muszą być prawidłowo skonfigurowane.

countryCode

string

Kod kraju używany do wyświetlania kraju karty (gdy użytkownik nie jest w tym kraju) oraz do wyświetlania zlokalizowanej treści, gdy treść nie jest dostępna w języku użytkownika.

heroImage

object (Image)

Opcjonalny obraz banera wyświetlany z przodu karty. Jeśli go nie ma, nic nie jest wyświetlane. Obraz wyświetla się w 100% szerokości.

wordMark
(deprecated)

object (Image)

Rola wycofana.

enableSmartTap

boolean

Wskazuje, czy ta klasa obsługuje smart tap. Aby karta obsługiwała smart tap, pola redemptionIssuers i smartTapRedemptionLevel na poziomie obiektu też muszą być prawidłowo skonfigurowane.

hexBackgroundColor

string

Kolor tła karty. Jeśli nie jest ustawiony, używany jest dominujący kolor banera powitalnego, a jeśli nie jest ustawiony, używany jest kolor dominujący logo. Format to #rrggbb, gdzie rrggbb to szesnastkowy zapis RGB, taki jak #ffcc00. Możesz także używać skróconej wersji zapisu RGB w formacie #rgb, np. #fc0.

localizedIssuerName

object (LocalizedString)

Przetłumaczony tekst pola publisherName. Zalecana maksymalna długość to 20 znaków, aby zapewnić możliwość wyświetlania pełnego ciągu znaków na mniejszych ekranach.

multipleDevicesAndHoldersAllowedStatus

enum (MultipleDevicesAndHoldersAllowedStatus)

Wskazuje, czy wielu użytkowników i urządzeń zapisze ten sam obiekt odwołujący się do tej klasy.

callbackOptions

object (CallbackOptions)

Opcje wywołania zwrotnego, które mają być używane do wywoływania wydawcy przy każdym zapisie/usunięciu przez użytkownika obiektu tej klasy. Wszystkie obiekty tej klasy kwalifikują się do wywołania zwrotnego.

securityAnimation

object (SecurityAnimation)

Opcjonalne informacje o animacji zabezpieczeń. Jeśli ta opcja jest ustawiona, na szczegółach karty będzie wyświetlana animacja zabezpieczeń.

viewUnlockRequirement

enum (ViewUnlockRequirement)

Wyświetl opcje Wymagane odblokowywanie karty podarunkowej.

Metody

addmessage

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

get

Zwraca klasę karty podarunkowej o podanym identyfikatorze klasy.

insert

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

list

Zwraca listę wszystkich klas kart podarunkowych dla podanego identyfikatora wydawcy.

patch

Aktualizuje klasę karty podarunkowej, do której odwołuje się podany identyfikator klasy.

update

Aktualizuje klasę karty podarunkowej, do której odwołuje się podany identyfikator klasy.