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)
  },
  "appLinkData": {
    object (AppLinkData)
  }
}
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 ein beliebiges T-Shirt“. Die empfohlene maximale Länge ist 60 Zeichen, damit der vollständige String auf kleineren Bildschirmen angezeigt wird.
redemptionChannel

enum (RedemptionChannel)

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

string

Erforderlich. Der Angebotsanbieter (entweder der Name des Aggregators oder der Händlername) Die empfohlene maximale Länge ist 12 Zeichen, damit der vollständige String auf kleineren Bildschirmen 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, wie z. B. „20% Rabatt auf ein beliebiges T-Shirt von Adams Bekleidung“.
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 Bildschirmen 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 Bildschirmen 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“, den Nutzern als Kurzübersicht über den Angebotsinhalt angezeigt wird. Die empfohlene Höchstlänge beträgt 20 Zeichen.
localizedShortTitle

object (LocalizedString)

Übersetzte Strings für den kurzen Titel. Die empfohlene Höchstlänge beträgt 20 Zeichen.
classTemplateInfo

object (ClassTemplateInfo)

Vorlageninformationen darüber, wie die Klasse angezeigt werden soll. Wenn die Richtlinie nicht konfiguriert ist, greift Google auf die Standardfelder zurück, die angezeigt werden sollen.
id

string

Erforderlich. Die eindeutige Kennung einer Klasse. Diese ID muss für alle Klassen 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 darf nur alphanumerische Zeichen sowie „.“, „_“ oder „-“ enthalten.
version
(deprecated)

string (int64 format)

Verworfen
issuerName

string

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

object (Message)

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.
allowMultipleUsersPerObject
(deprecated)

boolean

Verworfen. Verwenden Sie stattdessen multipleDevicesAndHoldersAllowedStatus.
homepageUri

object (Uri)

Der URI der Startseite Ihrer Anwendung. Das Ausfüllen des URI in diesem Feld führt zu demselben Verhalten wie das Ausfüllen eines URI in linksModuleData (wenn ein Objekt gerendert wird, wird ein Link zur Startseite in dem dargestellt, was man normalerweise als linkModuleData-Abschnitt des Objekts bezeichnen würde).
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. Dieses Feld kann auf draft oder den Status des Kurses gesetzt werden. Dieses Feld kann mithilfe der API-Aufrufe zum Einfügen, Patchen oder Aktualisieren auf draft oder underReview festgelegt werden. Nachdem der Überprüfungsstatus von draft geändert wurde, kann er nicht mehr in 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 eines Objekts 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 es kann sofort zum Erstellen oder Migrieren von Objekten verwendet werden.

Wenn Sie eine bereits 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 als approved oder rejected markiert wird.
infoModuleData
(deprecated)

object (InfoModuleData)

Verworfen. Verwenden Sie stattdessen textModulesData.
imageModulesData[]

object (ImageModuleData)

Bildmoduldaten. Es werden maximal ein Feld aus der Objektebene und eines auf der Klassenobjektebene angezeigt.
textModulesData[]

object (TextModuleData)

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.
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. Einlösungsaussteller müssen mindestens einen Smart-Bonus-Schlüssel konfiguriert haben.

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

string

Ländercode, mit dem das Land der Karte angezeigt wird (wenn sich der Nutzer nicht in diesem Land befindet) sowie der lokalisierte Inhalt, wenn der Inhalt nicht für die Sprache des Nutzers verfügbar ist.
heroImage

object (Image)

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

object (Image)

Verworfen.
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 Smart-Bonus von Karten/Tickets unterstützt wird.
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 verwenden (#rgb), z. B. #fc0.
localizedIssuerName

object (LocalizedString)

Übersetzte Strings für den Ausstellernamen. Die empfohlene maximale Länge ist 20 Zeichen, damit der vollständige String auf kleineren Bildschirmen 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, die verwendet werden sollen, um den Aussteller beim Speichern/Löschen eines Objekts für diese Klasse durch den Endnutzer zurückzurufen. Alle Objekte dieser Klasse sind für den Callback berechtigt.
securityAnimation

object (SecurityAnimation)

Optionale Informationen zur Sicherheitsanimation. Wenn diese Richtlinie konfiguriert ist, wird bei den Details der Karte / des Tickets eine Sicherheitsanimation gerendert.
viewUnlockRequirement

enum (ViewUnlockRequirement)

Sehen Sie sich die Optionen für „Anforderungen zum Entsperren“ für das Angebot an.
wideTitleImage

object (Image)

Das breite Titelbild des Angebots. Dieses Attribut wird anstelle des Titelbilds oben links in der Kartenansicht verwendet.

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ügt der Angebotsklasse, auf die von der angegebenen Klassen-ID verwiesen wird, 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 Eigenschaften ein.

list

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

patch

 Aktualisiert die Angebotsklasse, auf die von der angegebenen Klassen-ID verwiesen wird.

update

 Aktualisiert die Angebotsklasse, auf die von der angegebenen Klassen-ID verwiesen wird.