Diese Seite wurde von der Cloud Translation API übersetzt.

REST Resource: offerclass

Ressource: Angebotsklasse
- JSON-Darstellung
- RedemptionChannel
Methoden

Ressource: OfferClass

JSON-Darstellung

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`) } ] }

{
  "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` Dieses Element ist veraltet. 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 Einlösungskanäle, die für dieses Angebot gelten.
`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 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 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 Kurzreferenz für den Angebotsinhalt angezeigt wird. Die empfohlene maximale Länge ist 20 Zeichen.
`localizedShortTitle`	`object (LocalizedString)` Übersetzte Strings für den kurzen Titel. 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.
`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 die erstere von Google ausgestellt und die zweite von Ihnen ausgewählt wird. Die eindeutige Kennung darf nur alphanumerische Zeichen sowie „.“, „_“ oder „-“ enthalten.
`version (deprecated)`	`string (int64 format)` Dieses Element ist veraltet. 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` Dieses Element ist veraltet. 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)` Dieses Element ist veraltet. 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 Überprüfungsstatus 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` gesetzt bleiben. Eine `draft`-Klasse kann nicht zum Erstellen eines Objekts verwendet 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 von der Plattform festgelegten Rezensionskommentare, wenn ein Kurs mit `approved` oder `rejected` gekennzeichnet ist.
`infoModuleData (deprecated)`	`object (InfoModuleData)` Dieses Element ist veraltet. Verworfen. Verwenden Sie stattdessen textModulesData.
`imageModulesData[]`	`object (ImageModuleData)` Daten des Bildmoduls. 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. Es werden maximal 10 Felder des Objekts und 10 Felder der Klasse angezeigt.
`linksModuleData`	`object (LinksModuleData)` Linkmoduldaten. Wenn für das Objekt auch Linkmoduldaten definiert sind, werden beide 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. 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. Andernfalls wird nichts angezeigt. Das Bild wird mit einer Breite von 100% angezeigt.
`wordMark (deprecated)`	`object (Image)` Dieses Element ist veraltet. 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 wie `#ffcc00` ist. Du kannst auch die Kurzversion des RGB-Triplets (#`rgb`) verwenden, 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 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 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. 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.
`appLinkData`	`object (AppLinkData)` Optionaler Link zu einer App oder Website, der auf der Vorderseite der Karte/des Tickets als Schaltfläche angezeigt wird. Wenn für das entsprechende Objekt „AppLinkData“ angegeben ist, wird dies stattdessen verwendet.
`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. Dieses Element ist veraltet.
`ONLINE`
`online`	Alter Alias für `ONLINE`. Verworfen. Dieses Element ist veraltet.
`BOTH`
`both`	Alter Alias für `BOTH`. Verworfen. Dieses Element ist veraltet.
`TEMPORARY_PRICE_REDUCTION`
`temporaryPriceReduction`	Alter Alias für `TEMPORARY_PRICE_REDUCTION`. Verworfen. Dieses Element ist veraltet.

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 von der angegebenen Klassen-ID verwiesen wird.
`update`	Aktualisiert die Angebotsklasse, auf die durch die angegebene Klassen-ID verwiesen wird.

REST Resource: offerclass

Ressource: OfferClass

RedemptionChannel

Methoden

`addmessage`

`get`

`insert`

`list`

`patch`

`update`