REST Resource: offerclass

{
  "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)
  }
}

string

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

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.

enum (RedemptionChannel)

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

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 la cadena completa se muestre en pantallas más pequeñas.

object (Image)

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

string

Los detalles de la oferta.

string

La letra chica o las condiciones de la oferta, como “20% de descuento en cualquier camiseta de Adam's Apparel”

object (Uri)

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

object (LocalizedString)

Cadenas traducidas del 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.

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 pantallas más pequeñas.

object (LocalizedString)

Cadenas traducidas para obtener más detalles.

object (LocalizedString)

Cadenas traducidas para la letra chica.

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.

object (LocalizedString)

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

object (ClassTemplateInfo)

Información de plantilla sobre cómo debe mostrarse la clase. Si no la estableces, Google recurrirá a un conjunto predeterminado de campos para mostrar.

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 el primero lo emite Google y tú eliges el último. Tu identificador único solo debe incluir caracteres alfanuméricos, “.”, “_” o “-”.

string (int64 format)

Funciones obsoletas

string

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

object (Message)

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.

boolean

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

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 la propagación de un URI en linksModuleData (cuando se renderiza un objeto, se muestra un vínculo a la página principal en lo que normalmente se denominaría la sección linksModuleData del objeto).

object (LatLongPoint)

Nota: Actualmente, este campo no es compatible para activar notificaciones geográficas.

enum (ReviewStatus)

Obligatorio. Es el estado de la clase. Este campo se puede establecer como draft o el estado de la clase. Este campo se puede configurar como draft o underReview mediante las llamadas a la API para insertar, aplicar parches o actualizar. 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 actualices una clase approved que ya existe, debes seguir configurando este campo en underReview.

object (Review)

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

object (InfoModuleData)

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

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.

object (TextModuleData)

Datos del módulo de texto. Si también se definen los 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 del objeto y 10 de la clase.

object (LinksModuleData)

Datos del módulo de vínculos. Si también se definen los datos del módulo de vínculos en el objeto, se mostrarán ambos.

string (int64 format)

Identifica las entidades emisoras de los canjes que pueden canjear el pase con el Toque inteligente. Las entidades emisoras de los canjes se identifican con sus ID. Las entidades emisoras de los canjes 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.

string

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

object (Image)

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

object (Image)

Ya no está disponible.

boolean

Identifica si esta clase admite 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.

string

Es 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 hexadecimal RGB, como #ffcc00. También puedes usar la versión abreviada del triplete RGB, que es #rgb, como #fc0.

object (LocalizedString)

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

enum (MultipleDevicesAndHoldersAllowedStatus)

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

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.

object (SecurityAnimation)

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

enum (ViewUnlockRequirement)

Consulta las opciones de Requisitos de desbloqueo de la oferta.

object (Image)

Es la imagen del título ancha de la oferta. Cuando se proporcione, se utilizará en lugar de la imagen de título en la esquina superior izquierda de la vista de tarjetas.