Diese Seite wurde von der Cloud Translation API übersetzt.

REST Resource: giftcardclass

Ressource: GiftCardClass
- JSON-Darstellung
Methoden

Ressource: GiftCardClass

JSON-Darstellung

JSON-Darstellung
{ "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`) } ] }

{
  "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)
    }
  ]
}

Felder
`kind (deprecated)`	`string` Dieses Element ist veraltet. Gibt an, um welche Art von Ressource es sich handelt. Wert: der feste String `"walletobjects#giftCardClass"`.
`merchantName`	`string` Händlername, z. B. „Adams Bekleidung“. In der App wird nach den ersten 20 Zeichen möglicherweise ein Auslassungspunkt angezeigt, damit der vollständige String auf kleineren Displays angezeigt wird.
`programLogo`	`object (Image)` Das Logo des Geschenkkartenprogramms oder des Unternehmens. Dieses Logo wird sowohl in der Detailansicht als auch in der Listenansicht der App angezeigt.
`pinLabel`	`string` Das Label, das für die PIN angezeigt werden soll, z. B. „4-stellige PIN“.
`eventNumberLabel`	`string` Das Label, das für die Ereignisnummer angezeigt werden soll, z. B. „Zielereignis Nr.“
`allowBarcodeRedemption`	`boolean` Gibt an, ob der Händler die Einlösung von Geschenkkarten per Barcode 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.
`localizedMerchantName`	`object (LocalizedString)` Übersetzte Strings für den Händlernamen. In der App wird nach den ersten 20 Zeichen möglicherweise ein Auslassungspunkt angezeigt, damit der vollständige String auf kleineren Displays angezeigt wird.
`localizedPinLabel`	`object (LocalizedString)` Übersetzte Strings für das Label der Markierung.
`localizedEventNumberLabel`	`object (LocalizedString)` Übersetzte Strings für das Ereignisnummernlabel.
`cardNumberLabel`	`string` Das Label, das für die Kartennummer angezeigt werden soll, z. B. „Kartennummer“.
`localizedCardNumberLabel`	`object (LocalizedString)` Übersetzte Strings für das Kartennummernlabel.
`classTemplateInfo`	`object (ClassTemplateInfo)` Vorlageninformationen dazu, wie der Kurs angezeigt werden soll. Wenn diese Einstellung nicht festgelegt ist, verwendet Google standardmäßig einen Satz von Feldern.
`id`	`string` Erforderlich. Die eindeutige Kennung einer Klasse. Diese ID muss für alle Klassen eines Ausstellers eindeutig sein. Dieser Wert muss das Format `issuer ID` haben.`identifier`, wobei die erstere von Google ausgestellt und die zweite von Ihnen ausgewählt wird. Die eindeutige Kennung darf nur alphanumerische Zeichen, „.“ (Punkt), „_“ (Unterstrich) oder „-“ (Bindestriche) enthalten.
`version (deprecated)`	`string (int64 format)` Dieses Element ist veraltet. Verworfen
`issuerName`	`string` Erforderlich. Der Name des Ausstellers. Die empfohlene maximale Länge ist 20 Zeichen, damit der vollständige String auf kleineren Displays angezeigt wird.
`messages[]`	`object (Message)` Ein Array von Meldungen, die in der App angezeigt werden. Alle Nutzer dieses Objekts erhalten die zugehörigen Nachrichten. Die maximale Anzahl dieser Felder ist 10.
`allowMultipleUsersPerObject (deprecated)`	`boolean` Dieses Element ist veraltet. Verworfen. Verwenden Sie stattdessen `multipleDevicesAndHoldersAllowedStatus`.
`homepageUri`	`object (Uri)` Der URI der Startseite Ihrer Anwendung. Wenn Sie den URI in dieses Feld einfügen, wird genau dasselbe Verhalten wie beim Einfügen eines URI in „linksModuleData“ ausgelöst. Wenn ein Objekt gerendert wird, wird im Bereich „linksModuleData“ des Objekts ein Link zur Startseite angezeigt.
`locations[] (deprecated)`	`object (LatLongPoint)` Dieses Element ist veraltet. Hinweis: Dieses Feld wird derzeit nicht zum Auslösen von Benachrichtigungen unterstützt.
`reviewStatus`	`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. Eine `draft`-Klasse kann nicht zum Erstellen eines Objekts verwendet 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.
`review`	`object (Review)` Die Rezensionskommentare, die von der Plattform festgelegt werden, wenn ein Kurs als `approved` oder `rejected` markiert wird.
`infoModuleData (deprecated)`	`object (InfoModuleData)` Dieses Element ist veraltet. 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 für den Kurs auch Textmoduldaten definiert sind, werden beide angezeigt. Es werden maximal 10 Felder des Objekts und 10 Felder der Klasse angezeigt.
`linksModuleData`	`object (LinksModuleData)` Linkmoduldaten. Wenn für das Objekt auch Linkmoduldaten definiert sind, werden beide angezeigt.
`redemptionIssuers[]`	`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.
`countryCode`	`string` Der Ländercode, der zum Anzeigen des Landes der Karte verwendet wird, wenn sich der Nutzer nicht in diesem Land befindet, sowie zum Anzeigen lokalisierter Inhalte, wenn Inhalte nicht in der Sprache des Nutzers verfügbar sind.
`heroImage`	`object (Image)` Optionales Bannerbild, das auf der Vorderseite der Karte angezeigt wird. Andernfalls wird nichts angezeigt. Das Bild wird mit 100 % der Breite angezeigt.
`wordMark (deprecated)`	`object (Image)` Dieses Element ist veraltet. Verworfen.
`enableSmartTap`	`boolean` Gibt an, ob diese Klasse Smart Tap unterstützt. Die Felder `redemptionIssuers` und `smartTapRedemptionLevel` auf Objektebene müssen ebenfalls richtig eingerichtet sein, damit eine Karte/ein Ticket Smart-Bonus unterstützt.
`hexBackgroundColor`	`string` Die Hintergrundfarbe der Karte. Wenn 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 (#`rgb`) verwenden, z. B. `#fc0`.
`localizedIssuerName`	`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.
`multipleDevicesAndHoldersAllowedStatus`	`enum (MultipleDevicesAndHoldersAllowedStatus)` Gibt an, ob mehrere Nutzer und Geräte dasselbe Objekt speichern, das auf diese Klasse verweist.
`callbackOptions`	`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 sind für den Callback berechtigt.
`securityAnimation`	`object (SecurityAnimation)` Optionale Informationen zur Sicherheitsanimation. Wenn diese Richtlinie konfiguriert ist, wird bei den Details der Karte / des Tickets eine Sicherheitsanimation gerendert.
`viewUnlockRequirement`	`enum (ViewUnlockRequirement)` Optionen für die Entsperrungsanforderungen der Geschenkkarte ansehen
`wideProgramLogo`	`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.
`notifyPreference`	`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 keine Angabe erfolgt, 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.
`appLinkData`	`object (AppLinkData)` Optionaler Link zu einer App oder Website, der auf der Vorderseite der Karte/des Tickets als Schaltfläche angezeigt wird. Wenn für das entsprechende Objekt, das stattdessen verwendet wird, AppLinkData angegeben ist.
`valueAddedModuleData[]`	`object (ValueAddedModuleData)` Optionale Daten zum Mehrwertmodul. Maximal zehn pro Kurs. Bei einer Karte/einem Ticket werden nur zehn angezeigt, wobei die Karten/Tickets des Objekts priorisiert werden.

Methoden
`addmessage`	Fügt der Geschenkkartenklasse, auf die durch die angegebene Klassen-ID verwiesen wird, eine Nachricht hinzu.
`get`	Gibt die Geschenkkartenklasse mit der angegebenen Klassen-ID zurück.
`insert`	Fügt eine Geschenkkartenklasse mit der angegebenen ID und den angegebenen Eigenschaften ein.
`list`	Gibt eine Liste aller Geschenkkartenklassen für eine bestimmte Aussteller-ID zurück.
`patch`	Aktualisiert die Geschenkkartenklasse, auf die durch die angegebene Klassen-ID verwiesen wird.
`update`	Aktualisiert die Geschenkkartenklasse, auf die durch die angegebene Klassen-ID verwiesen wird.

REST Resource: giftcardclass

Ressource: GiftCardClass

Methoden

`addmessage`

`get`

`insert`

`list`

`patch`

`update`