REST Resource: genericclass

Zasób: GenericClass

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)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
Pola
id

string

Wymagany. Unikalny identyfikator klasy. Ten identyfikator musi być unikalny wśród wszystkich obiektów wydawcy. Ta wartość powinna mieć format issuerID.identifier, gdzie issuerID jest wystawiany przez Google, a identifier jest wybierany przez Ciebie. Unikalny identyfikator może zawierać tylko znaki alfanumeryczne, ., _ lub -.
classTemplateInfo

object (ClassTemplateInfo)

Informacje na temat szablonu wyświetlania klasy. Jeśli nie są ustawione, Google przyjmuje domyślny zestaw pól do wyświetlenia.
imageModulesData[]

object (ImageModuleData)

Dane modułu obrazu. Jeśli w obiekcie zdefiniowano również imageModulesData, będą wyświetlane obydwa. Gdy oba są ustawione, renderowany będzie tylko jeden obraz z poziomu klasy i jeden z poziomu obiektu.
textModulesData[]

object (TextModuleData)

Dane modułu tekstowego. Jeśli w obiekcie zdefiniowano również textModulesData, będą wyświetlane obydwa. Maksymalna liczba wyświetlanych pól wynosi 10 z klasy i 10 z obiektu.
enableSmartTap

boolean

Dostępne tylko dla partnerów obsługujących technologię smart tap. Aby uzyskać dodatkową pomoc, 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 na podstawie identyfikatora wydawcy. Wydawcy ofert muszą mieć skonfigurowany co najmniej 1 klucz Smart Tap.

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

object (SecurityAnimation)

Opcjonalne informacje o animacji dotyczącej bezpieczeństwa. Jeśli ta opcja jest ustawiona, animacja bezpieczeństwa zostanie wyświetlona w szczegółach dokumentu.
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 obiektu tej klasy przez użytkownika końcowego. Wszystkie obiekty tej klasy są odpowiednie dla wywołania zwrotnego.
viewUnlockRequirement

enum (ViewUnlockRequirement)

Wyświetl opcje wymagań dotyczących odblokowania dla ogólnego dokumentu.
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.
valueAddedModuleData[]

object (ValueAddedModuleData)

Opcjonalne dane modułu wartości dodanej. Maksymalnie 10 na zajęcia. W przypadku karty wyświetli się tylko 10 kart, przy czym priorytet będą miały te z obiektu.

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.