REST Resource: offerclass

Recurso: OfferClass

Representación JSON
{
  "kind": string,
  "title": string,
  "redemptionChannel": enum (RedemptionChannel),
  "provider": string,
  "titleImage": {
    object (Image)
  },
  "details": string,
  "finePrint": string,
  "helpUri": {
    object (Uri)
  },
  "localizedTitle": {
    object (LocalizedString)
  },
  "localizedProvider": {
    object (LocalizedString)
  },
  "localizedDetails": {
    object (LocalizedString)
  },
  "localizedFinePrint": {
    object (LocalizedString)
  },
  "shortTitle": string,
  "localizedShortTitle": {
    object (LocalizedString)
  },
  "classTemplateInfo": {
    object (ClassTemplateInfo)
  },
  "id": string,
  "version": string,
  "issuerName": string,
  "messages": [
    {
      object (Message)
    }
  ],
  "allowMultipleUsersPerObject": boolean,
  "homepageUri": {
    object (Uri)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "reviewStatus": enum (ReviewStatus),
  "review": {
    object (Review)
  },
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "redemptionIssuers": [
    string
  ],
  "countryCode": string,
  "heroImage": {
    object (Image)
  },
  "wordMark": {
    object (Image)
  },
  "enableSmartTap": boolean,
  "hexBackgroundColor": string,
  "localizedIssuerName": {
    object (LocalizedString)
  },
  "multipleDevicesAndHoldersAllowedStatus": enum (MultipleDevicesAndHoldersAllowedStatus),
  "callbackOptions": {
    object (CallbackOptions)
  },
  "securityAnimation": {
    object (SecurityAnimation)
  },
  "viewUnlockRequirement": enum (ViewUnlockRequirement),
  "wideTitleImage": {
    object (Image)
  },
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "appLinkData": {
    object (AppLinkData)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
Campos
kind
(deprecated)

string

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

title

string

Obligatorio. El título de la oferta, como "20% de descuento en cualquier camiseta". La longitud máxima recomendada es de 60 caracteres para garantizar que la cadena completa se muestre en pantallas más pequeñas.

redemptionChannel

enum (RedemptionChannel)

Obligatorio. Los canales de canje aplicables a esta oferta.

provider

string

Obligatorio. Es el proveedor de la oferta (ya sea el nombre del agregador o del comercio). La longitud máxima recomendada es de 12 caracteres para garantizar que se muestre la cadena completa en pantallas más pequeñas.

titleImage

object (Image)

Es la imagen del título de la oferta. Esta imagen se muestra en las vistas de lista y de detalles de la app.

details

string

Son los detalles de la oferta.

finePrint

string

El texto en letra pequeña o las condiciones de la oferta, como "20% de descuento en cualquier camiseta de Adam's Apparel".

helpUri

object (Uri)

El vínculo de ayuda para la oferta, como http://myownpersonaldomain.com/help

localizedTitle

object (LocalizedString)

Cadenas traducidas para el título. La longitud máxima recomendada es de 60 caracteres para garantizar que la cadena completa se muestre en pantallas más pequeñas.

localizedProvider

object (LocalizedString)

Cadenas traducidas para el proveedor. La longitud máxima recomendada es de 12 caracteres para garantizar que la cadena completa se muestre en las pantallas más pequeñas.

localizedDetails

object (LocalizedString)

Cadenas traducidas para los detalles.

localizedFinePrint

object (LocalizedString)

Cadenas traducidas para el texto de la letra pequeña.

shortTitle

string

Es una versión abreviada del título de la oferta, como "20% de descuento", que se muestra a los usuarios como referencia rápida del contenido de la oferta. La longitud máxima recomendada es de 20 caracteres.

localizedShortTitle

object (LocalizedString)

Cadenas traducidas para el título corto. La longitud máxima recomendada es de 20 caracteres.

classTemplateInfo

object (ClassTemplateInfo)

Información de la plantilla sobre cómo se debe mostrar la clase. Si no se establece, Google usará un conjunto predeterminado de campos para mostrar.

id

string

Obligatorio. Es el identificador único de una clase. Este ID debe ser único en todas las clases de una entidad emisora. Este valor debe seguir el formato issuer ID.identifier, donde Google emite el primero y tú eliges el segundo. Tu identificador único solo debe incluir caracteres alfanuméricos, '.', '_' o '-'.

version
(deprecated)

string (int64 format)

Obsoleto

issuerName

string

Obligatorio. Es el nombre de la entidad emisora. La longitud máxima recomendada es de 20 caracteres para garantizar que la cadena completa se muestre en las pantallas más pequeñas.

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.

allowMultipleUsersPerObject
(deprecated)

boolean

Obsoleta. Usa multipleDevicesAndHoldersAllowedStatus en su lugar.

homepageUri

object (Uri)

Es el URI de la página principal de tu aplicación. Si propagas el URI en este campo, se produce exactamente el mismo comportamiento que si propagas un URI en linksModuleData (cuando se renderiza un objeto, se muestra un vínculo a la página principal en lo que se suele considerar la sección linksModuleData del objeto).

locations[]
(deprecated)

object (LatLongPoint)

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

reviewStatus

enum (ReviewStatus)

Obligatorio. Es el estado de la clase. Este campo se puede establecer en draft o en el estado de la clase. Este campo se puede establecer en draft o underReview mediante las llamadas a la API de insertar, aplicar parches o actualizar. Una vez que se cambia el estado de la revisión de draft, es posible que no se pueda volver a cambiar a draft.

Debes mantener este campo en draft cuando la clase esté en desarrollo. No se puede usar una clase draft para crear ningún objeto.

Debes configurar este campo como underReview cuando creas que la clase está lista para usarse. La plataforma establecerá automáticamente este campo en approved y se puede usar de inmediato para crear o migrar objetos.

Cuando actualices una clase que ya es approved, debes seguir estableciendo este campo en underReview.

review

object (Review)

Los comentarios de revisión que establece la plataforma cuando una clase se marca como approved o rejected

infoModuleData
(deprecated)

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 también se definen datos del módulo de texto 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.

redemptionIssuers[]

string (int64 format)

Identifica qué emisores de canje pueden canjear el pase a través de Smart Tap. Las entidades emisoras de canjes se identifican por su ID de emisor. Las entidades emisoras de canjes deben tener configurada al menos una clave de Toque inteligente.

Los campos enableSmartTap y smartTapRedemptionLevel a nivel del objeto también deben configurarse correctamente para que un pase admita el Toque inteligente.

countryCode

string

Es el código de país que se usa para mostrar el país de la tarjeta (cuando el usuario no está en ese país) y para mostrar contenido localizado cuando no está disponible en la configuración regional del usuario.

heroImage

object (Image)

Es la imagen de banner opcional que se muestra en la parte frontal de la tarjeta. Si no hay ninguno, no se mostrará nada. La imagen se mostrará al 100% de ancho.

wordMark
(deprecated)

object (Image)

Obsoleta.

enableSmartTap

boolean

Identifica si esta clase es compatible con el Toque inteligente. Los campos redemptionIssuers y smartTapRedemptionLevel a nivel del objeto también deben configurarse correctamente para que un pase admita el Toque inteligente.

hexBackgroundColor

string

El color de fondo de la tarjeta Si no se establece, se usa el color dominante de la imagen hero y, si no se establece ninguna imagen hero, se usa el color dominante del logotipo. El formato es #rrggbb, en el que rrggbb es un triplete RGB hexadecimal, como #ffcc00. También puedes usar la versión abreviada del triplete RGB que es #rgb, como #fc0.

localizedIssuerName

object (LocalizedString)

Cadenas traducidas para issuerName. La longitud máxima recomendada es de 20 caracteres para garantizar que se muestre la cadena completa en pantallas más pequeñas.

multipleDevicesAndHoldersAllowedStatus

enum (MultipleDevicesAndHoldersAllowedStatus)

Identifica si varios usuarios y dispositivos guardarán el mismo objeto que hace referencia a esta clase.

callbackOptions

object (CallbackOptions)

Opciones de devolución de llamada que se usarán para devolver la llamada a la entidad emisora cada vez que el usuario final guarde o borre un objeto de esta clase. Todos los objetos de esta clase son aptos para la devolución de llamada.

securityAnimation

object (SecurityAnimation)

Información opcional sobre la animación de seguridad. Si se establece, se renderizará una animación de seguridad en los detalles del pase.

viewUnlockRequirement

enum (ViewUnlockRequirement)

Consulta las opciones de requisitos de desbloqueo de la oferta.

wideTitleImage

object (Image)

Es la imagen del título amplio de la oferta. Si se proporciona, se usará en lugar de la imagen del título en la parte superior izquierda de la vista de la tarjeta.

notifyPreference

enum (NotificationSettingsForUpdates)

Si las actualizaciones de campo de esta clase deben activar notificaciones o no. Cuando se establece en 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 no se especifica, 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. Se permite un máximo de diez personas en la clase. Para un pase, solo se mostrarán diez, priorizando las del objeto.

RedemptionChannel

Enumeraciones
REDEMPTION_CHANNEL_UNSPECIFIED
INSTORE
instore

Alias heredado de INSTORE. Obsoleta.

ONLINE
online

Es el alias heredado de ONLINE. Obsoleta.

BOTH
both

Es el alias heredado de BOTH. Obsoleta.

TEMPORARY_PRICE_REDUCTION
temporaryPriceReduction

Es el alias heredado de TEMPORARY_PRICE_REDUCTION. Obsoleta.

Métodos

addmessage

Agrega un mensaje a la clase de oferta a la que hace referencia el ID de clase determinado.

get

Muestra la clase de oferta con el ID de clase determinado.

insert

Inserta una clase de oferta con el ID y las propiedades especificados.

list

Muestra una lista de todas las clases de oferta para un ID de emisor determinado.

patch

Actualiza la clase de oferta a la que hace referencia el ID de clase determinado.

update

Actualiza la clase de oferta a la que hace referencia el ID de clase determinado.