REST Resource: offerclass

Ressource: OfferClass

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)
  }
}
Felder
kind
(deprecated)

string

Kennzeichnet, welche Art von Ressource dies ist. Wert: der feste String "walletobjects#offerClass".
title

string

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

enum (RedemptionChannel)

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

string

Erforderlich. Der Anbieter des Angebots (entweder der Name des Dienstleisters oder der Händlername). 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 Detail- als auch in der Listenansicht der App angezeigt.
details

string

Die Details des Angebots.
finePrint

string

Das Kleingedruckte oder die Bedingungen des Angebots, z. B. „20% Rabatt auf ein beliebiges T-Shirt bei Adam's Bekleidung“.
helpUri

object (Uri)

Den 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 FinePrint.
shortTitle

string

Eine gekürzte Version des Angebotstitels, z. B. „20% Rabatt“, die Nutzern als Kurzreferenz zu den Angebotsinhalten angezeigt wird. Die empfohlene maximale Länge beträgt 20 Zeichen.
localizedShortTitle

object (LocalizedString)

Übersetzte Strings für den Kurztitel. Die empfohlene maximale Länge beträgt 20 Zeichen.
classTemplateInfo

object (ClassTemplateInfo)

Vorlageninformationen dazu, wie die Klasse angezeigt werden soll. Wenn die Richtlinie nicht konfiguriert ist, verwendet Google einen Standardsatz von Feldern, die angezeigt werden sollen.
id

string

Erforderlich. Die eindeutige Kennung für eine Klasse. Diese ID muss für alle Klassen eines Ausstellers eindeutig sein. Dieser Wert muss das Format issuer ID haben.identifier, bei denen ersteres von Google ausgestellt und Letzteres von Ihnen ausgewählt wird. Ihre eindeutige Kennung darf nur alphanumerische Zeichen, „.“, „_“ oder „-“ enthalten.
version
(deprecated)

string (int64 format)

Eingestellte Funktionen
issuerName

string

Erforderlich. Der Ausstellername. Die empfohlene maximale Länge ist 20 Zeichen, damit der vollständige String auf kleineren Displays angezeigt wird.
messages[]

object (Message)

Ein Array von Nachrichten, das in der App angezeigt wird. Alle Nutzer dieses Objekts erhalten die zugehörigen Nachrichten. Es sind maximal 10 Felder zulässig.
allowMultipleUsersPerObject
(deprecated)

boolean

Veraltet. Verwenden Sie stattdessen multipleDevicesAndHoldersAllowedStatus.
homepageUri

object (Uri)

URI der Startseite Ihrer Anwendung. Das Ausfüllen des URI in dieses Feld führt genau zu dem gleichen Verhalten wie das Ausfüllen eines URI in „linksModuleData“. Beim Rendern eines Objekts wird ein Link zur Startseite angezeigt, was normalerweise als LinksModuleData-Abschnitt des Objekts angesehen wird.
locations[]

object (LatLongPoint)

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

enum (ReviewStatus)

Erforderlich. Der Status des Kurses. Für dieses Feld kann draft oder der Status des Kurses festgelegt werden. Dieses Feld kann mithilfe der API-Aufrufe „Insert“, „Patch“ oder „Update“ auf draft oder underReview festgelegt werden. Wenn der Überprüfungsstatus von „draft“ geändert wird, kann er nicht mehr zu „draft“ geändert werden.

Sie sollten dieses Feld auf draft belassen, wenn sich die Klasse in der Entwicklung befindet. Eine draft-Klasse kann nicht zum Erstellen von Objekten verwendet werden.

Sie sollten dieses Feld auf underReview setzen, wenn Sie der Meinung sind, dass der Kurs einsatzbereit ist. Die Plattform setzt dieses Feld automatisch auf approved und kann sofort zum Erstellen oder Migrieren von Objekten verwendet werden.

Wenn Sie einen bereits approved-Kurs aktualisieren, sollten Sie dieses Feld auf underReview setzen.
review

object (Review)

Die Kommentare, die von der Plattform eingestellt werden, wenn ein Kurs mit approved oder rejected markiert ist.
infoModuleData
(deprecated)

object (InfoModuleData)

Veraltet. Verwende stattdessen „textModulesData“.
imageModulesData[]

object (ImageModuleData)

Bildmoduldaten. Es werden maximal 1 Feld auf Objektebene und 1 Feld auf Klassenobjektebene angezeigt.
textModulesData[]

object (TextModuleData)

Textmoduldaten. Wenn für die Klasse auch Textmoduldaten definiert sind, werden beide angezeigt. Es werden maximal 10 Felder aus dem Objekt und 10 aus 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 durch ihre Aussteller-ID identifiziert. Für Einlösungsaussteller muss mindestens ein Smart-Bonus-Schlüssel konfiguriert sein.

Die Felder enableSmartTap und smartTapRedemptionLevel auf Objektebene müssen ebenfalls korrekt eingerichtet sein, damit Karten/Tickets Smart-Bonus unterstützen.
countryCode

string

Der Ländercode wird verwendet, um das Land der Karte anzuzeigen (wenn der Nutzer sich nicht in diesem Land befindet) sowie um lokalisierte Inhalte anzuzeigen, wenn diese für die Sprache des Nutzers nicht verfügbar sind.
heroImage

object (Image)

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

object (Image)

Veraltet.
enableSmartTap

boolean

Gibt an, ob diese Klasse Smart-Bonus unterstützt. Die Felder redemptionIssuers und smartTapRedemptionLevel auf Objektebene müssen ebenfalls korrekt eingerichtet sein, damit Karten/Tickets Smart-Bonus unterstützen.
hexBackgroundColor

string

Die Hintergrundfarbe der Karte. Wenn 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 wie #ffcc00 ist. Du kannst auch die Kurzversion des RGB-Triplets #rgb verwenden, z. B. #fc0.
localizedIssuerName

object (LocalizedString)

Übersetzte Strings für den Ausstellername. 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 und auf diese Klasse verweisen.
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 kommen für den Callback infrage.
securityAnimation

object (SecurityAnimation)

Optionale Informationen zur Sicherheitsanimation. Wenn dies festgelegt ist, wird eine Sicherheitsanimation in den Details der Karte / des Tickets gerendert.
viewUnlockRequirement

enum (ViewUnlockRequirement)

Optionen für „Entsperrungsanforderung“ für das Angebot ansehen.
wideTitleImage

object (Image)

Das breite Titelbild des Angebots. Wird anstelle des Titelbilds oben links in der Kartenansicht angegeben.

RedemptionChannel

Enums
REDEMPTION_CHANNEL_UNSPECIFIED
INSTORE
instore

Altes Alias für INSTORE. Veraltet.
ONLINE
online

Altes Alias für ONLINE. Veraltet.
BOTH
both

Altes Alias für BOTH. Veraltet.
TEMPORARY_PRICE_REDUCTION
temporaryPriceReduction

Altes Alias für TEMPORARY_PRICE_REDUCTION. Veraltet.

Methoden

addmessage

 Fügt 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 Eigenschaften ein.

list

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

patch

 Aktualisiert die Angebotsklasse, auf die die angegebene Klassen-ID verweist.

update

 Aktualisiert die Angebotsklasse, auf die die angegebene Klassen-ID verweist.