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)
  },
  "linkedObjectIds": [
    string
  ],
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
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 bei einem GET-Vorgang abgerufen.
accountName

string

Der Name des Kontoinhabers des Treuepunktekontos, 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 Kennung des Treuepunktekontos. Die empfohlene maximale Länge ist 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 dem Format issuer ID entsprechen.identifier, wobei von Google ausgegeben und von dir ausgewählt wird.
secondaryLoyaltyPoints

object (LoyaltyPoints)

Label, Guthaben und Typ der sekundären 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 von Google ausgegeben und von dir 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 vom selben Typ wie dieses Objekt sein, bereits vorhanden und genehmigt sein.

Klassen-IDs müssen das Format issuer ID haben.identifier, wobei von Google ausgegeben und von dir 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. Ein inactive-Objekt wird beispielsweise in den Abschnitt „Abgelaufene Karten/Tickets“ verschoben.
barcode

object (Barcode)

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

object (TimeInterval)

Der Zeitraum, in dem dieses Objekt active ist und verwendet werden kann. Nach Ablauf dieses Zeitraums ändert sich der Status des Objekts in expired.
locations[]
(deprecated)

object (LatLongPoint)

Hinweis: Dieses Feld wird derzeit nicht zum Auslösen von 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 enableSmartTap und redemptionIssuers auf Klassenebene müssen ebenfalls richtig 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 mit seinem Gerät verknüpft. Nur für ausgewählte Partner bestimmt. Weitere Informationen erhalten Sie vom Support.
disableExpirationNotification

boolean

Gibt an, ob Benachrichtigungen ausdrücklich 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.

Derzeit kann dies nur für Angebote festgelegt werden.
infoModuleData

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

object (RotatingBarcode)

Der 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 das Hero-Image des Kurses nicht vorhanden ist, wird nichts angezeigt.
groupingInfo

object (GroupingInfo)

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

object (PassConstraints)

Einschränkungen für das Objekt. Dazu gehört auch die Einschränkung des NFC- und Screenshot-Verhaltens.
saveRestrictions

object (SaveRestrictions)

Einschränkungen für das Objekt, die überprüft werden müssen, bevor der Nutzer versucht, die Karte bzw. das Ticket zu speichern. Diese Einschränkungen gelten nur während der Speicherzeit. Wenn sich die Einschränkungen ändern, nachdem ein Nutzer die Karte bzw. das Ticket gespeichert hat, werden die neuen Einschränkungen nicht auf eine bereits gespeicherte Karte bzw. ein bereits gespeichertes Ticket angewendet.
linkedObjectIds[]

string

„linkedObjectIds“ ist eine Liste anderer Objekte wie Veranstaltungstickets, Kundenkarten, Angebote, generische Karten/Tickets, Geschenkkarten, Fahrkarten und Bordkarten, die automatisch an dieses Treuepunkteobjekt angehängt werden sollen. Wenn ein Nutzer diese Kundenkarte gespeichert hat, werden diese verknüpften Objekt-IDs automatisch an die Wallet des Nutzers gesendet, es sei denn, er hat die Einstellung deaktiviert, um solche verknüpften Karten/Tickets zu erhalten.

Achten Sie darauf, dass Objekte, die in „linkedObjectIds“ vorhanden sind, bereits eingefügt wurden. Andernfalls schlagen Aufrufe fehl. Nach der Verknüpfung kann die Verknüpfung der verknüpften Objekte nicht mehr aufgehoben werden. Sie können keine Objekte verknüpfen, die zu einem anderen Aussteller gehören. Die Anzahl der Objekte, die mit einem einzelnen Objekt verknüpft werden können, ist begrenzt. Wenn das Limit erreicht ist, werden neue verknüpfte Objekte im Anruf stumm ignoriert.

Objekt-IDs müssen dem Format issuer ID entsprechen.identifier, wobei von Google ausgegeben und von dir ausgewählt wird.
notifyPreference

enum (NotificationSettingsForUpdates)

Gibt an, ob Feldaktualisierungen für dieses Objekt 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 „DO_NOT_NOTIFY“ oder „NOTIFICATION_SETTINGS_UNSPECIFIED“ festgelegt ist, wird keine Benachrichtigung ausgelöst. Diese Einstellung ist sitzungsspezifisch und muss bei jeder PATCH- oder UPDATE-Anfrage festgelegt werden. Andernfalls wird keine Benachrichtigung ausgelöst.
valueAddedModuleData[]

object (ValueAddedModuleData)

Optionale Daten zum Mehrwertmodul. Höchstens zehn für das Objekt.

LoyaltyPoints

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

string

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

object (LoyaltyPointsBalance)

Das Treuepunkteguthaben des Kontoinhabers, z. B. „500“ oder „10,00 €“. Die empfohlene maximale Länge beträgt 7 Zeichen. Dies ist ein Pflichtfeld für loyaltyPoints und secondaryLoyaltyPoints.
localizedLabel

object (LocalizedString)

Übersetzte Strings für das Label. Die empfohlene maximale Länge beträgt 9 Zeichen.

LoyaltyPointsBalance

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

string

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

integer

Die Ganzzahlform eines Guthabens. Es sollte nur einer dieser Untertypen (string, int, double, money) ausgefüllt werden.
double

number

Die doppelte Form einer Waage. Es sollte nur einer dieser Untertypen (string, int, double, money) ausgefüllt werden.
money

object (Money)

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

Methoden

addmessage

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

get

 Gibt das Treuepunkteobjekt mit der angegebenen Objekt-ID zurück.

insert

 Ein Treuepunkteobjekt mit der angegebenen ID und den angegebenen Eigenschaften wird eingefügt.

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 Treuepunkteobjekt, auf das durch die angegebene Objekt-ID verwiesen wird.