Recurso: OfferClass
Representación JSON |
---|
{ "kind": string, "title": string, "redemptionChannel": enum ( |
Campos | |
---|---|
kind |
Identifica qué tipo de recurso es. Valor: la cadena fija |
title |
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. |
redemption |
Obligatorio. Los canales de canje aplicables a esta oferta. |
provider |
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. |
title |
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 |
Son los detalles de la oferta. |
fine |
El texto en letra pequeña o las condiciones de la oferta, como "20% de descuento en cualquier camiseta de Adam's Apparel". |
help |
El vínculo de ayuda para la oferta, como |
localized |
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. |
localized |
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. |
localized |
Cadenas traducidas para los detalles. |
localized |
Cadenas traducidas para el texto de la letra pequeña. |
short |
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. |
localized |
Cadenas traducidas para el título corto. La longitud máxima recomendada es de 20 caracteres. |
class |
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 |
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 |
Obsoleto |
issuer |
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[] |
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 |
Obsoleta. Usa |
homepage |
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[] |
Nota: Por el momento, este campo no es compatible para activar notificaciones geográficas. |
review |
Obligatorio. Es el estado de la clase. Este campo se puede establecer en Debes mantener este campo en Debes configurar este campo como Cuando actualices una clase que ya es |
review |
Los comentarios de revisión que establece la plataforma cuando una clase se marca como |
infoModuleData |
Obsoleta. En su lugar, usa textModulesData. |
image |
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. |
text |
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. |
links |
Vincula los datos del módulo. Si los datos del módulo de vínculos también se definen en el objeto, se mostrarán ambos. |
redemption |
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 |
country |
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. |
hero |
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 |
Obsoleta. |
enable |
Identifica si esta clase es compatible con el Toque inteligente. Los campos |
hex |
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 |
localized |
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. |
multiple |
Identifica si varios usuarios y dispositivos guardarán el mismo objeto que hace referencia a esta clase. |
callback |
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. |
security |
Información opcional sobre la animación de seguridad. Si se establece, se renderizará una animación de seguridad en los detalles del pase. |
view |
Consulta las opciones de requisitos de desbloqueo de la oferta. |
wide |
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. |
notify |
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. |
app |
Es un vínculo opcional a una app o un sitio web que se mostrará como un botón en la parte frontal del pase. Si se proporciona AppLinkData para el objeto correspondiente que se usará en su lugar. |
value |
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 |
ONLINE |
|
online |
Es el alias heredado de |
BOTH |
|
both |
Es el alias heredado de |
TEMPORARY_PRICE_REDUCTION |
|
temporaryPriceReduction |
Es el alias heredado de |
Métodos |
|
---|---|
|
Agrega un mensaje a la clase de oferta a la que hace referencia el ID de clase determinado. |
|
Muestra la clase de oferta con el ID de clase determinado. |
|
Inserta una clase de oferta con el ID y las propiedades especificados. |
|
Muestra una lista de todas las clases de oferta para un ID de emisor determinado. |
|
Actualiza la clase de oferta a la que hace referencia el ID de clase determinado. |
|
Actualiza la clase de oferta a la que hace referencia el ID de clase determinado. |