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

string

Gibt an, welche Art von Ressource dies ist. 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 Inhabers des Treuepunktekontos, z. B. „Max Mustermann“. Die empfohlene maximale Länge beträgt 20 Zeichen, damit der vollständige String auf kleineren Bildschirmen angezeigt wird.

accountId

string

Die ID des Kontos für das Treuepunkteprogramm. Die empfohlene Höchstlänge beträgt 20 Zeichen.

loyaltyPoints

object (LoyaltyPoints)

Label, Guthaben und Typ der Treueprämienpunkte

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 ausgegeben und letzter von Ihnen ausgewählt wird.

secondaryLoyaltyPoints

object (LoyaltyPoints)

Label, Guthaben und Typ der sekundären Prämienpunkte für 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 ausgegeben und letzter von Ihnen ausgewählt wird. Die eindeutige Kennung darf nur alphanumerische Zeichen, „.“, „_“ oder „-“ enthalten.

classId

string

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

Klassen-IDs müssen das Format issuer ID haben.identifier, wobei ersteres von Google ausgegeben und letzter von Ihnen ausgewählt wird.

version
(deprecated)

string (int64 format)

Eingestellte Funktionen

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)

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. Es sind maximal 10 Felder zulässig.

validTimeInterval

object (TimeInterval)

Der Zeitraum, in dem dieses Objekt active ist und verwendet werden kann. Nach Ablauf dieses Zeitraums ändert sich der Status eines Objekts in expired.

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. Auch die Felder auf Kursebene enableSmartTap und redemptionIssuers müssen 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 auf Klassenebene enableSmartTap und redemptionIssuers 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. Für die Verwendung durch ausgewählte Partner vorgesehen. Weitere Informationen erhalten Sie beim 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“ Ablaufbenachrichtigungen an den Nutzer unterdrückt. Die Standardeinstellung für dieses Feld ist „false“.

Derzeit kann dies nur für Angebote festgelegt werden.

infoModuleData

object (InfoModuleData)

Veraltet. Verwenden Sie stattdessen „textModulesData“.

imageModulesData[]

object (ImageModuleData)

Bildmoduldaten. Es werden maximal 1 Feld auf Objektebene und 1 Feld auf Klassenobjektebene angezeigt.

textModulesData[]

object (TextModuleData)

Textmoduldaten. Wenn für die Klasse auch Textmoduldaten definiert sind, werden beide angezeigt. Es werden maximal 10 Felder vom Objekt und 10 Felder aus der Klasse angezeigt.

rotatingBarcode

object (RotatingBarcode)

Typ und Wert des rotierenden Barcodes.

heroImage

object (Image)

Optionales Bannerbild auf der Vorderseite der Karte. Ist keins vorhanden, wird, sofern vorhanden, 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. Einschließlich der Beschränkung des NFC- und Screenshot-Verhaltens.

LoyaltyPoints

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

string

Das Treuepunktelabel, 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 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 Kontostands. Nur einer dieser Untertypen (String, Ganzzahl, doppelt, Geld) darf ausgefüllt werden.

int

integer

Die Ganzzahlform eines Kontostands. Nur einer dieser Untertypen (String, Ganzzahl, doppelt, Geld) darf ausgefüllt werden.

double

number

Die Doppelform eines Gleichgewichts. Nur einer dieser Untertypen (String, Ganzzahl, doppelt, Geld) darf ausgefüllt werden.

money

object (Money)

Die Geldform eines Guthabens. Nur einer dieser Untertypen (String, Ganzzahl, doppelt, Geld) darf 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

Fügt ein Treuepunkteobjekt mit der angegebenen ID und 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 Treuepunkteobjekt, auf das die angegebene Objekt-ID verweist.

update

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