REST Resource: offerobject

Resource: OfferObject

JSON representation
{
  "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)
  }
}
Fields
kind
(deprecated)

string

Identifies what kind of resource this is. Value: the fixed string "walletobjects#offerObject".

classReference

object (OfferClass)

A copy of the inherited fields of the parent class. These fields are retrieved during a GET.

id

string

Required. The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you. The unique identifier should only include alphanumeric characters, '.', '_', or '-'.

classId

string

Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved.

Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.

version
(deprecated)

string (int64 format)

Deprecated

state

enum (State)

Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an inactive object is no longer displayed in the Google Pay app.

barcode

object (Barcode)

The barcode type and value.

messages[]

object (Message)

An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.

validTimeInterval

object (TimeInterval)

The time period this object will be active and object can be used. An object's state will be changed to expired when this time period has passed.

locations[]

object (LatLongPoint)

The list of locations where the object can be used. The platform uses this information to trigger geolocated notifications to users. Note that locations in the object override locations in the class which override locations in the Google Places ID.

hasUsers

boolean

Indicates if the object has users. This field is set by the platform.

smartTapRedemptionValue

string

Available only to Smart Tap enabled partners. Contact support for additional guidance.

hasLinkedDevice

boolean

Whether this object is currently linked to a single device. This field is set by the platform when a user saves the object, linking it to their device. Intended for use by select partners. Contact support for additional information.

disableExpirationNotification

boolean

Indicates if notifications should explicitly be suppressed. If this field is set to true, regardless of the messages field, expiration notifications to the user will be suppressed. By default, this field is set to false.

Currently, this can only be set for offers.

infoModuleData

object (InfoModuleData)

Deprecated. Use textModulesData instead.

imageModulesData[]

object (ImageModuleData)

Image module data. If image modules data is also defined on the class, those will be merged with the image data defined on the object. The maximum number of these fields (combined with the class) is 1.

textModulesData[]

object (TextModuleData)

Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields (combined with the class) is 10.

Methods

addmessage

Adds a message to the offer object referenced by the given object ID.

get

Returns the offer object with the given object ID.

insert

Inserts an offer object with the given ID and properties.

list

Returns a list of all offer objects for a given issuer ID.

patch

Updates the offer object referenced by the given object ID.

update

Updates the offer object referenced by the given object ID.