REST Resource: giftcardobject

Ressource: GiftCardObject

JSON-Darstellung 
{
  "kind": string,
  "classReference": {
    object (GiftCardClass)
  },
  "cardNumber": string,
  "pin": string,
  "balance": {
    object (Money)
  },
  "balanceUpdateTime": {
    object (DateTime)
  },
  "eventNumber": string,
  "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

Kennzeichnet, welche Art von Ressource dies ist. Wert: der feste String "walletobjects#giftCardObject".
classReference

object (GiftCardClass)

Eine Kopie der übernommenen Felder der übergeordneten Klasse. Diese Felder werden bei einem GET-Vorgang abgerufen.
cardNumber

string

Erforderlich. Die Kartennummer.
pin

string

Die PIN der Karte.
balance

object (Money)

Das Guthaben der Karte.
balanceUpdateTime

object (DateTime)

Datum und Uhrzeit der letzten Aktualisierung des Guthabens.

Offset ist erforderlich.

Wenn das Guthaben aktualisiert wird und diese Property nicht angegeben ist, verwendet das System standardmäßig die aktuelle Uhrzeit.
eventNumber

string

Die Ereignisnummer der Karte, ein optionales Feld, das bei einigen Geschenkkarten verwendet wird.
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 von Google ausgegeben und von dir ausgewählt wird. Die eindeutige Kennung darf nur alphanumerische Zeichen, „.“ (Punkt), „_“ (Unterstrich) oder „-“ (Bindestriche) 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 dem Format issuer ID entsprechen.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. Beispielsweise wird ein inactive-Objekt 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 das Objekt 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 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 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.
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 „wahr“ gesetzt ist, werden unabhängig vom Feld messages keine Ablaufbenachrichtigungen an den Nutzer gesendet. 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. Es werden maximal ein Feld aus der Objektebene und eines auf der Klassenobjektebene angezeigt.
textModulesData[]

object (TextModuleData)

Textmoduldaten. Wenn für den Kurs auch Textmoduldaten definiert sind, werden beide angezeigt. Es werden maximal 10 Felder vom Objekt und 10 aus 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 das Hero-Image der Klasse 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.
passConstraints

object (PassConstraints)

Übergeben Sie die 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 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 eine bereits gespeicherte Karte bzw. ein bereits gespeichertes Ticket angewendet.
linkedObjectIds[]

string

verknüpfteObjectIds sind eine Liste weiterer Objekte wie Veranstaltungstickets, Treuepunkte, Angebote, generische, Geschenkkarten, öffentliche Verkehrsmittel und Bordkarten, die automatisch an dieses Geschenkkartenobjekt angehängt werden sollen. Wenn ein Nutzer diese Geschenkkarte gespeichert hat, werden diese linkedObjectIds 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 können die verknüpften Objekte nicht mehr getrennt werden. Sie können keine Objekte verknüpfen, die einem anderen Aussteller gehören. Die Anzahl der Objekte, die mit einem einzelnen Objekt verknüpft werden können, ist begrenzt. Nachdem das Limit erreicht wurde, werden neue verknüpfte Objekte im Aufruf ohne Meldung 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 temporär und muss bei jeder PATCH- oder UPDATE-Anfrage festgelegt werden. Andernfalls wird keine Benachrichtigung ausgelöst.
valueAddedModuleData[]

object (ValueAddedModuleData)

Optionale Moduldaten mit Mehrwert. Maximal zehn für das Objekt.

Methoden

addmessage

 Fügt dem Geschenkkartenobjekt, auf das durch die angegebene Objekt-ID verwiesen wird, eine Nachricht hinzu.

get

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

insert

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

list

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

patch

 Aktualisiert das Geschenkkartenobjekt, auf das durch die angegebene Objekt-ID verwiesen wird.

update

 Aktualisiert das Geschenkkartenobjekt, auf das durch die angegebene Objekt-ID verwiesen wird.