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)
  }
}
Campos
kind
(deprecated)

string

Identifica qué tipo de recurso es este. Valor: la string 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 se muestre toda la cadena en pantallas más pequeñas.
redemptionChannel

enum (RedemptionChannel)

Obligatorio. Son los canales de canje aplicables a esta oferta.
provider

string

Obligatorio. Es el proveedor de la oferta (ya sea el nombre del agregador o el nombre del comercio). La longitud máxima recomendada es de 12 caracteres para garantizar que se muestre toda la cadena 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 detalles y de lista de la app.
details

string

Son los detalles de la oferta.
finePrint

string

La letra chica o los términos de la oferta, como "20% de descuento en cualquier camiseta en Ropa Adán".
helpUri

object (Uri)

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

object (LocalizedString)

Cadenas traducidas del título La longitud máxima recomendada es de 60 caracteres para garantizar que se muestre toda la cadena 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 se muestre toda la cadena en pantallas más pequeñas.
localizedDetails

object (LocalizedString)

Cadenas traducidas para ver los detalles
localizedFinePrint

object (LocalizedString)

Cadenas traducidas para la letra chica.
shortTitle

string

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

object (LocalizedString)

Cadenas traducidas del 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 la estableces, Google recurrirá a un conjunto de campos predeterminado 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 la primera es emitida por Google y la última es la tuya. Tu identificador único solo debe incluir caracteres alfanuméricos, “.”, “_” o “-”.
version
(deprecated)

string (int64 format)

Obsoleto
issuerName

string

Obligatorio. El nombre de la entidad emisora. La longitud máxima recomendada es de 20 caracteres para garantizar que se muestre toda la cadena en pantallas más pequeñas.
messages[]

object (Message)

Un array de mensajes que se muestra 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

Ya no está disponible. Usa multipleDevicesAndHoldersAllowedStatus en su lugar.
homepageUri

object (Uri)

El URI de la página principal de tu aplicación. La propagación del URI en este campo da como resultado el mismo comportamiento que si se propaga un URI en linksModuleData (cuando se renderiza un objeto, se muestra un vínculo a la página principal en lo que generalmente se consideraría la sección linksModuleData del objeto).
locations[]

object (LatLongPoint)

Nota: Actualmente, este campo no es compatible con la activación de notificaciones geográficas.
reviewStatus

enum (ReviewStatus)

Obligatorio. Estado de la clase. Este campo se puede establecer en draft o en el estado de la clase. Este campo se puede configurar como draft o underReview mediante las llamadas a la API de inserción, parche o actualización. Una vez que el estado de revisión cambie de draft, no se podrá 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 establecer este campo en underReview cuando creas que la clase está lista para usarse. La plataforma establecerá automáticamente este campo en approved y se podrá usar de inmediato para crear o migrar objetos.

Cuando actualizas 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 está marcada como approved o rejected.
infoModuleData
(deprecated)

object (InfoModuleData)

Ya no está disponible. En su lugar, usa textModulesData.
imageModulesData[]

object (ImageModuleData)

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

object (TextModuleData)

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

string (int64 format)

Identifica qué entidades emisoras de canje pueden canjear el pase con Smart Tap. Las entidades emisoras de canje se identifican con su ID de entidad emisora. Las entidades emisoras de canje deben tener al menos una clave de Toque inteligente configurada.

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 (si el usuario no se encuentra en ese país) y contenido localizado cuando no está disponible en la configuración regional del usuario.
heroImage

object (Image)

Imagen opcional del banner que se muestra en el frente de la tarjeta. Si no hay ninguno, no se mostrará nada. La imagen se mostrará con un ancho del 100%.
wordMark
(deprecated)

object (Image)

Ya no está disponible.
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 el color dominante de la imagen de héroe, se utiliza 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 el número rgb, como #fc0.
localizedIssuerName

object (LocalizedString)

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

enum (MultipleDevicesAndHoldersAllowedStatus)

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

object (CallbackOptions)

Opciones de devolución de llamada que el usuario final usará 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 para la oferta.
wideTitleImage

object (Image)

Es la imagen del título ancho de la oferta. Cuando se proporciona, se utiliza en lugar de la imagen de título en la parte superior izquierda de la vista de tarjetas.

RedemptionChannel

Enumeradores
REDEMPTION_CHANNEL_UNSPECIFIED
INSTORE
instore

Alias heredado de INSTORE. Ya no está disponible.
ONLINE
online

Alias heredado de ONLINE. Ya no está disponible.
BOTH
both

Alias heredado de BOTH. Ya no está disponible.
TEMPORARY_PRICE_REDUCTION
temporaryPriceReduction

Alias heredado de TEMPORARY_PRICE_REDUCTION. Ya no está disponible.

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

 Devuelve una lista de todas las clases de ofertas para un ID de entidad emisora 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.