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)
  }
}
Felder
kind
(deprecated)

string

Gibt an, welche Art von Ressource dies ist. Wert: der feste String "walletobjects#loyaltyClass".

programName

string

Erforderlich. Der Programmname, z. B. "Adams Bekleidung". In der App werden eventuell nach den ersten 20 Zeichen Auslassungszeichen angezeigt, damit auf kleineren Bildschirmen der vollständige String angezeigt wird.

accountNameLabel

string

Das Label für den Kontonamen, z. B. „Mitgliedsname“. Die empfohlene maximale Länge beträgt 15 Zeichen, damit der vollständige String auf kleineren Bildschirmen angezeigt wird.

accountIdLabel

string

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

rewardsTierLabel

string

Das Label für die Prämienstufe, z. B. „Prämienstufe“. Die empfohlene maximale Länge beträgt 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 beträgt 7 Zeichen, damit der vollständige String auf kleineren Bildschirmen angezeigt wird.

localizedProgramName

object (LocalizedString)

Übersetzte Strings für programName. In der App werden eventuell nach den ersten 20 Zeichen Auslassungszeichen angezeigt, damit auf kleineren Bildschirmen der vollständige String angezeigt wird.

localizedAccountNameLabel

object (LocalizedString)

Übersetzte Strings für „accountNameLabel“ Die empfohlene maximale Länge beträgt 15 Zeichen, damit der vollständige String auf kleineren Bildschirmen angezeigt wird.

localizedAccountIdLabel

object (LocalizedString)

Übersetzte Strings für accountIdLabel Die empfohlene maximale Länge beträgt 15 Zeichen, damit der vollständige String auf kleineren Bildschirmen angezeigt wird.

localizedRewardsTierLabel

object (LocalizedString)

Übersetzte Strings für RewardsTierLabel. Die empfohlene maximale Länge beträgt 9 Zeichen, damit der vollständige String auf kleineren Bildschirmen angezeigt wird.

localizedRewardsTier

object (LocalizedString)

Übersetzte Strings für die Prämienstufe. Die empfohlene maximale Länge beträgt 7 Zeichen, damit der vollständige String auf kleineren Bildschirmen 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 RewardsStufe.

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 für eine 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 ausgegeben und letzter von Ihnen ausgewählt wird. Ihre eindeutige Kennung darf nur alphanumerische Zeichen, „.“, „_“ oder „-“ enthalten.

version
(deprecated)

string (int64 format)

Eingestellte Funktionen

issuerName

string

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

messages[]

object (Message)

Ein Array von Nachrichten, die in der App angezeigt werden. Alle Nutzer dieses Objekts erhalten die zugehörigen Nachrichten. Es sind maximal 10 Felder zulässig.

allowMultipleUsersPerObject
(deprecated)

boolean

Veraltet. Verwenden Sie stattdessen multipleDevicesAndHoldersAllowedStatus.

homepageUri

object (Uri)

Der URI der Startseite Ihrer Anwendung. Das Ausfüllen des URI in diesem Feld führt genau zu dem gleichen Verhalten wie das Ausfüllen eines URI in „linksModuleData“ (beim Rendern eines Objekts wird ein Link zur Startseite in dem Format angezeigt, das normalerweise als LinksModuleData-Abschnitt des Objekts angesehen wird).

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 zu „draft“ geändert werden.

Lassen Sie dieses Feld auf draft, wenn sich die Klasse in der Entwicklung befindet. Eine draft-Klasse kann nicht zum Erstellen von Objekten 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 kann sofort zum Erstellen oder Migrieren von Objekten verwendet werden.

Wenn Sie einen bereits approved-Kurs aktualisieren, sollten Sie dieses Feld auf underReview setzen.

review

object (Review)

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

infoModuleData
(deprecated)

object (InfoModuleData)

Veraltet. Verwenden Sie stattdessen „textModulesData“.

imageModulesData[]

object (ImageModuleData)

Bildmoduldaten. Es werden maximal 1 Feld auf Objektebene und 1 Feld auf Klassenobjektebene angezeigt.

textModulesData[]

object (TextModuleData)

Textmoduldaten. Wenn für die Klasse auch Textmoduldaten definiert sind, werden beide angezeigt. Es werden maximal 10 Felder vom Objekt und 10 Felder 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. Einlösungsaussteller müssen mindestens einen Smart-Bonus-Schlüssel konfiguriert haben.

Die enableSmartTap und eines der Felder smartTapRedemptionValue auf Objektebene und „barcode.value, oraccountId“ müssen ebenfalls korrekt eingerichtet sein, damit eine Karte bzw. ein Ticket Smart-Bonus unterstützt.

countryCode

string

Der Ländercode wird verwendet, um das Land der Karte anzuzeigen (wenn der Nutzer sich nicht in diesem Land befindet) und um lokalisierte Inhalte anzuzeigen, wenn Inhalte nicht in der Sprache des Nutzers verfügbar sind.

heroImage

object (Image)

Optionales Bannerbild auf der Vorderseite der Karte. Ist keine vorhanden, wird nichts angezeigt. Das Bild wird mit 100% Breite angezeigt.

wordMark
(deprecated)

object (Image)

Veraltet.

enableSmartTap

boolean

Gibt an, ob diese Klasse Smart-Bonus unterstützt. Die redemptionIssuers und eines der Felder smartTapRedemptionLevel auf Objektebene und „barcode.value, or accountId“ müssen ebenfalls korrekt eingerichtet sein, damit eine Karte bzw. 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 hexadezimaler RGB-Triplet wie #ffcc00 ist. Du kannst auch die Kurzversion des RGB-Triplets (#rgb) verwenden, z. B. #fc0.

localizedIssuerName

object (LocalizedString)

Übersetzte Strings für den Ausstellername. Die empfohlene maximale Länge beträgt 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 und auf diese Klasse verweisen.

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 kommen für den Callback infrage.

securityAnimation

object (SecurityAnimation)

Optionale Informationen zur Sicherheitsanimation. Wenn dies festgelegt ist, wird eine Sicherheitsanimation in den Details der Karte / des Tickets gerendert.

viewUnlockRequirement

enum (ViewUnlockRequirement)

Optionen für die Entsperranforderung für die Kundenkarte ansehen.

DiscoverableProgram

Informationen darüber, wie eine Klasse in der Android Pay App gefunden und instanziiert werden kann. Dazu wird nach einem Kunden- oder Geschenkkartenprogramm gesucht und es gescannt oder manuell eingegeben.

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

object (DiscoverableProgramMerchantSignupInfo)

Informationen zur Registrierung und zum Hinzufügen eines Werts für dieses Programm über eine Händlerwebsite. Wird verwendet, wenn MERCHANT_HOSTED_SIGNUP aktiviert ist.

merchantSigninInfo

object (DiscoverableProgramMerchantSigninInfo)

Informationen zur Möglichkeit, sich über die Website eines Händlers 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, an die der Nutzer zur Registrierungswebsite des Händlers weitergeleitet werden soll.

signupSharedDatas[]

enum (SharedDataType)

Nutzerdaten, die in einer POST-Anfrage an die URL der Registrierungswebsite gesendet werden. Diese Informationen werden codiert und dann geteilt, damit die Website des Händlers die Felder, die zur Registrierung des Nutzers für das Programm „Discover“ verwendet werden, 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 Anmeldewebsite des Händlers weitergeleitet werden soll.

Status

Enums
STATE_UNSPECIFIED
TRUSTED_TESTERS Nur für Tester mit Zugriff auf das Ausstellerkonto sichtbar.
trustedTesters

Legacy-Alias für TRUSTED_TESTERS. Veraltet.

LIVE Für alle sichtbar
live

Legacy-Alias für LIVE. Veraltet.

DISABLED Nicht sichtbar.
disabled

Legacy-Alias für DISABLED. Veraltet.

Methoden

addmessage

Fügt der Treueklasse, auf die durch die angegebene 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 Eigenschaften ein.

list

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

patch

Aktualisiert die Treueklasse, auf die die angegebene Klassen-ID verweist.

update

Aktualisiert die Treueklasse, auf die die angegebene Klassen-ID verweist.