REST Resource: genericclass

Ressource: GenericClass

Generische Klasse

JSON-Darstellung
{
  "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)
    }
  ]
}
Felder
id

string

Erforderlich. Die eindeutige Kennung für den Kurs. Diese ID muss für alle Karten/Tickets eines Ausstellers eindeutig sein. Dieser Wert muss das Format issuerID.identifier haben, bei dem issuerID von Google ausgegeben und identifier von dir ausgewählt wird. Die eindeutige Kennung kann nur alphanumerische Zeichen, ., _ oder - enthalten.

classTemplateInfo

object (ClassTemplateInfo)

Vorlageninformationen dazu, wie der Kurs angezeigt werden soll. Wenn diese Einstellung nicht festgelegt ist, verwendet Google standardmäßig einen Satz von Feldern, die angezeigt werden sollen.

imageModulesData[]

object (ImageModuleData)

Daten des Bildmoduls. Wenn für das Objekt auch imageModulesData definiert ist, werden beide angezeigt. Wenn beide festgelegt sind, wird nur eines der Bilder von der Klassen- und eines von der Objektebene gerendert.

textModulesData[]

object (TextModuleData)

Textmoduldaten. Wenn für das Objekt auch textModulesData definiert ist, werden beide angezeigt. Es werden maximal 10 Felder der Klasse und 10 Felder des Objekts angezeigt.

enableSmartTap

boolean

Nur für Partner mit aktiviertem Smart-Bonus verfügbar. Wenden Sie sich an den Support, um weitere Unterstützung zu erhalten.

redemptionIssuers[]

string (int64 format)

Gibt an, welche Einlösungsaussteller die Karte bzw. das Ticket über Smart-Bonus einlösen können. Einlösungsaussteller werden anhand ihrer Aussteller-ID identifiziert. Für Aussteller von Gutscheinen muss mindestens ein Smart Tap-Schlüssel konfiguriert sein.

Die Felder enableSmartTap und smartTapRedemptionLevel auf Objektebene müssen ebenfalls richtig eingerichtet sein, damit eine Karte/ein Ticket Smart-Bonus unterstützt.

securityAnimation

object (SecurityAnimation)

Optionale Informationen zur Sicherheitsanimation. Wenn diese Option festgelegt ist, wird eine Sicherheitsanimation für die Details der Karte/des Tickets gerendert.

multipleDevicesAndHoldersAllowedStatus

enum (MultipleDevicesAndHoldersAllowedStatus)

Gibt an, ob mehrere Nutzer und Geräte dasselbe Objekt speichern, das auf diese Klasse verweist.

callbackOptions

object (CallbackOptions)

Callback-Optionen, mit denen der Aussteller bei jedem Speichern/Löschen eines Objekts für diese Klasse durch den Endnutzer zurückgerufen wird. Alle Objekte dieser Klasse können den Rückruf erhalten.

viewUnlockRequirement

enum (ViewUnlockRequirement)

Optionen für die Entsperrvoraussetzung für den generischen Ausweis ansehen

messages[]

object (Message)

Eine Reihe von Nachrichten, die in der App angezeigt werden. Alle Nutzer dieses Objekts erhalten die zugehörigen Nachrichten. Die maximale Anzahl dieser Felder ist 10.

valueAddedModuleData[]

object (ValueAddedModuleData)

Optionale Daten zum Mehrwertmodul. Maximal zehn pro Kurs. Bei einer Karte/einem Ticket werden nur zehn angezeigt, wobei die Karten/Tickets des Objekts priorisiert werden.

Methoden

addmessage

Fügt der generischen Klasse, auf die durch die angegebene Klassen-ID verwiesen wird, eine Nachricht hinzu.

get

Gibt die generisch Klasse mit der angegebenen Klassen-ID zurück.

insert

Fügt eine generische Klasse mit der angegebenen ID und den angegebenen Properties ein.

list

Gibt eine Liste aller generischen Klassen für eine bestimmte Aussteller-ID zurück.

patch

Aktualisiert die generische Klasse, auf die durch die angegebene Klassen-ID verwiesen wird.

update

Aktualisiert die allgemeine Klasse, auf die durch die angegebene Klassen-ID verwiesen wird.