REST Resource: loyaltyobject

Ressource: LoyaltyObject

JSON-Darstellung 
{
  "kind": string,
  "classReference": {
    object (LoyaltyClass)
  },
  "accountName": string,
  "accountId": string,
  "loyaltyPoints": {
    object (LoyaltyPoints)
  },
  "linkedOfferIds": [
    string
  ],
  "secondaryLoyaltyPoints": {
    object (LoyaltyPoints)
  },
  "id": string,
  "classId": string,
  "version": string,
  "state": enum (State),
  "barcode": {
    object (Barcode)
  },
  "messages": [
    {
      object (Message)
    }
  ],
  "validTimeInterval": {
    object (TimeInterval)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "hasUsers": boolean,
  "smartTapRedemptionValue": string,
  "hasLinkedDevice": boolean,
  "disableExpirationNotification": boolean,
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "appLinkData": {
    object (AppLinkData)
  },
  "rotatingBarcode": {
    object (RotatingBarcode)
  },
  "heroImage": {
    object (Image)
  },
  "groupingInfo": {
    object (GroupingInfo)
  },
  "passConstraints": {
    object (PassConstraints)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  }
}
Felder
kind
(deprecated)

string

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

object (LoyaltyClass)

Eine Kopie der übernommenen Felder der übergeordneten Klasse. Diese Felder werden während einer GET-Anfrage abgerufen.
accountName

string

Der Name des Kontoinhabers für das Treuepunkteprogramm, z. B. „Max Mustermann“. Die empfohlene maximale Länge ist 20 Zeichen, damit der vollständige String auf kleineren Bildschirmen angezeigt wird.
accountId

string

Die Konto-ID des Treuepunkteprogramms. Die empfohlene Höchstlänge beträgt 20 Zeichen.
loyaltyPoints

object (LoyaltyPoints)

Label, Guthaben und Typ der Treuepunkte
linkedOfferIds[]

string

Eine Liste der Angebotsobjekte, die mit dieser Kundenkarte verknüpft sind. Die Angebotsobjekte müssen bereits vorhanden sein.

Angebotsobjekt-IDs müssen das Format issuer ID haben.identifier, wobei Ersteres von Google ausgestellt und Letzteres von Ihnen ausgewählt wird.
secondaryLoyaltyPoints

object (LoyaltyPoints)

Das sekundäre Label, Guthaben und Typ der Treuepunkte. Wird zusätzlich zu den primären Treuepunkten angezeigt.
id

string

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 darf nur alphanumerische Zeichen sowie „.“, „_“ oder „-“ enthalten.
classId

string

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

string (int64 format)

Verworfen
state

enum (State)

Erforderlich. Der Status des Objekts. Mit diesem Feld wird festgelegt, wie ein Objekt in der App angezeigt wird. Beispielsweise wird ein inactive-Objekt in den Ordner „Abgelaufene Karten/Tickets“ verschoben .
barcode

object (Barcode)

Typ und Wert des Barcodes.
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.
validTimeInterval

object (TimeInterval)

Der Zeitraum, in dem dieses Objekt active ist und das Objekt verwendet werden kann. Der Status eines Objekts wird nach Ablauf dieses Zeitraums in expired geändert.
locations[]

object (LatLongPoint)

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

boolean

Gibt an, ob das Objekt Nutzer hat. Dieses Feld wird von der Plattform festgelegt.
smartTapRedemptionValue

string

Der Wert, der für dieses Objekt über NFC an ein Smart-Bonus-zertifiziertes Terminal übertragen wird. Die Felder auf Klassenebene enableSmartTap und redemptionIssuers müssen ebenfalls korrekt eingerichtet sein, damit die Karte bzw. das Ticket Smart-Bonus unterstützt. Es werden nur ASCII-Zeichen unterstützt.

Wenn dieser Wert nicht festgelegt ist, aber die Felder enableSmartTap und redemptionIssuers auf Klassenebene korrekt eingerichtet sind, werden die Felder barcode.value oder accountId als Fallback verwendet, sofern vorhanden.
hasLinkedDevice

boolean

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

boolean

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 messages unterdrückt. Standardmäßig ist dieses Feld auf „false“ gesetzt.

Diese Option kann derzeit nur für Angebote festgelegt werden.
infoModuleData

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.
rotatingBarcode

object (RotatingBarcode)

Typ und Wert des rotierenden Barcodes.
heroImage

object (Image)

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

object (GroupingInfo)

Informationen, die steuern, wie Karten/Tickets gruppiert werden.
passConstraints

object (PassConstraints)

Übergeben Sie die Einschränkungen für das Objekt. Dazu gehört auch das Einschränken von NFC- und Screenshot-Verhalten.
saveRestrictions

object (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.

LoyaltyPoints

JSON-Darstellung 
{
  "label": string,
  "balance": {
    object (LoyaltyPointsBalance)
  },
  "localizedLabel": {
    object (LocalizedString)
  }
}
Felder
label

string

Das Label der Treuepunkte, z. B. „Punkte“. Die empfohlene Höchstlänge beträgt 9 Zeichen.
balance

object (LoyaltyPointsBalance)

Der Treuepunktestand des Kontoinhabers, z. B. „500“ oder „€ 10,00“. Die empfohlene Höchstlänge beträgt 7 Zeichen. Dies ist ein Pflichtfeld von loyaltyPoints und secondaryLoyaltyPoints.
localizedLabel

object (LocalizedString)

Übersetzte Strings für das Label. Die empfohlene Höchstlänge beträgt 9 Zeichen.

LoyaltyPointsBalance

JSON-Darstellung 
{
  "string": string,
  "int": integer,
  "double": number,
  "money": {
    object (Money)
  }
}
Felder
string

string

Die Zeichenfolgenform eines Guthabens. Nur einer dieser Untertypen (string, int, double, money) sollte ausgefüllt werden.
int

integer

Die Ganzzahlform eines Kontostands. Nur einer dieser Untertypen (string, int, double, money) sollte ausgefüllt werden.
double

number

Die doppelte Form eines Gleichgewichts. Nur einer dieser Untertypen (string, int, double, money) sollte ausgefüllt werden.
money

object (Money)

Die Geldform eines Guthabens. Nur einer dieser Untertypen (string, int, double, money) sollte ausgefüllt werden.

Methoden

addmessage

 Fügt dem Treuepunkteobjekt, auf das die angegebene Objekt-ID verweist, eine Nachricht hinzu.

get

 Gibt das Treueobjekt mit der angegebenen Objekt-ID zurück

insert

 Fügt ein Treueobjekt mit der angegebenen ID und den angegebenen Eigenschaften ein.

list

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

modifylinkedofferobjects

 Ändert verknüpfte Angebotsobjekte für das Treuepunkteobjekt mit der angegebenen ID.

patch

 Aktualisiert das Treueobjekt, auf das von der angegebenen Objekt-ID verwiesen wird.

update

 Aktualisiert das Treueobjekt, auf das von der angegebenen Objekt-ID verwiesen wird.