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,
  "messages": [
    {
      object (Message)
    }
  ],
  "passConstraints": {
    object (PassConstraints)
  },
  "wideLogo": {
    object (Image)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ],
  "linkedObjectIds": [
    string
  ]
}
Felder
genericType

enum (GenericType)

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

object (LocalizedString)

Erforderlich. Die Überschrift 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/dem Ticket angezeigt.
subheader

object (LocalizedString)

Das Titellabel der Karte/des Tickets, z. B. der Ort, an dem die Karte/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/des Tickets, z. B. „Gutschein für 50% Rabatt“, „Bibliothekskarte“ oder „Gutschein“. Dieses Feld ist ein Pflichtfeld und wird in der Titelzeile der Detailansicht der Karte/des Tickets angezeigt.
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. Ist auch das Logo nicht festgelegt, wird eine Farbe von Google ausgewählt.
notifications

object (Notifications)

Die für dieses Objekt aktivierten Benachrichtigungseinstellungen.
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, ., _ oder - enthalten.
classId

string

Erforderlich. Die Klasse, die mit diesem Objekt verknüpft ist. Die Klasse muss vom selben Typ wie dieses Objekt sein, bereits vorhanden und genehmigt sein.

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

object (Barcode)

Der Typ und Wert des Barcodes. Wenn der Aussteller keinen Barcode für die Karte/das Ticket angibt, können wir ihm erlauben, „Barcode.alternate_text“ festzulegen und nur diesen Text anzuzeigen.
heroImage

object (Image)

Bannerbild, das auf der Vorderseite der Karte angezeigt wird, falls vorhanden. Das Bild wird mit 100% der Breite 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. Das wirkt sich auf das Rendering auf den Geräten der Nutzer aus.
imageModulesData[]

object (ImageModuleData)

Daten des Bildmoduls. Wenn beide festgelegt sind, wird nur eines der Bilder von der Klassen- und eines von der Objektebene gerendert.
textModulesData[]

object (TextModuleData)

Textmoduldaten. Wenn textModulesData auch für den Kurs definiert ist, werden beide angezeigt. Es werden maximal 10 Felder der Klasse und 10 Felder des Objekts 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 enableSmartTap und redemptionIssuers auf Klassenebene müssen ebenfalls richtig 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 für den rotierenden Barcode.
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. Wenn dieser Wert nicht angegeben ist, wird das Objekt als ACTIVE betrachtet.
hasUsers

boolean

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

object (Message)

Eine Reihe von Nachrichten, die in der App angezeigt werden. Alle Nutzer dieses Objekts erhalten die zugehörigen Nachrichten. Die maximale Anzahl dieser Felder ist 10.
passConstraints

object (PassConstraints)

Einschränkungen für Karten/Tickets für das Objekt. Dazu gehört auch die Einschränkung des NFC- und Screenshot-Verhaltens.
saveRestrictions

object (SaveRestrictions)

Einschränkungen für das Objekt, die überprüft werden müssen, bevor der Nutzer versucht, die Karte bzw. das Ticket zu speichern. Diese Einschränkungen gelten nur während der Speicherzeit. Wenn sich die Einschränkungen ändern, nachdem ein Nutzer die Karte bzw. das Ticket gespeichert hat, werden die neuen Einschränkungen nicht auf eine bereits gespeicherte Karte bzw. ein bereits gespeichertes Ticket angewendet.
valueAddedModuleData[]

object (ValueAddedModuleData)

Optionale Daten zum Mehrwertmodul. Maximal zehn für das Objekt.
linkedObjectIds[]

string

„linkedObjectIds“ ist eine Liste anderer Objekte wie Veranstaltungstickets, Kundenkarten, Angebote, generische Objekte, Geschenkkarten, Fahrkarten und Bordkarten, die automatisch an dieses generische Objekt angehängt werden sollen. Wenn ein Nutzer diese generisch Karte gespeichert hat, werden diese linkedObjectIds automatisch an die Wallet des Nutzers gesendet, es sei denn, er hat die Einstellung deaktiviert, um solche verknüpften Karten/Tickets zu erhalten.

Achten Sie darauf, dass Objekte, die in „linkedObjectIds“ vorhanden sind, bereits eingefügt wurden. Andernfalls schlagen Aufrufe fehl. Verknüpfte Objekte können nicht mehr getrennt werden. Sie können keine Objekte verknüpfen, die einem anderen Aussteller gehören. Die Anzahl der Objekte, die mit einem einzelnen Objekt verknüpft werden können, ist begrenzt. Wenn das Limit erreicht ist, werden neue verknüpfte Objekte im Anruf stumm ignoriert.

Objekt-IDs müssen dem Format issuer ID entsprechen.identifier, wobei von Google ausgegeben und von dir ausgewählt wird.

GenericType

Der Typ der generischen Karte.

Enums
GENERIC_TYPE_UNSPECIFIED Nicht angegebener generischer Typ.
GENERIC_SEASON_PASS Saisonpass
GENERIC_UTILITY_BILLS Rechnungen von Versorgungsunternehmen
GENERIC_PARKING_PASS Parkschein
GENERIC_VOUCHER Gutschein
GENERIC_GYM_MEMBERSHIP Mitgliedskarten für Fitnessstudios
GENERIC_LIBRARY_MEMBERSHIP Bibliotheksausweise
GENERIC_RESERVATIONS Reservierungen
GENERIC_AUTO_INSURANCE Kfz-Versicherungskarten
GENERIC_HOME_INSURANCE Karten für Wohngebäudeversicherungen
GENERIC_ENTRY_TICKET Eintrittskarten
GENERIC_RECEIPT Belege
GENERIC_LOYALTY_CARD Kundenkarten Es wird empfohlen, anstelle dieses generischen Typs einen speziellen Kartentyp für das Treuepunkteprogramm zu verwenden. Ein spezieller Kartentyp für Kundenkarten bietet mehr Funktionen als ein generischer Kartentyp.
GENERIC_OTHER Anderer Typ

Benachrichtigungen

Gibt an, ob für das Objekt Benachrichtigungen aktiviert sein müssen. Es wird nur eine von ExpiryNotification/UpcomingNotification unterstützt. expiryNotification hat Vorrang vor upcomingNotification. Wenn expiryNotification festgelegt ist, wird das Feld upcomingNotification ignoriert.

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

object (ExpiryNotification)

Zu einer bestimmten Zeit vor Ablauf der Karte wird eine Benachrichtigung ausgelöst.
upcomingNotification

object (UpcomingNotification)

Zu einer bestimmten Zeit wird eine Benachrichtigung ausgelöst, bevor die Karte verwendet werden kann.

ExpiryNotification

Gibt an, dass der Aussteller möchte, dass Google Wallet 2 Tage vor Ablauf der Karte Ablaufbenachrichtigungen sendet.

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

boolean

Gibt an, ob für das Objekt eine Ablaufbenachrichtigung aktiviert werden muss.

UpcomingNotification

Gibt an, dass der Aussteller möchte, dass Google Wallet 1 Tag vor Gültigkeitsbeginn der Karte eine Benachrichtigung sendet.

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

boolean

Gibt an, ob für das Objekt eine Benachrichtigung für anstehende Termine aktiviert sein muss.

Methoden

addmessage

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

get

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

insert

 Ein generisches Objekt mit der angegebenen ID und den angegebenen Eigenschaften wird eingefügt.

list

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

patch

 Aktualisiert das generische Objekt, auf das durch die angegebene Objekt-ID verwiesen wird.

update

 Aktualisiert das generische Objekt, auf das durch die angegebene Objekt-ID verwiesen wird.