REST Resource: loyaltyclass

Ressource: LoyaltyClass

JSON-Darstellung 
{
  "kind": string,
  "programName": string,
  "programLogo": {
    object (Image)
  },
  "accountNameLabel": string,
  "accountIdLabel": string,
  "rewardsTierLabel": string,
  "rewardsTier": string,
  "localizedProgramName": {
    object (LocalizedString)
  },
  "localizedAccountNameLabel": {
    object (LocalizedString)
  },
  "localizedAccountIdLabel": {
    object (LocalizedString)
  },
  "localizedRewardsTierLabel": {
    object (LocalizedString)
  },
  "localizedRewardsTier": {
    object (LocalizedString)
  },
  "secondaryRewardsTierLabel": string,
  "localizedSecondaryRewardsTierLabel": {
    object (LocalizedString)
  },
  "secondaryRewardsTier": string,
  "localizedSecondaryRewardsTier": {
    object (LocalizedString)
  },
  "discoverableProgram": {
    object (DiscoverableProgram)
  },
  "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

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

string

Erforderlich. Der Name des Programms, 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.
accountNameLabel

string

Das Label des Kontonamens, z. B. „Mitgliedsname“. Die empfohlene maximale Länge ist 15 Zeichen, damit der vollständige String auf kleineren Displays angezeigt wird.
accountIdLabel

string

Das Label für die Konto-ID, z. B. „Mitglieds-ID“ Die empfohlene maximale Länge ist 15 Zeichen, damit der vollständige String auf kleineren Bildschirmen angezeigt wird.
rewardsTierLabel

string

Das Label für die Prämienstufe, z. B. „Rewards Tier“ Die empfohlene maximale Länge ist 9 Zeichen, damit der vollständige String auf kleineren Bildschirmen angezeigt wird.
rewardsTier

string

Die Prämienstufe, z. B. „Gold“ oder „Platin“. Die empfohlene maximale Länge ist 7 Zeichen, damit der vollständige String auf kleineren Displays angezeigt wird.
localizedProgramName

object (LocalizedString)

Übersetzte Strings für „programName“. In der App wird nach den ersten 20 Zeichen möglicherweise ein Auslassungspunkt angezeigt, damit der vollständige String auf kleineren Displays angezeigt wird.
localizedAccountNameLabel

object (LocalizedString)

Übersetzte Strings für das Label „accountNameLabel“. Die empfohlene maximale Länge ist 15 Zeichen, damit der vollständige String auf kleineren Displays angezeigt wird.
localizedAccountIdLabel

object (LocalizedString)

Übersetzte Strings für das Label „accountIdLabel“. Die empfohlene maximale Länge ist 15 Zeichen, damit der vollständige String auf kleineren Displays angezeigt wird.
localizedRewardsTierLabel

object (LocalizedString)

Übersetzte Strings für das rewardsTierLabel. Die empfohlene maximale Länge ist 9 Zeichen, damit der vollständige String auf kleineren Displays angezeigt wird.
localizedRewardsTier

object (LocalizedString)

Übersetzte Strings für die rewardsTier. Die empfohlene maximale Länge ist 7 Zeichen, damit der vollständige String auf kleineren Displays angezeigt wird.
secondaryRewardsTierLabel

string

Das Label für die sekundäre Prämienstufe, z. B. „Prämienstufe“.
localizedSecondaryRewardsTierLabel

object (LocalizedString)

Übersetzte Strings für das sekundäre RewardsTierLabel.
secondaryRewardsTier

string

Die sekundäre Prämienstufe, z. B. „Gold“ oder „Platin“.
localizedSecondaryRewardsTier

object (LocalizedString)

Übersetzte Strings für die sekundäre RewardsTier.
discoverableProgram

object (DiscoverableProgram)

Informationen dazu, wie die Klasse in der Google Pay App gefunden und instanziiert werden kann.
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, die angezeigt werden.
id

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 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)

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

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)

Hinweis: Dieses Feld wird derzeit nicht zum Auslösen von Geo-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.

Sie sollten dieses Feld auf draft belassen, wenn sich die Klasse in der Entwicklung befindet. 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. Die Plattform setzt dieses Feld automatisch auf approved und es 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)

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 vom Objekt und 10 aus der Klasse 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.

Außerdem müssen die Felder enableSmartTap und eines der Felder auf Objektebene smartTapRedemptionValue, barcode.value, oraccountId` richtig eingerichtet sein, damit eine Karte bzw. ein Ticket Smart-Bonus unterstützt.
countryCode

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.
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)

Verworfen.
enableSmartTap

boolean

Gibt an, ob diese Klasse Smart Tap unterstützt. Das Feld „redemptionIssuers“ und eines der Felder „smartTapRedemptionLevel“ auf Objektebene, „barcode.value, or accountId“, müssen ebenfalls korrekt eingerichtet sein, damit Smart-Bonus von einer Karte bzw. einem Ticket unterstützt wird.
hexBackgroundColor

string

Die Hintergrundfarbe der Karte bzw. des Tickets. 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 (#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 Bildschirmen 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 können den Rückruf erhalten.
securityAnimation

object (SecurityAnimation)

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

enum (ViewUnlockRequirement)

Optionen für „Entsperrungsanforderungen“ für die Kundenkarte ansehen.
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 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.
valueAddedModuleData[]

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.

DiscoverableProgram

Informationen darüber, wie eine Klasse in der Android Pay App gefunden und instanziiert werden kann. Dazu suchen Sie nach einem Kunden- oder Geschenkkartenprogramm und scannen oder manuell.

JSON-Darstellung 
{
  "merchantSignupInfo": {
    object (DiscoverableProgramMerchantSignupInfo)
  },
  "merchantSigninInfo": {
    object (DiscoverableProgramMerchantSigninInfo)
  },
  "state": enum (State)
}
Felder
merchantSignupInfo

object (DiscoverableProgramMerchantSignupInfo)

Informationen zur Möglichkeit, sich über die Website eines Händlers für dieses Programm zu registrieren und ein Präsent hinzuzufügen. Wird verwendet, wenn MERCHANT_HOSTED_SIGNUP aktiviert ist.
merchantSigninInfo

object (DiscoverableProgramMerchantSigninInfo)

Informationen zur Möglichkeit, sich über eine Händlerwebsite anzumelden und einen Wert für dieses Programm hinzuzufügen. Wird verwendet, wenn MERCHANT_HOSTED_SIGNIN aktiviert ist.
state

enum (State)

Sichtbarkeitsstatus des sichtbaren Programms.

DiscoverableProgramMerchantSignupInfo

Informationen zum vom Händler gehosteten Registrierungsvorgang für ein Programm.

JSON-Darstellung 
{
  "signupWebsite": {
    object (Uri)
  },
  "signupSharedDatas": [
    enum (SharedDataType)
  ]
}
Felder
signupWebsite

object (Uri)

Die URL, unter der sich der Nutzer auf der Registrierungswebsite des Händlers anmelden kann.
signupSharedDatas[]

enum (SharedDataType)

Nutzerdaten, die in einer POST-Anfrage an die URL der Registrierungswebsite gesendet werden. Diese Informationen werden codiert und dann weitergegeben, damit auf der Website des Händlers Felder vorab ausgefüllt werden können, die zur Registrierung des Nutzers für das Programm zur Sichtbarkeit verwendet werden.

SharedDataType

Enums
SHARED_DATA_TYPE_UNSPECIFIED
FIRST_NAME
LAST_NAME
STREET_ADDRESS Feld für eine einzelne Adresse
ADDRESS_LINE_1 Mehrzeilige Adressfelder
ADDRESS_LINE_2
ADDRESS_LINE_3
CITY
STATE
ZIPCODE
COUNTRY
EMAIL
PHONE

DiscoverableProgramMerchantSigninInfo

Informationen zum vom Händler gehosteten Anmeldevorgang für ein Programm.

JSON-Darstellung 
{
  "signinWebsite": {
    object (Uri)
  }
}
Felder
signinWebsite

object (Uri)

Die URL, unter der der Nutzer zur Anmeldeseite des Händlers weitergeleitet wird.

Status

Enums
STATE_UNSPECIFIED
TRUSTED_TESTERS Nur für Tester sichtbar, die Zugriff auf das Ausstellerkonto haben.
trustedTesters

Alter Alias für TRUSTED_TESTERS. Verworfen.
LIVE Für alle sichtbar.
live

Alter Alias für LIVE. Verworfen.
DISABLED Nicht sichtbar.
disabled

Alter Alias für DISABLED. Verworfen.

Methoden

addmessage

 Fügen Sie der Treuepunkteklasse, auf die die angegebene Klassen-ID verweist, eine Nachricht hinzu.

get

 Gibt die Treuepunkteklasse mit der angegebenen Klassen-ID zurück.

insert

 Fügt eine Treuepunkteklasse mit der angegebenen ID und den angegebenen Properties ein.

list

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

patch

 Aktualisiert die Treuepunkteklasse, auf die durch die angegebene Klassen-ID verwiesen wird.

update

 Aktualisiert die Treuepunkteklasse, auf die durch die angegebene Klassen-ID verwiesen wird.