REST Resource: giftcardclass

{
  "kind": string,
  "merchantName": string,
  "programLogo": {
    object (Image)
  },
  "pinLabel": string,
  "eventNumberLabel": string,
  "allowBarcodeRedemption": boolean,
  "localizedMerchantName": {
    object (LocalizedString)
  },
  "localizedPinLabel": {
    object (LocalizedString)
  },
  "localizedEventNumberLabel": {
    object (LocalizedString)
  },
  "cardNumberLabel": string,
  "localizedCardNumberLabel": {
    object (LocalizedString)
  },
  "classTemplateInfo": {
    object (ClassTemplateInfo)
  },
  "id": string,
  "version": string,
  "issuerName": string,
  "messages": [
    {
      object (Message)
    }
  ],
  "allowMultipleUsersPerObject": boolean,
  "homepageUri": {
    object (Uri)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "reviewStatus": enum (ReviewStatus),
  "review": {
    object (Review)
  },
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "redemptionIssuers": [
    string
  ],
  "countryCode": string,
  "heroImage": {
    object (Image)
  },
  "wordMark": {
    object (Image)
  },
  "enableSmartTap": boolean,
  "hexBackgroundColor": string,
  "localizedIssuerName": {
    object (LocalizedString)
  },
  "multipleDevicesAndHoldersAllowedStatus": enum (MultipleDevicesAndHoldersAllowedStatus),
  "callbackOptions": {
    object (CallbackOptions)
  },
  "securityAnimation": {
    object (SecurityAnimation)
  },
  "viewUnlockRequirement": enum (ViewUnlockRequirement),
  "wideProgramLogo": {
    object (Image)
  },
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "appLinkData": {
    object (AppLinkData)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}

string

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

string

Name des Händlers, z. B. „Adam's Apparel“. In der App wird nach den ersten 20 Zeichen möglicherweise ein Auslassungspunkt angezeigt, damit der vollständige String auf kleineren Displays angezeigt wird.

object (Image)

Das Logo des Geschenkkartenprogramms oder des Unternehmens. Dieses Logo wird sowohl in der Detailansicht als auch in der Listenansicht der App angezeigt.

string

Das Label, das für die PIN angezeigt werden soll, z. B. „4-stellige PIN“.

string

Das Label, das für die Ereignisnummer angezeigt werden soll, z. B. „Zielereignis Nr.“

boolean

Bestimmt, ob der Händler das Einlösen von Geschenkkarten mithilfe des Barcodes unterstützt. Wenn diese Option aktiviert ist, wird in der App auf dem Bildschirm „Geschenkkartendetails“ ein Barcode für die Geschenkkarte angezeigt. Wenn „false“ festgelegt ist, wird kein Barcode angezeigt.

object (LocalizedString)

Übersetzte Strings für den Händlernamen. Die App zeigt möglicherweise nach den ersten 20 Zeichen eine Ellipse an, um sicherzustellen, dass der vollständige String auf kleineren Bildschirmen angezeigt wird.

object (LocalizedString)

Übersetzte Strings für das Label der Markierung.

object (LocalizedString)

Übersetzte Strings für „eventNumberLabel“.

string

Das Label, das für die Kartennummer angezeigt werden soll, z. B. „Kartennummer“.

object (LocalizedString)

Übersetzte Strings für cardNumberLabel.

object (ClassTemplateInfo)

Vorlageninformationen dazu, wie der Kurs angezeigt werden soll. Wenn diese Einstellung nicht festgelegt ist, verwendet Google standardmäßig einen Satz von Feldern, die angezeigt werden.

string

Erforderlich. Die eindeutige Kennung einer Klasse. Diese ID muss für alle Klassen 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.

string (int64 format)

Verworfen

string

Erforderlich. Der Ausstellername. Die empfohlene maximale Länge ist 20 Zeichen, damit der vollständige String auf kleineren Displays angezeigt wird.

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.

boolean

Verworfen. Verwenden Sie stattdessen multipleDevicesAndHoldersAllowedStatus.

object (Uri)

Der URI der Startseite Ihrer Anwendung. Das Ausfüllen des URI in diesem Feld führt zu demselben Verhalten wie das Ausfüllen eines URI in linksModuleData (wenn ein Objekt gerendert wird, wird ein Link zur Startseite in dem dargestellt, was man normalerweise als linkModuleData-Abschnitt des Objekts bezeichnen würde).

object (LatLongPoint)

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

enum (ReviewStatus)

Erforderlich. Der Status des Kurses. Dieses Feld kann mit den API-Aufrufen „insert“, „patch“ oder „update“ auf „draft“ oder „underReview“ gesetzt werden. Sobald der Überprüfungsstatus von draft geändert wurde, kann er nicht mehr zu draft zurückgesetzt werden.

Wenn der Kurs noch in der Entwicklungsphase ist, sollte dieses Feld auf draft gesetzt bleiben. Mit einer draft-Klasse können keine Objekte erstellt werden.

Legen Sie dieses Feld auf underReview fest, wenn Sie der Meinung sind, dass der Kurs einsatzbereit ist. Dieses Feld wird von der Plattform automatisch auf approved gesetzt und kann sofort zum Erstellen oder Migrieren von Objekten verwendet werden.

Wenn Sie eine bereits vorhandene approved-Klasse aktualisieren, sollten Sie dieses Feld weiterhin auf underReview setzen.

object (Review)

Die Rezensionskommentare, die von der Plattform festgelegt werden, wenn ein Kurs als approved oder rejected markiert wird.

object (InfoModuleData)

Verworfen. Verwenden Sie stattdessen „textModulesData“.

object (ImageModuleData)

Daten des Bildmoduls. Es werden maximal ein Feld aus der Objektebene und eines auf der Klassenobjektebene angezeigt.

object (TextModuleData)

Textmoduldaten. Wenn für den Kurs auch Textmoduldaten definiert sind, werden beide angezeigt. Es werden maximal 10 Felder des Objekts und 10 Felder der Klasse angezeigt.

object (LinksModuleData)

Linkmoduldaten. Wenn für das Objekt auch Linkmoduldaten definiert sind, werden beide angezeigt.

string (int64 format)

Gibt an, welche Einlösungsaussteller die Karte bzw. das Ticket über Smart-Bonus einlösen können. Einlösungsaussteller werden anhand ihrer Aussteller-ID identifiziert. Für Aussteller von Gutscheinen muss mindestens ein Smart Tap-Schlüssel konfiguriert sein.

Die Felder enableSmartTap und smartTapRedemptionLevel auf Objektebene müssen ebenfalls richtig eingerichtet sein, damit eine Karte/ein Ticket Smart-Bonus unterstützt.

string

Ländercode, mit dem das Land der Karte angezeigt wird (wenn sich der Nutzer nicht in diesem Land befindet) sowie der lokalisierte Inhalt, wenn der Inhalt nicht für die Sprache des Nutzers verfügbar ist.

object (Image)

Optionales Bannerbild, das auf der Vorderseite der Karte angezeigt wird. Andernfalls wird nichts angezeigt. Das Bild wird mit 100 % der Breite angezeigt.

object (Image)

Verworfen.

boolean

Gibt an, ob diese Klasse Smart-Bonus unterstützt. Die Felder redemptionIssuers und smartTapRedemptionLevel auf Objektebene müssen ebenfalls richtig eingerichtet sein, damit eine Karte/ein Ticket Smart-Bonus unterstützt.

string

Die Hintergrundfarbe der Karte. Falls nicht festgelegt, wird die Hauptfarbe des Hero-Images verwendet, und wenn kein Hero-Image festgelegt ist, wird die Hauptfarbe des Logos verwendet. Das Format ist #rrggbb, wobei rrggbb ein hexadezimales RGB-Triplet ist, z. B. #ffcc00. Du kannst auch die Kurzversion des RGB-Triplets verwenden (#rgb), z. B. #fc0.

object (LocalizedString)

Übersetzte Strings für den „issuerName“. Die empfohlene maximale Länge ist 20 Zeichen, damit der vollständige String auf kleineren Displays angezeigt wird.

enum (MultipleDevicesAndHoldersAllowedStatus)

Gibt an, ob mehrere Nutzer und Geräte dasselbe Objekt speichern, das auf diese Klasse verweist.

object (CallbackOptions)

Callback-Optionen, mit denen der Aussteller bei jedem Speichern/Löschen eines Objekts für diese Klasse durch den Endnutzer zurückgerufen wird. Alle Objekte dieser Klasse können den Rückruf erhalten.

object (SecurityAnimation)

Optionale Informationen zur Sicherheitsanimation. Wenn diese Option festgelegt ist, wird eine Sicherheitsanimation für die Details der Karte/des Tickets gerendert.

enum (ViewUnlockRequirement)

Optionen für die Entsperrungsanforderungen der Geschenkkarte ansehen

object (Image)

Das breite Logo des Geschenkkartenprogramms oder -unternehmens. Wenn Sie ein Bild angeben, wird es links oben in der Kartenansicht anstelle des Programmlogos verwendet.

enum (NotificationSettingsForUpdates)

Gibt an, ob Feldaktualisierungen für diese Klasse 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 Sie keine Angabe machen, 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.

object (AppLinkData)

Optionaler App- oder Websitelink, der als Schaltfläche auf der Vorderseite der Karte bzw. des Tickets angezeigt wird. Wenn für das entsprechende Objekt „AppLinkData“ angegeben ist, wird dies stattdessen verwendet.

object (ValueAddedModuleData)

Optionale Moduldaten mit Mehrwert. Maximal zehn pro Kurs. Bei einer Karte/einem Ticket werden nur zehn angezeigt, wobei die Karten/Tickets des Objekts priorisiert werden.