REST Resource: genericobject

Ressource: GenericObject

Generisches Objekt

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)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  }
}
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 in der Regel 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 die Karte bzw. das Ticket verwendet werden kann. Wird in der Detailansicht der Karte / des Tickets direkt über dem Titel in der Titelzeile angezeigt.
header

object (LocalizedString)

Erforderlich. Der Titel der Karte bzw. des Tickets, z. B. „50% Rabatt auf Gutschein“ oder „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. Wenn nicht festgelegt, wird die Hauptfarbe des Hero-Images verwendet. Wenn kein Hero-Image festgelegt ist, wird die Hauptfarbe des Logos verwendet. Wenn das Logo nicht festgelegt ist, wählt Google eine Farbe aus.
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 kann nur alphanumerische Zeichen, ., _ und - enthalten.
classId

string

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

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

object (Barcode)

Typ und Wert des Barcodes. Wenn die Karte bzw. das Ticket keinen Barcode hat, kann der Aussteller „Barcode.alternative_text“ festlegen und nur diesen anzeigen.
heroImage

object (Image)

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

object (TimeInterval)

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

object (ImageModuleData)

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

object (TextModuleData)

Textmoduldaten. Wenn textModulesData auch für die Klasse definiert ist, werden beide angezeigt. Es werden maximal 10 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)

Einstellungen/Details zum rotierenden Barcode
state

enum (State)

Der Status des Objekts. Mit diesem Feld wird festgelegt, wie ein Objekt in der App angezeigt wird. Beispielsweise wird ein inactive-Objekt in den Ordner „Abgelaufene Karten/Tickets“ verschoben . Ohne Angabe 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 die Einschränkungen für das Objekt. Dazu gehört auch das Einschränken von NFC- und Screenshot-Verhalten.
saveRestrictions

object (SaveRestrictions)

Einschränkungen für das Objekt, das überprüft werden muss, bevor der Nutzer versucht, die Karte bzw. das Ticket zu speichern. Diese Einschränkungen werden nur beim Speichern angewendet. Wenn sich die Einschränkungen ändern, nachdem ein Nutzer die Karte bzw. das Ticket gespeichert hat, werden die neuen Einschränkungen nicht auf bereits gespeicherte Karten/Tickets angewendet.

GenericType

Der Typ der generischen Karte.

Enums
GENERIC_TYPE_UNSPECIFIED Nicht angegebener generischer Typ.
GENERIC_SEASON_PASS Staffelpass
GENERIC_UTILITY_BILLS Rechnungen von Versorgungsunternehmen
GENERIC_PARKING_PASS Parkausweis
GENERIC_VOUCHER Gutschein
GENERIC_GYM_MEMBERSHIP Mitgliedsausweise für Fitnessstudios
GENERIC_LIBRARY_MEMBERSHIP Mitgliedskarten für Bibliotheken
GENERIC_RESERVATIONS Reservierungen
GENERIC_AUTO_INSURANCE Kfz-Versicherungskarten
GENERIC_HOME_INSURANCE Krankenversicherungskarten
GENERIC_ENTRY_TICKET Eintrittskarten
GENERIC_RECEIPT Belege
GENERIC_OTHER Anderer Typ

Benachrichtigungen

Gibt an, ob für das Objekt die Benachrichtigung aktiviert sein muss. Es wird nur eine der Optionen „ExpiryNotification“/„PendingNotification“ unterstützt. expiryNotification hat Vorrang vor upcomingNotification. Mit anderen Worten: 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)

Eine Benachrichtigung wird zu einem bestimmten Zeitpunkt ausgelöst, bevor die Karte verwendet werden kann.

ExpiryNotification

Gibt an, dass der Aussteller möchte, dass Google Wallet zwei Tage vor Ablauf der Karte Ablaufbenachrichtigungen 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 einen Tag, bevor die Karte gültig oder nutzbar wird, eine Benachrichtigung über die Gültigkeit der Karte sendet.

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

boolean

Gibt an, ob für das Objekt die anstehenden Benachrichtigungen aktiviert sein müssen.

Methoden

addmessage

 Fügt dem generischen Objekt, auf das von der angegebenen Objekt-ID verwiesen wird, 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 angegebenen Eigenschaften ein.

list

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

patch

 Aktualisiert das generische Objekt, auf das von der angegebenen Objekt-ID verwiesen wird.

update

 Aktualisiert das generische Objekt, auf das von der angegebenen Objekt-ID verwiesen wird.