REST Resource: loyaltyobject

Mit Sammlungen den Überblick behalten Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.

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

string

Gibt die Art der Ressource an. Wert: der feste String "walletobjects#loyaltyObject".

classReference

object (LoyaltyClass)

Eine Kopie der übernommenen Felder der übergeordneten Klasse. Diese Felder werden während eines GET-Vorgangs abgerufen.

accountName

string

Der Name des Kontoinhabers für das Treuepunkteprogramm, z. B. Max Mustermann&&t; Wir empfehlen eine maximale Länge von 20 Zeichen, damit der vollständige String auf kleineren Bildschirmen angezeigt wird.

accountId

string

Die Kontokennung für das Treuepunkteprogramm. Die empfohlene maximale Länge beträgt 20 Zeichen.

loyaltyPoints

object (LoyaltyPoints)

Label, Guthaben und Typ der Treuepunkte.

linkedOfferIds[]

string

Eine Liste von Angebotsobjekten, 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 wird und Letzteres von Ihnen ausgewählt wird.

secondaryLoyaltyPoints

object (LoyaltyPoints)

Sekundäres Treuepunktesymbol für 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 sollte das Format issuer ID haben.identifier, wobei Ersteres von Google ausgestellt wird und Letzteres von Ihnen ausgewählt wird. Die eindeutige ID darf nur alphanumerische Zeichen enthalten, &&339;.', '_' oder '-'.

classId

string

Erforderlich. Die mit diesem Objekt verknüpfte Klasse. Die Klasse muss vom selben Typ wie dieses Objekt sein, muss bereits vorhanden sein und genehmigt werden.

Kurs-IDs müssen das Format issuer ID haben.identifier, wobei Ersteres von Google ausgestellt wird 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 Abschnitt „Abgelaufene Karten“ verschoben.

barcode

object (Barcode)

Typ und Wert des Barcodes

messages[]

object (Message)

Ein Array 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, kann verwendet werden. Der Status eines Objekts wird nach Ablauf dieses Zeitraums in expired geändert.

locations[]

object (LatLongPoint)

Die Liste der Standorte, an denen das Objekt verwendet werden kann. Die Plattform verwendet diese Informationen, um Nutzern geografische Benachrichtigungen anzuzeigen. Standorte im Objekt überschreiben Orte in der Klasse, die Orte in der Google Places-ID überschreiben.

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 gesendet wird. Die Felder enableSmartTap und redemptionIssuers auf Kursebene müssen auch richtig eingerichtet sein, damit der Pass die Funktion „Smart-Bonus“ unterstützen kann. Es werden nur ASCII-Zeichen unterstützt.

Wenn dieser Wert nicht festgelegt ist, aber die Felder auf Kursebene enableSmartTap und redemptionIssuers korrekt eingerichtet sind, werden die Felder barcode.value oder accountId als Fallback verwendet, falls 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 unabhängig vom Feld messages die Ablaufbenachrichtigungen an den Nutzer unterdrückt. Standardmäßig ist dieses Feld auf „false“ gesetzt.

Derzeit kann dies nur für Angebote festgelegt werden.

infoModuleData

object (InfoModuleData)

Veraltet. Verwenden Sie stattdessen textModulesData.

imageModulesData[]

object (ImageModuleData)

Bildmoduldaten. Die maximale Anzahl dieser Felder ist 1 auf Objektebene und 1 für die Objektebene.

textModulesData[]

object (TextModuleData)

Textmoduldaten. Wenn auch Textmoduldaten für die Klasse definiert sind, werden beide angezeigt. Die maximale Anzahl der angezeigten Felder ist 10 vom Objekt und 10 aus der Klasse.

rotatingBarcode

object (RotatingBarcode)

Typ und Wert des rotierenden Barcodes

heroImage

object (Image)

Optionales Bannerbild auf der Vorderseite der Karte. Ist keines vorhanden, wird das Hero-Image des Kurses angezeigt, sofern vorhanden. Wenn auch kein Hero-Image des Kurses vorhanden ist, wird nichts angezeigt.

groupingInfo

object (GroupingInfo)

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

Treuepunkte

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

string

Das Label für Treuepunkte, z. B. "Points" Die maximale Länge beträgt 9 Zeichen.

balance

object (LoyaltyPointsBalance)

Der Treuepunktestand des Kontoinhabers, z. B. 500 € oder 10,00 €. Die empfohlene maximale Länge beträgt 7 Zeichen. Dies ist ein Pflichtfeld von loyaltyPoints und secondaryLoyaltyPoints.

localizedLabel

object (LocalizedString)

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

LoyaltyPointsGuthaben

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

string

Stringform eines Kontostands. Nur einer dieser Untertypen (String, Ganzzahl, Double, Geld) sollte ausgefüllt werden.

int

integer

Entspricht der Ganzzahlform eines Saldos. Nur einer dieser Untertypen (String, Ganzzahl, Double, Geld) sollte ausgefüllt werden.

double

number

Die doppelte Form eines Saldos. Nur einer dieser Untertypen (String, Ganzzahl, Double, Geld) sollte ausgefüllt werden.

money

object (Money)

Die Geldform eines Saldos. Nur einer dieser Untertypen (String, Ganzzahl, Double, Geld) sollte ausgefüllt werden.

Methoden

addmessage

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

list

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

modifylinkedofferobjects

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

patch

Aktualisiert das Treueobjekt, auf das die angegebene Objekt-ID verweist.

update

Aktualisiert das Treueobjekt, auf das die angegebene Objekt-ID verweist.