Diese Seite wurde von der Cloud Translation API übersetzt.

REST Resource: offerobject

Ressource: OfferObject
- JSON-Darstellung
Methoden

Ressource: OfferObject

JSON-Darstellung

JSON-Darstellung
{ "kind": string, "classReference": { object (`OfferClass`) }, "id": string, "classId": string, "version": string, "state": enum (`State`), "barcode": { object (`Barcode`) }, "messages": [ { object (`Message`) } ], "validTimeInterval": { object (`TimeInterval`) }, "locations": [ { object (`LatLongPoint`) } ], "hasUsers": boolean, "smartTapRedemptionValue": string, "hasLinkedDevice": boolean, "disableExpirationNotification": boolean, "infoModuleData": { object (`InfoModuleData`) }, "imageModulesData": [ { object (`ImageModuleData`) } ], "textModulesData": [ { object (`TextModuleData`) } ], "linksModuleData": { object (`LinksModuleData`) }, "appLinkData": { object (`AppLinkData`) }, "rotatingBarcode": { object (`RotatingBarcode`) }, "heroImage": { object (`Image`) }, "groupingInfo": { object (`GroupingInfo`) }, "passConstraints": { object (`PassConstraints`) }, "saveRestrictions": { object (`SaveRestrictions`) }, "linkedObjectIds": [ string ], "notifyPreference": enum (`NotificationSettingsForUpdates`), "valueAddedModuleData": [ { object (`ValueAddedModuleData`) } ] }

{
  "kind": string,
  "classReference": {
    object (OfferClass)
  },
  "id": string,
  "classId": string,
  "version": string,
  "state": enum (State),
  "barcode": {
    object (Barcode)
  },
  "messages": [
    {
      object (Message)
    }
  ],
  "validTimeInterval": {
    object (TimeInterval)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "hasUsers": boolean,
  "smartTapRedemptionValue": string,
  "hasLinkedDevice": boolean,
  "disableExpirationNotification": boolean,
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "appLinkData": {
    object (AppLinkData)
  },
  "rotatingBarcode": {
    object (RotatingBarcode)
  },
  "heroImage": {
    object (Image)
  },
  "groupingInfo": {
    object (GroupingInfo)
  },
  "passConstraints": {
    object (PassConstraints)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  },
  "linkedObjectIds": [
    string
  ],
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}

Felder
`kind (deprecated)`	`string` Dieses Element ist veraltet. Kennzeichnet, welche Art von Ressource dies ist. Wert: der feste String `"walletobjects#offerObject"`.
`classReference`	`object (OfferClass)` Eine Kopie der übernommenen Felder der übergeordneten Klasse. Diese Felder werden bei einem GET-Vorgang abgerufen.
`id`	`string` Erforderlich. Die eindeutige Kennung für ein Objekt. Diese ID muss für alle Objekte eines Ausstellers eindeutig sein. Dieser Wert sollte das Format `issuer ID` haben.`identifier`, wobei von Google ausgegeben und von dir ausgewählt wird. Die eindeutige Kennung darf nur alphanumerische Zeichen, „.“ (Punkt), „_“ (Unterstrich) oder „-“ (Bindestriche) enthalten.
`classId`	`string` Erforderlich. Die mit diesem Objekt verknüpfte Klasse. Die Klasse muss vom selben Typ wie dieses Objekt sein, bereits vorhanden und genehmigt sein. Klassen-IDs müssen dem Format `issuer ID` entsprechen.`identifier`, wobei die erstere von Google ausgestellt und die zweite von Ihnen ausgewählt wird.
`version (deprecated)`	`string (int64 format)` Dieses Element ist veraltet. Verworfen
`state`	`enum (State)` Erforderlich. 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.
`barcode`	`object (Barcode)` Der Typ und Wert des Barcodes.
`messages[]`	`object (Message)` Ein Array von Meldungen, die in der App angezeigt werden. Alle Nutzer dieses Objekts erhalten die zugehörigen Nachrichten. Die maximale Anzahl dieser Felder ist 10.
`validTimeInterval`	`object (TimeInterval)` Der Zeitraum, in dem dieses Objekt `active` ist und verwendet werden kann. Der Status eines Objekts wird nach Ablauf dieses Zeitraums in `expired` geändert.
`locations[]`	`object (LatLongPoint)` Hinweis: Dieses Feld wird derzeit nicht zum Auslösen von Benachrichtigungen unterstützt.
`hasUsers`	`boolean` Gibt an, ob das Objekt Nutzer hat. Dieses Feld wird von der Plattform festgelegt.
`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.
`hasLinkedDevice`	`boolean` Gibt an, ob dieses Objekt derzeit mit einem einzelnen Gerät verknüpft ist. Dieses Feld wird von der Plattform festgelegt, wenn ein Nutzer das Objekt speichert und mit seinem Gerät verknüpft. Nur für ausgewählte Partner bestimmt. Weitere Informationen erhalten Sie vom Support.
`disableExpirationNotification`	`boolean` Gibt an, ob Benachrichtigungen explizit unterdrückt werden sollen. Wenn dieses Feld auf „wahr“ gesetzt ist, werden unabhängig vom Feld `messages` keine Ablaufbenachrichtigungen an den Nutzer gesendet. Standardmäßig ist dieses Feld auf „false“ gesetzt. Derzeit kann dies nur für Angebote festgelegt werden.
`infoModuleData`	`object (InfoModuleData)` Verworfen. Verwenden Sie stattdessen textModulesData.
`imageModulesData[]`	`object (ImageModuleData)` Daten des Bildmoduls. Maximal werden ein Feld auf Objektebene und ein Feld auf Klassenobjektebene angezeigt.
`textModulesData[]`	`object (TextModuleData)` Textmoduldaten. Wenn auch Textmoduldaten für die Klasse definiert sind, werden beide angezeigt. Es werden maximal 10 Felder des Objekts und 10 Felder der Klasse angezeigt.
`linksModuleData`	`object (LinksModuleData)` Linkmoduldaten. Wenn für den Kurs auch Linkmoduldaten definiert sind, werden beide angezeigt.
`appLinkData`	`object (AppLinkData)` Optionaler Link zu einer App oder Website, der auf der Vorderseite der Karte/des Tickets als Schaltfläche angezeigt wird. Wenn AppLinkData für das entsprechende Klassenobjekt bereitgestellt wird, wird nur das AppLinkData-Objekt angezeigt.
`rotatingBarcode`	`object (RotatingBarcode)` Typ und Wert des rotierenden Barcodes.
`heroImage`	`object (Image)` Optionales Bannerbild, das auf der Vorderseite der Karte angezeigt wird. Ist keins vorhanden, wird das Hero-Image der Klasse angezeigt, sofern vorhanden. Wenn auch das Hero-Image des Kurses nicht vorhanden ist, wird nichts angezeigt.
`groupingInfo`	`object (GroupingInfo)` Informationen, die steuern, wie Karten/Tickets gruppiert werden.
`passConstraints`	`object (PassConstraints)` Einschränkungen 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, das überprüft werden muss, 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.
`linkedObjectIds[]`	`string` verknüpfteObjectIds sind eine Liste weiterer Objekte wie Veranstaltungstickets, Treuepunkte, Angebote, generische, Geschenkkarten, öffentliche Verkehrsmittel und Bordkarten, die automatisch an dieses Angebotsobjekt angehängt werden sollen. Wenn ein Nutzer dieses Angebot gespeichert hätte, werden diese verknüpften ObjectIds automatisch an das Wallet des Nutzers gesendet, es sei denn, er hat die Einstellung zum Erhalt solcher verknüpften Karten/Tickets deaktiviert. Achten Sie darauf, dass Objekte, die in „linkedObjectIds“ vorhanden sind, bereits eingefügt wurden. Andernfalls schlagen Aufrufe fehl. Nach der Verknüpfung können die verknüpften Objekte 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`, wenn die erstere von Google herausgegeben und die zweite von Ihnen ausgewählt wird.
`notifyPreference`	`enum (NotificationSettingsForUpdates)` Gibt an, ob Feldaktualisierungen für dieses Objekt Benachrichtigungen auslösen sollen. Wenn diese Option auf NOTIFY gesetzt ist, versuchen wir, eine Benachrichtigung über die Aktualisierung eines Felds an die Nutzer auszulösen. Diese Benachrichtigungen werden nur an Nutzer gesendet, wenn das Feld auf einer Zulassungsliste steht. Wenn „DO_NOT_NOTIFY“ oder „NOTIFICATION_SETTINGS_UNSPECIFIED“ festgelegt ist, wird keine Benachrichtigung ausgelöst. Diese Einstellung ist temporär und muss bei jeder PATCH- oder UPDATE-Anfrage festgelegt werden. Andernfalls wird keine Benachrichtigung ausgelöst.
`valueAddedModuleData[]`	`object (ValueAddedModuleData)` Optionale Daten zum Mehrwertmodul. Maximal zehn für das Objekt.

Methoden
`addmessage`	Fügt dem Angebotsobjekt, auf das die angegebene Objekt-ID verweist, eine Nachricht hinzu.
`get`	Gibt das Angebotsobjekt mit der angegebenen Objekt-ID zurück.
`insert`	Ein Angebotsobjekt mit der angegebenen ID und den angegebenen Eigenschaften wird eingefügt.
`list`	Gibt eine Liste aller Angebotsobjekte für eine bestimmte Aussteller-ID zurück.
`patch`	Aktualisiert das Angebotsobjekt, auf das durch die angegebene Objekt-ID verwiesen wird.
`update`	Aktualisiert das Angebotsobjekt, auf das durch die angegebene Objekt-ID verwiesen wird.

REST Resource: offerobject

Ressource: OfferObject

Methoden

`addmessage`

`get`

`insert`

`list`

`patch`

`update`