- Ressource: OfferObject
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Methoden
Ressource: OfferObject
JSON-Darstellung |
---|
{ "kind": string, "classReference": { object ( |
Felder | |
---|---|
kind |
Gibt an, um welche Art von Ressource es sich handelt. Wert: der feste String |
classReference |
Eine Kopie der übernommenen Felder der übergeordneten Klasse. Diese Felder werden während einer GET-Anfrage abgerufen. |
id |
Erforderlich. Die eindeutige Kennung für ein Objekt. Diese ID muss für alle Objekte eines Ausstellers eindeutig sein. Dieser Wert muss das Format issuer ID haben.identifier, wobei Ersteres von Google ausgestellt und Letzteres von Ihnen ausgewählt wird. Die eindeutige Kennung sollte nur alphanumerische Zeichen sowie „.“, „_“ oder „-“ enthalten. |
classId |
Erforderlich. Die mit diesem Objekt verknüpfte Klasse. Die Klasse muss denselben Typ wie dieses Objekt haben, bereits vorhanden und genehmigt sein. Klassen-IDs müssen das Format issuer ID haben.identifier, wobei Ersteres von Google ausgestellt und Letzteres von Ihnen ausgewählt wird. |
version |
Verworfen |
state |
Erforderlich. Der Status des Objekts. Mit diesem Feld wird festgelegt, wie ein Objekt in der App angezeigt wird. Beispielsweise wird ein |
barcode |
Typ und Wert des Barcodes. |
messages[] |
Ein Array von Mitteilungen, die in der App angezeigt werden. Alle Nutzer dieses Objekts erhalten die zugehörigen Nachrichten. Die maximale Anzahl dieser Felder ist 10. |
validTimeInterval |
Der Zeitraum, in dem dieses Objekt |
locations[] |
Hinweis: Dieses Feld wird derzeit nicht zum Auslösen von Geo-Benachrichtigungen unterstützt. |
hasUsers |
Gibt an, ob das Objekt Nutzer hat. Dieses Feld wird von der Plattform festgelegt. |
smartTapRedemptionValue |
Der Wert, der für dieses Objekt über NFC an ein Smart-Bonus-zertifiziertes Terminal übertragen wird. Die Felder auf Klassenebene |
hasLinkedDevice |
Gibt an, ob dieses Objekt derzeit mit einem einzelnen Gerät verknüpft ist. Dieses Feld wird von der Plattform festgelegt, wenn ein Nutzer das Objekt speichert und es mit seinem Gerät verknüpft. Zur Verwendung durch ausgewählte Partner vorgesehen. Weitere Informationen erhalten Sie vom Support. |
disableExpirationNotification |
Gibt an, ob Benachrichtigungen explizit unterdrückt werden sollen. Wenn dieses Feld auf „true“ gesetzt ist, werden Benachrichtigungen zu Ablaufdaten an den Nutzer unabhängig vom Feld Diese Option kann derzeit nur für Angebote festgelegt werden. |
infoModuleData |
Verworfen. Verwenden Sie stattdessen textModulesData. |
imageModulesData[] |
Bildmoduldaten. Es werden maximal ein Feld aus der Objektebene und eines auf der Klassenobjektebene angezeigt. |
textModulesData[] |
Textmoduldaten. Wenn auch Textmoduldaten für die Klasse definiert sind, werden beide angezeigt. Die maximale Anzahl der angezeigten Felder beträgt 10 vom -Objekt und 10 aus der Klasse. |
linksModuleData |
Linkmoduldaten. Wenn Linkmoduldaten ebenfalls für die Klasse definiert sind, werden beide angezeigt. |
appLinkData |
Optionaler App- oder Websitelink, der als Schaltfläche auf der Vorderseite der Karte bzw. des Tickets angezeigt wird. Wenn AppLinkData für das entsprechende Klassenobjekt bereitgestellt wird, wird nur das AppLinkData-Objekt angezeigt. |
rotatingBarcode |
Typ und Wert des rotierenden Barcodes. |
heroImage |
Optionales Bannerbild, das auf der Vorderseite der Karte angezeigt wird Ist keins vorhanden, wird gegebenenfalls das Hero-Image des Kurses angezeigt. Wenn auch kein Hero-Image des Kurses vorhanden ist, wird nichts angezeigt. |
groupingInfo |
Informationen, die steuern, wie Karten/Tickets gruppiert werden. |
passConstraints |
Übergeben Sie die Einschränkungen für das Objekt. Dazu gehört auch das Einschränken des Verhaltens von NFC- und Screenshot-Daten. |
saveRestrictions |
Einschränkungen für das Objekt, das überprüft werden muss, bevor der Nutzer versucht, die Karte bzw. das Ticket zu speichern. Diese Einschränkungen werden nur beim Speichern angewendet. Wenn sich die Einschränkungen ändern, nachdem ein Nutzer die Karte bzw. das Ticket gespeichert hat, werden die neuen Einschränkungen nicht auf bereits gespeicherte Karten/Tickets angewendet. |
Methoden |
|
---|---|
|
Fügt dem Angebotsobjekt, auf das die angegebene Objekt-ID verweist, eine Nachricht hinzu. |
|
Gibt das Angebotsobjekt mit der angegebenen Objekt-ID zurück |
|
Fügt ein Angebotsobjekt mit der angegebenen ID und den angegebenen Eigenschaften ein. |
|
Gibt eine Liste aller Angebotsobjekte für eine bestimmte Aussteller-ID zurück. |
|
Aktualisiert das Angebotsobjekt, auf das die angegebene Objekt-ID verweist. |
|
Aktualisiert das Angebotsobjekt, auf das die angegebene Objekt-ID verweist. |