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 las pantallas más pequeñas. |
redemptionChannel |
Obligatorio. Son 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 la cadena completa se muestre en las pantallas más pequeñas. |
titleImage |
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. |
finePrint |
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 |
El vínculo de ayuda para la oferta, como |
localizedTitle |
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 |
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 |
Cadenas traducidas para los detalles |
localizedFinePrint |
Se tradujeron las cadenas para la letra chica. |
shortTitle |
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 |
Cadenas traducidas para el título corto La longitud máxima recomendada es de 20 caracteres. |
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 |
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 |
Obsoleto |
issuerName |
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[] |
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 |
Obsoleta. Usa |
homepageUri |
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[] |
Nota: Por el momento, este campo no se admite para activar notificaciones geográficas. |
reviewStatus |
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 las opiniones que establece la plataforma cuando se marca una clase como |
infoModuleData |
Obsoleta. En su lugar, usa textModulesData. |
imageModulesData[] |
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[] |
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. |
linksModuleData |
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. |
redemptionIssuers[] |
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 |
countryCode |
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 |
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 |
Obsoleta. |
enableSmartTap |
Identifica si esta clase es compatible con el Toque inteligente. Los campos |
hexBackgroundColor |
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 |
localizedIssuerName |
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 |
Identifica si varios usuarios y dispositivos guardarán el mismo objeto que hace referencia a esta clase. |
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 |
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 |
Consulta las opciones de Requisito de desbloqueo para la oferta. |
wideTitleImage |
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. |
appLinkData |
Vínculo opcional a la app o al 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. |
RedemptionChannel
Enumeraciones | |
---|---|
REDEMPTION_CHANNEL_UNSPECIFIED |
|
INSTORE |
|
instore |
Alias heredado de |
ONLINE |
|
online |
Alias heredado de |
BOTH |
|
both |
Alias heredado de |
TEMPORARY_PRICE_REDUCTION |
|
temporaryPriceReduction |
Alias heredado de |
Métodos |
|
---|---|
|
Agrega un mensaje a la clase de oferta a la que hace referencia el ID de clase especificado. |
|
Muestra la clase de oferta con el ID de clase especificado. |
|
Inserta una clase de oferta con el ID y las propiedades especificados. |
|
Devuelve una lista de todas las clases de ofertas de un ID de entidad emisora determinado. |
|
Actualiza la clase de oferta a la que hace referencia el ID de clase dado. |
|
Actualiza la clase de oferta a la que hace referencia el ID de clase dado. |