REST Resource: offerclass

Ressource: Angebotsklasse

JSON-Darstellung 
{
  "kind": string,
  "title": string,
  "redemptionChannel": enum (RedemptionChannel),
  "provider": string,
  "titleImage": {
    object (Image)
  },
  "details": string,
  "finePrint": string,
  "helpUri": {
    object (Uri)
  },
  "localizedTitle": {
    object (LocalizedString)
  },
  "localizedProvider": {
    object (LocalizedString)
  },
  "localizedDetails": {
    object (LocalizedString)
  },
  "localizedFinePrint": {
    object (LocalizedString)
  },
  "shortTitle": string,
  "localizedShortTitle": {
    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),
  "wideTitleImage": {
    object (Image)
  },
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "appLinkData": {
    object (AppLinkData)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
Felder
kind
(deprecated)

string

Gibt an, um welche Art von Ressource es sich handelt. Wert: der feste String "walletobjects#offerClass".
title

string

Erforderlich. Der Titel des Angebots, z. B. „20% Rabatt auf alle T-Shirts“. Die empfohlene maximale Länge ist 60 Zeichen, damit der vollständige String auf kleineren Displays angezeigt wird.
redemptionChannel

enum (RedemptionChannel)

Erforderlich. Die für dieses Angebot geltenden Einlösungskanäle.
provider

string

Erforderlich. Der Anbieter des Angebots (entweder der Name des Aggregators oder des Händlers). Die empfohlene maximale Länge ist 12 Zeichen, damit der vollständige String auf kleineren Displays angezeigt wird.
titleImage

object (Image)

Das Titelbild des Angebots. Dieses Bild wird sowohl in der Detailansicht als auch in der Listenansicht der App angezeigt.
details

string

Die Details des Angebots.
finePrint

string

Der Kleingedruckte oder die Angebotsbedingungen, z. B. „20% Rabatt auf alle T-Shirts bei Adam's Apparel“.
helpUri

object (Uri)

Der Hilfelink für das Angebot, z. B. http://myownpersonaldomain.com/help
localizedTitle

object (LocalizedString)

Übersetzte Strings für den Titel. Die empfohlene maximale Länge ist 60 Zeichen, damit der vollständige String auf kleineren Displays angezeigt wird.
localizedProvider

object (LocalizedString)

Übersetzte Strings für den Anbieter. Die empfohlene maximale Länge ist 12 Zeichen, damit der vollständige String auf kleineren Displays angezeigt wird.
localizedDetails

object (LocalizedString)

Übersetzte Strings für die Details.
localizedFinePrint

object (LocalizedString)

Übersetzte Strings für das Kleingedruckte.
shortTitle

string

Eine gekürzte Version des Angebotstitels, z. B. „20% Rabatt“, die Nutzern als kurze Referenz zum Angebotsinhalt angezeigt wird. Die empfohlene maximale Länge ist 20 Zeichen.
localizedShortTitle

object (LocalizedString)

Übersetzte Strings für den Kurztitel. Die empfohlene maximale Länge ist 20 Zeichen.
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.
id

string

Erforderlich. Die eindeutige Kennung für einen Kurs. Diese ID muss für alle Klassen eines Ausstellers eindeutig sein. Dieser Wert sollte das Format issuer ID haben.identifier, wobei von Google ausgegeben und von dir ausgewählt wird. Die eindeutige Kennung darf nur alphanumerische Zeichen, „.“ (Punkt), „_“ (Unterstrich) oder „-“ (Bindestriche) enthalten.
version
(deprecated)

string (int64 format)

Verworfen
issuerName

string

Erforderlich. Der Name des Ausstellers. Die empfohlene maximale Länge ist 20 Zeichen, damit der vollständige String auf kleineren Displays angezeigt wird.
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.
allowMultipleUsersPerObject
(deprecated)

boolean

Verworfen. Verwenden Sie stattdessen multipleDevicesAndHoldersAllowedStatus.
homepageUri

object (Uri)

Der URI der Startseite Ihrer Anwendung. Wenn Sie den URI in dieses Feld einfügen, wird genau dasselbe Verhalten wie beim Einfügen eines URI in „linksModuleData“ ausgelöst. Wenn ein Objekt gerendert wird, wird im Bereich „linksModuleData“ des Objekts ein Link zur Startseite angezeigt.
locations[]
(deprecated)

object (LatLongPoint)

Hinweis: Dieses Feld wird derzeit nicht zum Auslösen von Benachrichtigungen unterstützt.
reviewStatus

enum (ReviewStatus)

Erforderlich. Der Status des Kurses. Dieses Feld kann auf draft oder den Status des Kurses gesetzt werden. Dieses Feld kann mit den API-Aufrufen „insert“, „patch“ oder „update“ auf draft oder underReview gesetzt werden. Sobald der Status der Überprüfung von draft geändert wurde, kann er nicht mehr zu draft zurückgesetzt werden.

Wenn der Kurs noch in der Entwicklungsphase ist, sollte dieses Feld auf draft bleiben. Mit einer draft-Klasse können keine Objekte erstellt werden.

Legen Sie dieses Feld auf underReview fest, wenn Sie der Meinung sind, dass der Kurs einsatzbereit ist. Dieses Feld wird von der Plattform automatisch auf approved gesetzt und kann sofort zum Erstellen oder Migrieren von Objekten verwendet werden.

Wenn Sie eine bereits vorhandene approved-Klasse aktualisieren, sollten Sie dieses Feld weiterhin auf underReview setzen.
review

object (Review)

Die Rezensionskommentare, die von der Plattform festgelegt werden, wenn ein Kurs mit approved oder rejected gekennzeichnet ist.
infoModuleData
(deprecated)

object (InfoModuleData)

Verworfen. Verwenden Sie stattdessen „textModulesData“.
imageModulesData[]

object (ImageModuleData)

Daten des Bildmoduls. Maximal werden ein Feld auf Objektebene und ein Feld auf Klassenobjektebene angezeigt.
textModulesData[]

object (TextModuleData)

Textmoduldaten. Wenn für den Kurs auch Textmoduldaten definiert sind, werden beide angezeigt. Es werden maximal 10 Felder des Objekts und 10 Felder der Klasse angezeigt.
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.
countryCode

string

Der Ländercode, der zum Anzeigen des Landes der Karte verwendet wird, wenn sich der Nutzer nicht in diesem Land befindet, sowie zum Anzeigen lokalisierter Inhalte, wenn Inhalte nicht in der Sprache des Nutzers verfügbar sind.
heroImage

object (Image)

Optionales Bannerbild, das auf der Vorderseite der Karte angezeigt wird. Ist keine vorhanden, wird nichts angezeigt. Das Bild wird mit 100% der Breite angezeigt.
wordMark
(deprecated)

object (Image)

Verworfen.
enableSmartTap

boolean

Gibt an, ob diese Klasse Smart Tap unterstützt. Die Felder redemptionIssuers und smartTapRedemptionLevel auf Objektebene müssen ebenfalls richtig eingerichtet sein, damit eine Karte/ein Ticket Smart-Bonus unterstützt.
hexBackgroundColor

string

Die Hintergrundfarbe der Karte bzw. des Tickets. Falls nicht festgelegt, wird die Hauptfarbe des Hero-Images verwendet, und wenn kein Hero-Image festgelegt ist, wird die Hauptfarbe des Logos verwendet. Das Format ist #rrggbb, wobei rrggbb ein hexadezimales RGB-Triplet ist, z. B. #ffcc00. Du kannst auch die Kurzversion des RGB-Triplets (#rgb) verwenden, z. B. #fc0.
localizedIssuerName

object (LocalizedString)

Übersetzte Strings für den „issuerName“. Die empfohlene maximale Länge ist 20 Zeichen, damit der vollständige String auf kleineren Displays angezeigt wird.
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.
securityAnimation

object (SecurityAnimation)

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

enum (ViewUnlockRequirement)

Optionen für die Entsperrvoraussetzung für das Angebot aufrufen
wideTitleImage

object (Image)

Das breite Titelbild des Angebots. Wenn Sie ein Bild angeben, wird es anstelle des Titelbilds oben links in der Kartenansicht verwendet.
notifyPreference

enum (NotificationSettingsForUpdates)

Gibt an, ob Feldaktualisierungen für diese Klasse Benachrichtigungen auslösen sollen. Wenn diese Option auf NOTIFY gesetzt ist, versuchen wir, eine Benachrichtigung über die Aktualisierung eines Felds an die Nutzer auszulösen. Diese Benachrichtigungen werden nur an Nutzer gesendet, wenn das Feld auf einer Zulassungsliste steht. Wenn Sie keine Angabe machen, wird keine Benachrichtigung ausgelöst. Diese Einstellung ist temporär und muss bei jeder PATCH- oder UPDATE-Anfrage festgelegt werden. Andernfalls wird keine Benachrichtigung ausgelöst.
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.

RedemptionChannel

Enums
REDEMPTION_CHANNEL_UNSPECIFIED
INSTORE
instore

Alter Alias für INSTORE. Verworfen.
ONLINE
online

Alter Alias für ONLINE. Verworfen.
BOTH
both

Alter Alias für BOTH. Verworfen.
TEMPORARY_PRICE_REDUCTION
temporaryPriceReduction

Alter Alias für TEMPORARY_PRICE_REDUCTION. Verworfen.

Methoden

addmessage

 Fügen Sie der Angebotsklasse, auf die die angegebene Klassen-ID verweist, eine Nachricht hinzu.

get

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

insert

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

list

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

patch

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

update

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