REST Resource: offerobject

Recurso: OfferObject

Representación JSON 
{
  "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)
    }
  ]
}
Campos
kind
(deprecated)

string

Identifica qué tipo de recurso es. Valor: la cadena fija "walletobjects#offerObject".
classReference

object (OfferClass)

Es una copia de los campos heredados de la clase superior. Estos campos se recuperan durante una solicitud GET.
id

string

Obligatorio. Es el identificador único de un objeto. Este ID debe ser único para todos los objetos de un emisor. Este valor debe seguir el formato issuer ID.identifier, donde Google emite el primero y tú eliges el segundo. El identificador único solo debe incluir caracteres alfanuméricos, ".", "_" o "-".
classId

string

Obligatorio. La clase asociada con este objeto. La clase debe ser del mismo tipo que este objeto, ya debe existir y debe estar aprobada.

Los IDs de clase deben seguir el formato issuer ID.identifier, donde Google emite el primero y tú eliges el segundo.
version
(deprecated)

string (int64 format)

Obsoleto
state

enum (State)

Obligatorio. Es el estado del objeto. Este campo se usa para determinar cómo se muestra un objeto en la app. Por ejemplo, un objeto inactive se mueve a la sección "Pasos vencidos".
barcode

object (Barcode)

El tipo y valor del código de barras.
messages[]

object (Message)

Es un array de mensajes que se muestran en la app. Todos los usuarios de este objeto recibirán los mensajes asociados. La cantidad máxima de estos campos es 10.
validTimeInterval

object (TimeInterval)

Es el período durante el cual este objeto será active y se puede usar. El estado de un objeto cambiará a expired cuando haya transcurrido este período.
locations[]

object (LatLongPoint)

Nota: Por el momento, este campo no es compatible para activar notificaciones geográficas.
hasUsers

boolean

Indica si el objeto tiene usuarios. La plataforma establece este campo.
smartTapRedemptionValue

string

Es el valor que se transmitirá a una terminal certificada de Smart Tap a través de NFC para este objeto. Los campos a nivel de la clase enableSmartTap y redemptionIssuers también deben configurarse correctamente para que el pase admita el Toque inteligente. Solo se admiten caracteres ASCII.
hasLinkedDevice

boolean

Indica si este objeto está vinculado actualmente a un solo dispositivo. La plataforma establece este campo cuando un usuario guarda el objeto y lo vincula a su dispositivo. Está diseñada para que la usen socios seleccionados. Comunícate con el equipo de asistencia para obtener más información.
disableExpirationNotification

boolean

Indica si se deben suprimir las notificaciones de forma explícita. Si este campo se establece como verdadero, independientemente del campo messages, se suprimirán las notificaciones de vencimiento para el usuario. De forma predeterminada, este campo se establece como "false".

Por el momento, solo se puede configurar para las ofertas.
infoModuleData

object (InfoModuleData)

Obsoleta. En su lugar, usa textModulesData.
imageModulesData[]

object (ImageModuleData)

Datos del módulo de imagen. La cantidad máxima de estos campos que se muestra es 1 a nivel del objeto y 1 a nivel del objeto de clase.
textModulesData[]

object (TextModuleData)

Datos del módulo de texto Si los datos del módulo de texto también se definen en la clase, se mostrarán ambos. La cantidad máxima de estos campos que se muestran es de 10 del objeto y 10 de la clase.
rotatingBarcode

object (RotatingBarcode)

El tipo y el valor del código de barras rotativo.
heroImage

object (Image)

Es la imagen de banner opcional que se muestra en la parte frontal de la tarjeta. Si no hay ninguno, se mostrará la imagen principal de la clase, si está presente. Si tampoco está presente la imagen hero de la clase, no se mostrará nada.
groupingInfo

object (GroupingInfo)

Es la información que controla cómo se agrupan los pases.
passConstraints

object (PassConstraints)

Pasa las restricciones del objeto. Incluye la limitación de los comportamientos de NFC y capturas de pantalla.
saveRestrictions

object (SaveRestrictions)

Son restricciones sobre el objeto que se deben verificar antes de que el usuario intente guardar el pase. Ten en cuenta que estas restricciones solo se aplicarán durante el tiempo de guardado. Si las restricciones cambian después de que un usuario guarda un pase, las restricciones nuevas no se aplicarán a un pase ya guardado.
linkedObjectIds[]

string

linkedObjectIds es una lista de otros objetos, como entradas para eventos, lealtad, ofertas, genéricos, tarjetas de regalo, transporte público y tarjetas de embarque, que se deben adjuntar automáticamente a este objeto de oferta. Si un usuario guardó la oferta, estos linkedObjectIds se enviarán automáticamente a su billetera (a menos que se haya desactivado el parámetro de configuración para recibir los pases vinculados).

Asegúrate de que los objetos presentes en linkedObjectIds ya estén insertados. De lo contrario, las llamadas fallarán. Una vez vinculados, los objetos vinculados no se pueden desvincular. No puedes vincular objetos que pertenezcan a otro emisor. Existe un límite para la cantidad de objetos que se pueden vincular a un solo objeto. Una vez que se alcance el límite, se ignorarán en silencio los objetos vinculados nuevos en la llamada.

Los IDs de objetos deben seguir el formato issuer ID.identifier, donde Google emite el primero y tú eliges el segundo.
notifyPreference

enum (NotificationSettingsForUpdates)

Establece si las actualizaciones de campo de este objeto deben activar notificaciones o no. Cuando se configura como NOTIFY, intentaremos activar una notificación de actualización de campo para los usuarios. Estas notificaciones solo se enviarán a los usuarios si el campo forma parte de una lista de entidades permitidas. Si la estableces en DO_NOT_NOTIFY o NOTIFICATION_CONFIG_UNSPECIFIED, no se activará ninguna notificación. Este parámetro de configuración es efímero y se debe establecer con cada solicitud PATCH o UPDATE. De lo contrario, no se activará una notificación.
valueAddedModuleData[]

object (ValueAddedModuleData)

Datos opcionales del módulo de valor agregado. Máximo de diez en el objeto.

Métodos

addmessage

 Agrega un mensaje al objeto de oferta al que hace referencia el ID de objeto determinado.

get

 Muestra el objeto de oferta con el ID de objeto determinado.

insert

 Inserta un objeto de oferta con el ID y las propiedades determinados.

list

 Devuelve una lista de todos los objetos de oferta de un ID de entidad emisora determinado.

patch

 Actualiza el objeto de oferta al que hace referencia el ID de objeto determinado.

update

 Actualiza el objeto de oferta al que hace referencia el ID de objeto dado.