Package madden.ingestion.offer

Índice

ActionType

[START action_type_definition] Representa el modo de cumplimiento de la oferta. Si una oferta se puede compartir en varios modos de cumplimiento, se espera que se creen ofertas duplicadas para cada modo de cumplimiento.

Enums
ACTION_TYPE_UNSPECIFIED
ACTION_TYPE_FOOD_DELIVERY La oferta se aplica a los servicios de entrega de comida.
ACTION_TYPE_FOOD_TAKEOUT La oferta se aplica a los pedidos de comida para llevar o retirar.
ACTION_TYPE_DINING La oferta es para comer en un restaurante.
ACTION_TYPE_SHOPPING_IN_STORE La oferta se aplica a las compras sin conexión y en la tienda.

AdditionalFee

[START additional_fee_definition]

Campos
name

string

Es el nombre del cargo adicional. Ejemplos: Tarifa por conveniencia, tarifa de gestión, etcétera. Es obligatorio.
fee

Fee

Cupón

[START coupon_definition]

Campos
text

string

Es el texto del cupón que el proveedor de la oferta quiere mostrar a los usuarios.
code

string

Se requiere un código de cupón para canjear la oferta. Obligatorio.

Tarifas

[START fee_definition] ID siguiente: 5

Campos
unit

FeeUnit
type

FeeType

Campo de unión cost.

cost puede ser una de las siguientes opciones:
amount

Money
amount_range

MoneyRange

FeeType

[START fee_type_definition]

Enums
FEE_TYPE_UNSPECIFIED No se debe usar el valor de enumeración UNSPECIFIED o predeterminado en los feeds.
FEE_TYPE_FIXED
FEE_TYPE_VARIABLE

FeeUnit

[START fee_unit_definition]

Enums
FEE_UNIT_UNSPECIFIED No se debe usar el valor de enumeración UNSPECIFIED o predeterminado en los feeds.
FEE_UNIT_PER_GUEST
FEE_UNIT_PER_TRANSACTION

FixedDenominations

Campos
amounts[]

Money

Es una lista de todas las denominaciones discretas disponibles (p.ej., [100, 500, 1000]).

FoodOfferRestrictions

[START food_offer_restrictions_definition]

Campos
meal_types[]

MealType

Tipos de comidas a los que se puede aplicar la oferta, como almuerzo o cena. Si no se configura, la oferta se puede aplicar a todos los tipos de comidas.
restricted_to_certain_courses

bool

Indica si la oferta solo se puede aplicar a ciertos cursos.

GiftCardInfo

[START gift_card_info_definition]

Campos

Campo de unión denomination_type.

denomination_type puede ser una de las siguientes opciones:
fixed_denominations

FixedDenominations

Se usa cuando la tarjeta de regalo está disponible en cantidades fijas específicas.
custom_range

MoneyRange

Se usa cuando la marca permite que los usuarios elijan un valor nominal personalizado (flexible) dentro de un rango definido.

MealType

[START meal_type_definition]

Enums
MEAL_TYPE_UNSPECIFIED No se debe usar el valor de enumeración UNSPECIFIED o predeterminado en los feeds.
MEAL_TYPE_BREAKFAST
MEAL_TYPE_LUNCH
MEAL_TYPE_DINNER

MoneyRange

[START money_range_definition]

Campos
min_amount

Money
max_amount

Money

Oferta

LINT.IfChange(offer_definition) [START offer_definition] Next tag: 26

Campos
offer_id

string

Es el ID único de la oferta. Obligatorio.
entity_ids[]

string

Es la lista de comercios que participan en esta oferta.
add_on_offer_applicable_to_all_entities

bool

Si es verdadero, esta oferta se aplica a todas las entidades del agregador. Solo se aplica a las ofertas de complementos.
offer_source

OfferSource

Un agregador, un comercio individual o incluso un tercero pueden proporcionar una oferta como complemento. Obligatorio.
action_type

ActionType

Es el servicio que proporciona la oferta. Un offer_id solo puede pertenecer a un action_type. Si una oferta se puede compartir en varios tipos de servicios, se espera que se creen ofertas duplicadas con IDs únicos para cada tipo de servicio. Obligatorio.
offer_modes[]

OfferMode

Son los métodos por los que se puede aprovechar la oferta (en persona, con reserva, en línea, etc.). Es obligatorio.
offer_category

OfferCategory

Es la categoría de la oferta. Obligatorio.
source_assigned_priority

int32

Es un número entero no negativo (de 1 a 100, donde 1 representa la prioridad más alta) que indica el nivel de prioridad de la oferta asignada por la fuente. Cuando haya varias ofertas disponibles para el mismo comercio, esto será un indicador para clasificar las ofertas. El valor 0 representaría que no se estableció la prioridad.
offer_details

OfferDetails

Son los detalles de la oferta, como el descuento, el costo de la reserva, etcétera. Es obligatorio.
offer_restrictions

OfferRestrictions

Describe cómo se restringe la oferta, es decir, si se requiere una suscripción o un instrumento de pago, si esta oferta se puede combinar con otras (y qué tipos), etcétera. Se requiere.
coupon

Coupon

Son los detalles de un cupón. Se requiere para offer_category: OFFER_CATEGORY_ADD_ON_COUPON_OFFER.
payment_instrument

PaymentInstrument

Son los detalles de un instrumento de pago. Se requiere para offer_category: OFFER_CATEGORY_ADD_ON_PAYMENT_OFFER.
subscription

Subscription

Son los detalles de una suscripción. Se requiere para offer_category: OFFER_CATEGORY_ADD_ON_SUBSCRIPTION_OFFER.
terms

Terms

Términos y condiciones de la oferta. Obligatorio.
validity_periods[]

ValidityPeriod

Es el período de validez de la oferta. Describe el período durante el cual la oferta es válida, incluidos los horarios de inicio y finalización, los días de la semana, etcétera. Es obligatorio.
offer_url

string

Es la URL de la página de la oferta del comercio. Se requiere para offer_category: OFFER_CATEGORY_BASE_OFFER.
image_url

string

Es la URL de la imagen de la oferta del comercio.
tags[]

OfferTag

Son etiquetas especiales asociadas con la oferta. Se usa para identificar ofertas especiales, como "Festivo", "Mejor calificado", "Más reservado", etcétera.
brand_id

string

Se requiere para los acuerdos de tarjetas de regalo para identificar la marca que ofrece el acuerdo.

OfferCategory

[START offer_category_definition] Categoría de la oferta. Una oferta base es una oferta estándar disponible para todos los clientes, como un 10% de descuento en compras superiores a USD 100. Una oferta básica restringida por un cupón o un instrumento de pago tendrá establecidos los campos correspondientes. También tenemos ofertas de complementos, como ADD_ON_PAYMENT_OFFER. Estas ofertas se pueden agregar a otras para obtener descuentos adicionales.

Enums
OFFER_CATEGORY_UNSPECIFIED No se debe usar el valor de enumeración UNSPECIFIED o predeterminado en los feeds.
OFFER_CATEGORY_BASE_OFFER
OFFER_CATEGORY_ADD_ON_PAYMENT_OFFER
OFFER_CATEGORY_ADD_ON_COUPON_OFFER
OFFER_CATEGORY_ADD_ON_SUBSCRIPTION_OFFER

OfferCondition

[START offer_condition_definition]

Campos
description

string

OfferDetails

[START offer_details_definition] Siguiente etiqueta: 15

Campos
offer_display_text

string

Es el texto de la oferta que el proveedor de la oferta quiere mostrar a los clientes en la página de resultados de la búsqueda. Obligatorio.
max_discount_value

Money

Es el descuento máximo que se puede obtener. Por ejemplo, un 10% de descuento hasta USD 100.
min_spend_value

Money

Es el valor de inversión mínimo para aprovechar el descuento. Por ejemplo, un 10% de descuento cuando el precio total es de USD 100 o más.
booking_cost

Money

Es el costo para reservar esta oferta. Por ejemplo, USD 100 de descuento en la cuenta final cuando se reserva una mesa por USD 15.
booking_cost_unit

FeeUnit

Es la unidad del costo de la reserva. Por ejemplo, por persona y por transacción.
convenience_fee

Fee
booking_cost_adjustable

bool

Indica si el costo de la reserva es ajustable, es decir, si se resta de la factura final. Por ejemplo, un 30% de descuento en la cena con reserva. El costo de la reserva es de USD 15 y se aplicará a la factura final. Por lo tanto, la factura final es: Total invertido - 30% - USD 15
additional_fees[]

AdditionalFee

Son las comisiones adicionales que se cobran al usuario. Ejemplos: Cargos de conveniencia, gestión, entrega, empaquetado, servicio, etcétera.
gift_card_info

GiftCardInfo

Son detalles específicos para las ofertas de tarjetas de regalo.
Campo de unión offer_specification. El descuento puede ser un porcentaje o un valor fijo que se resta del valor total. Por ejemplo: 1. 10% de descuento en la factura final 2. USD 15 de descuento en un pedido Los comercios también pueden ofrecer descuentos personalizados, como "compra uno y llévate uno gratis", a través de los campos de especificación pertinentes. Obligatorio. offer_specification puede ser solo uno de los parámetros siguientes:
discount_percent

float

Es el porcentaje de la factura que se descuenta. [0, 100] Para las ofertas de 2x1 o de un 50% de descuento que se aplican a toda la comida (p.ej., bufé de 2x1, 2x1 en toda la cuenta, 2x1 en el menú fijo), este valor se puede establecer en 50.
discount_value

Money

Es el valor fijo del descuento.
other_offer_detail_text

string

Texto en formato libre para describir el descuento. Aquí se deben describir los detalles de las ofertas específicas de 1+1 (p.ej., 1+1 en bebidas, +1 en plato principal, 1+1 en elementos del menú seleccionados).

OfferMode

[START offer_mode_definition] Especifica el método o el canal a través del cual el usuario puede aprovechar la oferta.

Enums
OFFER_MODE_OTHER Se usa para los métodos de cumplimiento que no están cubiertos por otros modos específicos.
OFFER_MODE_WALK_IN La oferta está disponible para visitas en las instalaciones sin reserva previa.
OFFER_MODE_FREE_RESERVATION La oferta se aplica cuando un usuario realiza una reserva que no requiere una tarifa por adelantado.
OFFER_MODE_PAID_RESERVATION La oferta se aplica cuando un usuario realiza una reserva que requiere un pago por adelantado.
OFFER_MODE_ONLINE_ORDER La oferta es válida para pedidos realizados a través de un sitio web o una plataforma digital.
OFFER_MODE_GIFT_CARD_PURCHASE Indica que la compra de una tarjeta de regalo es el paso principal que se requiere para adquirir la oferta.

OfferRestrictions

[START offer_restrictions_definition] Próxima etiqueta: 11

Campos
combinable_with_other_offers

bool

Indica si esta oferta se puede combinar con otras. Cuando es verdadero, los socios pueden especificar con qué ofertas se puede combinar esta oferta. Si se configuran combinable_offer_categories y combinable_offer_ids, se podrá combinar cualquier oferta que cumpla con una de las condiciones anteriores.
combinable_offer_categories[]

OfferCategory

Es la lista de tipos de ofertas con los que se puede combinar esta oferta. Por ejemplo, esta oferta se puede combinar con otros cupones. Si combinable_with_other_offers es verdadero y este campo no está configurado, todos los tipos se podrán combinar.
combinable_offer_ids[]

string

Es la lista de offer_ids con los que se puede combinar esta oferta. Algunas ofertas solo se pueden combinar con otros offer_ids específicos (se pueden considerar ofertas principales). Si combinable_with_other_offers es verdadero y este campo no está configurado, todos los IDs de oferta se podrán combinar.
inclusions[]

OfferCondition

Lista de condiciones que se deben cumplir para que la oferta sea válida (p.ej., bebidas sin alcohol, comida).
exclusions[]

OfferCondition

Lista de condiciones que invalidarían la oferta (p.ej., bufé, ofertas combinadas y cocteles).
min_guest

int32

Es la cantidad mínima de personas necesarias para aprovechar la oferta.
food_offer_restrictions

FoodOfferRestrictions

Son restricciones específicas para las ofertas de comida.
special_conditions[]

string

Son las condiciones especiales de esta oferta que se deben mostrar al usuario. Ejemplos: "Solo válido para pagos en [área]", "No incluye pagos en línea"

OfferSource

[START offer_source_definition]

Enums
OFFER_SOURCE_UNSPECIFIED
OFFER_SOURCE_AGGREGATOR

OfferTag

[START offer_tag_definition]

Enums
OFFER_TAG_UNSPECIFIED No se debe usar el valor de enumeración UNSPECIFIED o predeterminado en los feeds.
OFFER_TAG_NEW_YEAR_SPECIAL
OFFER_TAG_VALENTINES_SPECIAL

PaymentInstrument

[START payment_instrument_definition]

Campos
items[]

PaymentInstrumentItem

Es la lista de instrumentos de pago que se pueden usar para aprovechar la oferta. Obligatorio.
provider_name

string

Es el nombre del proveedor del instrumento de pago. Puede ser un socio bancario, el nombre de un banco, etc. Por ejemplo: American Express, HDFC, ICICI.

PaymentInstrumentItem

[START payment_instrument_item_definition]

Campos
type

PaymentInstrumentType

Es el tipo de instrumento de pago. Obligatorio.
name

string

Nombre del elemento del instrumento de pago, como el nombre de la tarjeta de crédito. Por ejemplo: HDFC Infinia, American Express Platinum. Obligatorio.

PaymentInstrumentType

[START payment_instrument_type_definition]

Enums
PAYMENT_INSTRUMENT_TYPE_UNSPECIFIED No se debe usar el valor de enumeración UNSPECIFIED o predeterminado en los feeds.
PAYMENT_INSTRUMENT_CREDIT_CARD
PAYMENT_INSTRUMENT_DEBIT_CARD
PAYMENT_INSTRUMENT_BANK_ACCOUNT
PAYMENT_INSTRUMENT_UPI
PAYMENT_INSTRUMENT_ONLINE_WALLET
PAYMENT_INSTRUMENT_NETBANKING

Suscripción

[START subscription_definition]

Campos
name

string

Es el nombre de la suscripción. Obligatorio.
subscription_auto_added

bool

Indica si la suscripción se agrega automáticamente cuando un usuario aprovecha esta oferta.
cost

Money

Es el costo de la suscripción. Obligatorio.
subscription_duration

Duration

Es el período durante el que la suscripción es válida al precio de subscription_cost. Obligatorio.
terms_and_conditions_url

string

URL de los términos y condiciones del socio pertinentes para esta suscripción.

Condiciones

[START terms_definition]

Campos
url

string

Es la URL de los Términos y Condiciones del socio.
restricted_to_certain_users

bool

Indica si la oferta está restringida a ciertos usuarios.
terms_and_conditions

string

Es el texto principal de los TyC que proporciona el socio.
additional_terms_and_conditions[]

string

Son los términos y condiciones que se suman a los principales del socio.