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)
  },
  "appLinkData": {
    object (AppLinkData)
  }
}
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 las 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 del comercio). La longitud máxima recomendada es de 12 caracteres para garantizar que la cadena completa se muestre en las 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

La letra chica o los términos de la oferta, como "20% de descuento en cualquier camiseta en la Tienda de indumentaria de Juan"

helpUri

object (Uri)

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

localizedTitle

object (LocalizedString)

Las cadenas traducidas para el título La longitud máxima recomendada es de 60 caracteres para garantizar que la cadena completa se muestre en las 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)

Se tradujeron las cadenas para la letra chica.

shortTitle

string

Una versión abreviada del título de la oferta, como “20% de descuento”, mostrárselos 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 para el título corto La longitud máxima recomendada es de 20 caracteres.

classTemplateInfo

object (ClassTemplateInfo)

Información de plantilla sobre cómo se debe mostrar la clase. Si no la estableces, Google recurrirá a 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, en el que Google emite el primero y tú eliges el segundo. El identificador único solo debe incluir caracteres alfanuméricos, “.”, “_” o “-”.

version
(deprecated)

string (int64 format)

Obsoleto

issuerName

string

Obligatorio. 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)

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

Obsoleta. Usa multipleDevicesAndHoldersAllowedStatus en su lugar.

homepageUri

object (Uri)

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

locations[]

object (LatLongPoint)

Nota: Por el momento, este campo no se admite 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 cambie el estado de revisión de draft, no se puede 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 las opiniones que establece la plataforma cuando se marca una clase 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 muestran es 1 desde el nivel de objeto y 1 para el nivel de 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 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 canjes deben tener configurada al menos una clave de Toque inteligente.

Los campos enableSmartTap y smartTapRedemptionLevel de nivel de 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 contenido localizado cuando el contenido no está disponible en la configuración regional del usuario.

heroImage

object (Image)

Imagen del banner opcional 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)

Obsoleta.

enableSmartTap

boolean

Identifica si esta clase es compatible con el Toque inteligente. Los campos redemptionIssuers y smartTapRedemptionLevel de nivel de 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 principal, 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 encryptionName. La longitud máxima recomendada es de 20 caracteres para garantizar que la cadena completa se muestre en las 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 configura, se renderizará una animación de seguridad en los detalles del pase.

viewUnlockRequirement

enum (ViewUnlockRequirement)

Consulta las opciones de Requisito de desbloqueo para la oferta.

wideTitleImage

object (Image)

Es la imagen del título amplio de la oferta. Cuando se proporcione, se utilizará en lugar de la imagen de título en la parte superior izquierda de la vista de tarjeta.

RedemptionChannel

Enumeraciones
REDEMPTION_CHANNEL_UNSPECIFIED
INSTORE
instore

Alias heredado de INSTORE. Obsoleta.

ONLINE
online

Alias heredado de ONLINE. Obsoleta.

BOTH
both

Alias heredado de BOTH. Obsoleta.

TEMPORARY_PRICE_REDUCTION
temporaryPriceReduction

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 especificado.

get

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

insert

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

list

Devuelve una lista de todas las clases de ofertas de un ID de entidad emisora determinado.

patch

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

update

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