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)
  },
  "appLinkData": {
    object (AppLinkData)
  }
}
Felder
kind
(deprecated)

string

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

string

Erforderlich. Der Programmname, z. B. „Adams Bekleidung“. 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.
accountNameLabel

string

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

string

Das Label der 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 der Prämienstufe, z. B. „Prämienstufe“. 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 Bildschirmen angezeigt wird.
localizedProgramName

object (LocalizedString)

Übersetzte Strings für „programName“. 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.
localizedAccountNameLabel

object (LocalizedString)

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

object (LocalizedString)

Übersetzte Strings für das Konto-ID-Label. Die empfohlene maximale Länge ist 15 Zeichen, damit der vollständige String auf kleineren Bildschirmen 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 Bildschirmen 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 Bildschirmen angezeigt wird.
secondaryRewardsTierLabel

string

Das Label der sekundären Prämienstufe, z. B. „Prämienstufe“.
localizedSecondaryRewardsTierLabel

object (LocalizedString)

Übersetzte Strings für dassecondaryRewardsTierLabel.
secondaryRewardsTier

string

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

object (LocalizedString)

Übersetzte Strings für „secondaryRewardsTier“.
discoverableProgram

object (DiscoverableProgram)

Informationen dazu, wie die Klasse in der Google Pay App gefunden und instanziiert werden kann.
classTemplateInfo

object (ClassTemplateInfo)

Vorlageninformationen darüber, wie die Klasse angezeigt werden soll. Wenn die Richtlinie nicht konfiguriert ist, greift Google auf die Standardfelder zurück, die angezeigt werden sollen.
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 Ersteres von Google ausgestellt und Letzteres von Ihnen ausgewählt wird. Die eindeutige Kennung darf nur alphanumerische Zeichen sowie „.“, „_“ oder „-“ enthalten.
version
(deprecated)

string (int64 format)

Verworfen
issuerName

string

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

object (Message)

Ein Array von Mitteilungen, 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. 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).
locations[]

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 mithilfe der API-Aufrufe zum Einfügen, Patchen oder Aktualisieren auf draft oder underReview festgelegt werden. Nachdem der Überprüfungsstatus von draft geändert wurde, kann er nicht mehr in draft geändert werden.

Sie sollten dieses Feld auf draft belassen, wenn sich die Klasse in der Entwicklung befindet. Eine draft-Klasse kann nicht zum Erstellen eines Objekts verwendet werden.

Sie sollten dieses Feld auf underReview setzen, 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 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)

Bildmoduldaten. Es werden maximal ein Feld aus der Objektebene und eines auf der Klassenobjektebene angezeigt.
textModulesData[]

object (TextModuleData)

Textmoduldaten. Wenn auch Textmoduldaten für die Klasse definiert sind, werden beide angezeigt. Die maximale Anzahl der angezeigten Felder beträgt 10 vom -Objekt und 10 aus der Klasse.
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. Einlösungsaussteller müssen mindestens einen Smart-Bonus-Schlüssel konfiguriert haben.

Das Feld „enableSmartTap“ und eines der Felder „smartTapRedemptionValue“ auf Objektebene, „barcode.value, oraccountId“, müssen ebenfalls korrekt eingerichtet sein, damit Smart-Bonus von einer Karte bzw. einem Ticket unterstützt wird.
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 Ist keine vorhanden, wird nichts angezeigt. Das Bild wird mit einer Breite von 100% angezeigt.
wordMark
(deprecated)

object (Image)

Verworfen.
enableSmartTap

boolean

Gibt an, ob diese Klasse Smart-Bonus 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. 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 wie #ffcc00 ist. Du kannst auch die Kurzversion des RGB-Triplets verwenden (#rgb), z. B. #fc0.
localizedIssuerName

object (LocalizedString)

Übersetzte Strings für den Ausstellernamen. 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, die verwendet werden sollen, um den Aussteller beim Speichern/Löschen eines Objekts für diese Klasse durch den Endnutzer zurückzurufen. 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 „Entsperrungsanforderungen“ für die Kundenkarte ansehen.

DiscoverableProgram

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

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

object (DiscoverableProgramMerchantSignupInfo)

Informationen zur Möglichkeit, sich über eine Händlerwebsite für dieses Programm anzumelden und einen Wert 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 auffindbaren 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, zu der der Nutzer für die Registrierungswebsite des Händlers weitergeleitet wird.
signupSharedDatas[]

enum (SharedDataType)

Nutzerdaten, die in einer POST-Anfrage an die URL der Registrierungswebsite gesendet werden. Diese Informationen sind codiert und werden dann freigegeben, damit die Website des Händlers die Felder für die Anmeldung des Nutzers für das Programm mit der Sichtbarkeitsmessung vorab ausfüllen kann.

SharedDataType

Enums
SHARED_DATA_TYPE_UNSPECIFIED
FIRST_NAME
LAST_NAME
STREET_ADDRESS einzeiliges Adressfeld
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, an die der Nutzer für die 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ügt der Treueklasse, auf die von der angegebenen Klassen-ID verwiesen wird, eine Nachricht hinzu.

get

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

insert

 Fügt eine Treueklasse mit der angegebenen ID und den angegebenen Eigenschaften ein.

list

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

patch

 Aktualisiert die Treueklasse, auf die von der angegebenen Klassen-ID verwiesen wird.

update

 Aktualisiert die Treueklasse, auf die von der angegebenen Klassen-ID verwiesen wird.