REST Resource: genericobject

Ressource: GenericObject

Nächste ID des generischen Objekts: 121

JSON-Darstellung 
{
  "genericType": enum (GenericType),
  "cardTitle": {
    object (LocalizedString)
  },
  "subheader": {
    object (LocalizedString)
  },
  "header": {
    object (LocalizedString)
  },
  "logo": {
    object (Image)
  },
  "hexBackgroundColor": string,
  "notifications": {
    object (Notifications)
  },
  "id": string,
  "classId": string,
  "barcode": {
    object (Barcode)
  },
  "heroImage": {
    object (Image)
  },
  "validTimeInterval": {
    object (TimeInterval)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "appLinkData": {
    object (AppLinkData)
  },
  "groupingInfo": {
    object (GroupingInfo)
  },
  "smartTapRedemptionValue": string,
  "rotatingBarcode": {
    object (RotatingBarcode)
  },
  "state": enum (State),
  "hasUsers": boolean,
  "passConstraints": {
    object (PassConstraints)
  },
  "wideLogo": {
    object (Image)
  }
}
Felder
genericType

enum (GenericType)

Gib an, zu welchem GenericType die Karte gehört.
cardTitle

object (LocalizedString)

Erforderlich. Der Header der Karte bzw. des Tickets. Das ist normalerweise der Name des Unternehmens, z. B. „XXX Fitnessstudio“ oder „AAA – Versicherung“. Dieses Feld ist erforderlich und wird in der Kopfzeile ganz oben auf der Karte bzw. dem Ticket angezeigt.
subheader

object (LocalizedString)

Das Titellabel der Karte bzw. des Tickets, z. B. der Ort, an dem diese Karte bzw. dieses Ticket verwendet werden kann. Wird in der Detailansicht der Karte bzw. des Tickets direkt über dem Titel in der Titelzeile angezeigt.
header

object (LocalizedString)

Erforderlich. Der Titel des Tickets, z. B. „50% Rabatt-Gutschein“, „Bibliotheksausweis“ oder „Gutschein“. Dieses Feld ist erforderlich und wird in der Titelzeile der Detailansicht der Karte bzw. des Tickets angezeigt.
hexBackgroundColor

string

Die Hintergrundfarbe der Karte. Ist die Richtlinie nicht konfiguriert, wird die Hauptfarbe des Hero-Images verwendet. Falls kein Hero-Image festgelegt ist, wird die Hauptfarbe des Logos verwendet. Wird kein Logo festgelegt, wird eine Farbe von Google ausgewählt.
notifications

object (Notifications)

Die Benachrichtigungseinstellungen, die für dieses Objekt aktiviert sind.
id

string

Erforderlich. Die eindeutige Kennung für ein Objekt. Diese ID muss für alle Objekte eines Ausstellers eindeutig sein. Dieser Wert muss das Format issuerID.identifier haben, bei dem issuerID von Google ausgegeben und identifier von dir ausgewählt wird. Die eindeutige Kennung darf nur alphanumerische Zeichen, ., _ oder - enthalten.
classId

string

Erforderlich. Die mit diesem Objekt verknüpfte Klasse. Die Klasse muss denselben Typ wie dieses Objekt haben, bereits vorhanden sein und genehmigt werden.

Kurs-IDs müssen das Format issuerID.identifier haben, wobei issuerID von Google ausgestellt und identifier von dir ausgewählt wird.
barcode

object (Barcode)

Typ und Wert des Barcodes. Wenn das Ticket keinen Barcode hat, können wir dem Aussteller erlauben, „Barcode.alternate_text“ festzulegen und nur diesen anzuzeigen.
heroImage

object (Image)

Bannerbild, das auf der Vorderseite der Karte angezeigt wird, falls vorhanden. Das Bild wird mit einer Breite von 100% angezeigt.
validTimeInterval

object (TimeInterval)

Der Zeitraum, in dem dieses Objekt als gültig oder verwendbar gilt. Nach Ablauf des Zeitraums gilt das Objekt als abgelaufen, was sich auf das Rendering auf den Geräten der Nutzer auswirkt.
imageModulesData[]

object (ImageModuleData)

Bildmoduldaten. Wenn beide Werte festgelegt sind, wird nur eines der Bilder aus der Klasse und eines aus der Objektebene gerendert.
textModulesData[]

object (TextModuleData)

Textmoduldaten. Wenn für die Klasse auch textModulesData definiert ist, werden beide angezeigt. Es werden maximal 10 Felder aus der Klasse und 10 aus dem Objekt angezeigt.
groupingInfo

object (GroupingInfo)

Informationen, die steuern, wie Karten/Tickets gruppiert werden.
smartTapRedemptionValue

string

Der Wert, der für dieses Objekt über NFC an ein Smart-Bonus-zertifiziertes Terminal übertragen wird. Die Felder auf Klassenebene enableSmartTap und redemptionIssuers müssen ebenfalls korrekt eingerichtet sein, damit die Karte bzw. das Ticket Smart-Bonus unterstützt. Es werden nur ASCII-Zeichen unterstützt.
rotatingBarcode

object (RotatingBarcode)

Die Einstellungen/Details des rotierenden Barcodes
state

enum (State)

Der Status des Objekts. Mit diesem Feld wird festgelegt, wie ein Objekt in der App angezeigt wird. Ein inactive-Objekt wird beispielsweise in den Abschnitt „Abgelaufene Karten/Tickets“ verschoben. Andernfalls wird das Objekt als ACTIVE betrachtet.
hasUsers

boolean

Gibt an, ob das Objekt Nutzer hat. Dieses Feld wird von der Plattform festgelegt.
passConstraints

object (PassConstraints)

Übergeben Sie Einschränkungen für das Objekt. Umfasst das Einschränken von NFC- und Screenshot-Verhalten.

GenericType

Der Typ der generischen Karte.

Enums
GENERIC_TYPE_UNSPECIFIED Der generische Typ wurde nicht angegeben.
GENERIC_SEASON_PASS Staffelpass
GENERIC_UTILITY_BILLS Rechnungen von Versorgungsunternehmen
GENERIC_PARKING_PASS Parkschein
GENERIC_VOUCHER Gutschein
GENERIC_GYM_MEMBERSHIP Mitgliedskarten für Fitnessstudios
GENERIC_LIBRARY_MEMBERSHIP Mitgliedskarten für die Bibliothek
GENERIC_RESERVATIONS Reservierungen
GENERIC_AUTO_INSURANCE Kfz-Versicherungskarten
GENERIC_HOME_INSURANCE Hausversicherungskarten
GENERIC_ENTRY_TICKET Eintrittskarten
GENERIC_RECEIPT Belege
GENERIC_OTHER Anderer Typ

Benachrichtigungen

Gibt an, ob für das Objekt die Benachrichtigung aktiviert sein muss. Wir unterstützen nur eine der Optionen „Expiry Notification“/„Demnächst“. expiryNotification hat Vorrang vor upcomingNotification. Das heißt, wenn expiryNotification festgelegt ist, wird das Feld upcomingNotification ignoriert.

JSON-Darstellung 
{
  "expiryNotification": {
    object (ExpiryNotification)
  },
  "upcomingNotification": {
    object (UpcomingNotification)
  }
}
Felder
expiryNotification

object (ExpiryNotification)

Eine Benachrichtigung wird zu einem bestimmten Zeitpunkt ausgelöst, bevor die Karte abläuft.
upcomingNotification

object (UpcomingNotification)

Zu einem bestimmten Zeitpunkt wird eine Benachrichtigung ausgelöst, bevor die Karte nutzbar wird.

ExpiryNotification

Gibt an, dass der Aussteller möchte, dass Google Wallet zwei Tage vor dem Ablaufdatum der Karte eine Benachrichtigung über das Ablaufdatum sendet.

JSON-Darstellung 
{
  "enableNotification": boolean
}
Felder
enableNotification

boolean

Gibt an, ob für das Objekt die Ablaufbenachrichtigung aktiviert sein muss.

UpcomingNotification

Gibt an, dass der Aussteller möchte, dass Google Wallet 1 Tag vor dem Zeitpunkt der Gültigkeit/Nutzung der Karte eine Benachrichtigung über die anstehende Kartengültigkeit sendet.

JSON-Darstellung 
{
  "enableNotification": boolean
}
Felder
enableNotification

boolean

Gibt an, ob für das Objekt anstehende Benachrichtigungen aktiviert werden müssen.

Methoden

addmessage

 Fügt dem generischen Objekt, auf das die angegebene Objekt-ID verweist, eine Nachricht hinzu.

get

 Gibt das generische Objekt mit der angegebenen Objekt-ID zurück

insert

 Fügt ein generisches Objekt mit der angegebenen ID und den Eigenschaften ein.

list

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

patch

 Aktualisiert das generische Objekt, auf das die angegebene Objekt-ID verweist.

update

 Aktualisiert das generische Objekt, auf das die angegebene Objekt-ID verweist.