REST Resource: genericclass

Zasób: OgólnaClass

Klasa ogólna

Zapis JSON
{
  "id": string,
  "classTemplateInfo": {
    object (ClassTemplateInfo)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "enableSmartTap": boolean,
  "redemptionIssuers": [
    string
  ],
  "securityAnimation": {
    object (SecurityAnimation)
  },
  "multipleDevicesAndHoldersAllowedStatus": enum (MultipleDevicesAndHoldersAllowedStatus),
  "callbackOptions": {
    object (CallbackOptions)
  },
  "viewUnlockRequirement": enum (ViewUnlockRequirement),
  "messages": [
    {
      object (Message)
    }
  ],
  "appLinkData": {
    object (AppLinkData)
  }
}
Pola
id

string

Wymagane. Unikalny identyfikator klasy. Ten identyfikator musi być unikalny wśród wszystkich wydawców. Ta wartość musi mieć format issuerID.identifier, gdzie issuerID jest wydawany przez Google, a identifier jest wybierany przez Ciebie. Unikalny identyfikator może zawierać tylko znaki alfanumeryczne oraz znaki ., _ i -.

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.

imageModulesData[]

object (ImageModuleData)

Dane modułu obrazu. Jeśli w obiekcie jest też zdefiniowana wartość imageModulesData, wyświetlane będą obie te wartości. Po ustawieniu obu tych obrazów zostanie wyrenderowany tylko jeden obraz z klasy i jeden z poziomu obiektu.

textModulesData[]

object (TextModuleData)

Dane modułu tekstowego. Jeśli w obiekcie jest też zdefiniowana wartość textModulesData, wyświetlane będą obie te wartości. Maksymalna liczba wyświetlanych pól to 10 z klasy i 10 z obiektu.

enableSmartTap

boolean

Dostępne tylko dla partnerów obsługujących smart tap. Aby uzyskać dodatkowe wskazówki, skontaktuj się z zespołem pomocy.

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.

securityAnimation

object (SecurityAnimation)

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

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.

viewUnlockRequirement

enum (ViewUnlockRequirement)

Wyświetl opcje wymagań związanych z odblokowywaniem karty ogólnej.

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.

Metody

addmessage

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

get

Zwraca klasę ogólną o podanym identyfikatorze klasy.

insert

Wstawia klasę ogólną o podanym identyfikatorze i właściwościach.

list

Zwraca listę wszystkich klas ogólnych dla podanego identyfikatora wydawcy.

patch

Aktualizuje klasę ogólną, do której odwołuje się podany identyfikator klasy.

update

Aktualizuje klasę ogólną, do której odwołuje się podany identyfikator klasy.