Package madden.ingestion.offer

Índice

ActionType

[START action_type_definition] Representa o modo de fulfillment da oferta. Se uma oferta puder ser compartilhada em vários modos de fulfillment, é esperado que ofertas duplicadas sejam criadas para cada modo.

Tipos enumerados
ACTION_TYPE_UNSPECIFIED
ACTION_TYPE_FOOD_DELIVERY A oferta é válida para serviços de entrega de comida.
ACTION_TYPE_FOOD_TAKEOUT A oferta é válida para pedidos de comida para viagem ou retirada.
ACTION_TYPE_DINING A oferta é para refeições no local em um restaurante.
ACTION_TYPE_SHOPPING_IN_STORE A oferta é válida para compras off-line e na loja física.

AdditionalFee

[START additional_fee_definition]

Campos
name

string

O nome da taxa adicional. Exemplos: taxa de conveniência, taxa de manuseio etc. Obrigatório.
fee

Fee

Cupom

[START coupon_definition]

Campos
text

string

O texto do cupom que o provedor da oferta quer mostrar aos usuários.
code

string

É necessário um código de cupom para resgatar a oferta. Obrigatório.

Fee

[START fee_definition] Próximo ID: 5

Campos
unit

FeeUnit
type

FeeType

Campo de união cost.

cost pode ser apenas de um dos tipos a seguir:
amount

Money
amount_range

MoneyRange

FeeType

[START fee_type_definition]

Tipos enumerados
FEE_TYPE_UNSPECIFIED O valor de enumeração UNSPECIFIED ou padrão não deve ser usado em feeds.
FEE_TYPE_FIXED
FEE_TYPE_VARIABLE

FeeUnit

[START fee_unit_definition]

Tipos enumerados
FEE_UNIT_UNSPECIFIED O valor de enumeração UNSPECIFIED ou padrão não deve ser usado em feeds.
FEE_UNIT_PER_GUEST
FEE_UNIT_PER_TRANSACTION

FixedDenominations

Campos
amounts[]

Money

Uma lista de todas as denominações discretas disponíveis (por exemplo, [100, 500, 1000]).

FoodOfferRestrictions

[START food_offer_restrictions_definition]

Campos
meal_types[]

MealType

Os tipos de refeição a que a oferta pode ser aplicada, como almoço ou jantar. Se não for definido, a oferta poderá ser aplicada a todos os tipos de refeição.
restricted_to_certain_courses

bool

Se a oferta só pode ser aplicada a determinados cursos.

GiftCardInfo

[START gift_card_info_definition]

Campos

Campo de união denomination_type.

denomination_type pode ser apenas de um dos tipos a seguir:
fixed_denominations

FixedDenominations

Usado quando o vale-presente está disponível em valores específicos e fixos.
custom_range

MoneyRange

Usado quando a marca permite que os usuários escolham um valor facial personalizado (flexível) dentro de um intervalo definido.

MealType

[START meal_type_definition]

Tipos enumerados
MEAL_TYPE_UNSPECIFIED O valor de enumeração UNSPECIFIED ou padrão não deve ser usado em 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] Próxima tag: 26

Campos
offer_id

string

ID exclusivo da oferta. Obrigatório.
entity_ids[]

string

Lista de comerciantes que estão participando desta oferta.
add_on_offer_applicable_to_all_entities

bool

Se for verdadeiro, essa oferta será aplicável a todas as entidades do agregador. Aplicável somente a ofertas de complementos.
offer_source

OfferSource

Uma oferta pode ser fornecida pelo agregador, por um comerciante individual ou até mesmo por um terceiro como um complemento. Obrigatório.
action_type

ActionType

O serviço que está oferecendo a promoção. Um offer_id só pode pertencer a um action_type. Se uma oferta puder ser compartilhada em vários tipos de serviço, ofertas duplicadas com IDs exclusivos serão criadas para cada tipo de serviço. Obrigatório.
offer_modes[]

OfferMode

Os métodos de aproveitamento da oferta: sem agendamento, reserva, on-line etc. Obrigatório.
offer_category

OfferCategory

A categoria da oferta. Obrigatório.
source_assigned_priority

int32

Número inteiro não negativo ([1 a 100], em que 1 representa a prioridade mais alta) que indica o nível de prioridade da oferta atribuída pela fonte. Quando várias ofertas estão disponíveis para o mesmo comerciante, isso é um indicador para a classificação delas. "0" representa que a prioridade não está definida.
offer_details

OfferDetails

Detalhes da oferta, como desconto, custo da reserva etc. Obrigatório.
offer_restrictions

OfferRestrictions

Descreve como a oferta é restrita, ou seja, se uma assinatura/instrumento de pagamento é necessária, se ela pode ser combinada com outras ofertas (e quais tipos), etc. Obrigatório.
coupon

Coupon

Detalhes de um cupom. Obrigatório para offer_category: OFFER_CATEGORY_ADD_ON_COUPON_OFFER.
payment_instrument

PaymentInstrument

Detalhes de um instrumento de pagamento. Obrigatório para offer_category: OFFER_CATEGORY_ADD_ON_PAYMENT_OFFER.
subscription

Subscription

Detalhes de uma assinatura. Obrigatório para offer_category: OFFER_CATEGORY_ADD_ON_SUBSCRIPTION_OFFER.
terms

Terms

Termos e Condições da oferta. Obrigatório.
validity_periods[]

ValidityPeriod

O período de validade da oferta. Descreve o período em que a oferta é válida, incluindo horários de início e término, dias da semana etc. Obrigatório.
offer_url

string

URL da página de oferta do comerciante. Obrigatório para offer_category: OFFER_CATEGORY_BASE_OFFER.
image_url

string

URL da imagem da oferta do comerciante.
tags[]

OfferTag

Tags especiais associadas à oferta. Usado para identificar ofertas especiais, como "Festivo", "Mais avaliado", "Mais reservado" etc.
brand_id

string

Obrigatório para ofertas de vale-presente para identificar a marca que oferece a oferta.

OfferCategory

[START offer_category_definition] Categoria da oferta. Uma oferta básica é uma oferta padrão disponível para todos os clientes, como 10% de desconto em gastos acima de US $100. Uma oferta básica restrita por um cupom ou instrumento de pagamento terá os respectivos campos definidos. Também temos ofertas de complementos, como ADD_ON_PAYMENT_OFFER. Essas ofertas podem ser combinadas com outras para ganhar mais descontos.

Tipos enumerados
OFFER_CATEGORY_UNSPECIFIED O valor de enumeração UNSPECIFIED ou padrão não deve ser usado em 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] Próxima tag: 15

Campos
offer_display_text

string

O texto da oferta que o provedor quer mostrar aos clientes na página de resultados da pesquisa. Obrigatório.
max_discount_value

Money

O desconto máximo que pode ser aproveitado. Por exemplo, 10% de desconto em até R $100.
min_spend_value

Money

O valor mínimo de gasto para aproveitar o desconto. Por exemplo, 10% de desconto quando o preço total for de US $100 ou mais.
booking_cost

Money

O custo para reservar esta oferta. Por exemplo, US$ 100 de desconto na conta final quando uma mesa é reservada ao custo de US $15.
booking_cost_unit

FeeUnit

A unidade do custo da reserva. Por exemplo, por pessoa, por transação.
convenience_fee

Fee
booking_cost_adjustable

bool

Se o custo da reserva é ajustável, ou seja, se ele é subtraído da fatura final. Por exemplo: 30% de desconto no jantar com reserva. O custo para reservar é de US $15, que será aplicado à fatura final. Portanto, a fatura final é: Total gasto - 30% - US$ 15
additional_fees[]

AdditionalFee

Taxas extras cobradas do usuário. Exemplos: conveniência, manuseio, entrega, embalagem, taxa de serviço etc.
gift_card_info

GiftCardInfo

Detalhes específicos para ofertas de vale-presente.
Campo de união offer_specification. O desconto pode ser uma porcentagem ou um valor fixo subtraído do valor total. Por exemplo: 1. 10% de desconto na fatura final. 2. US$ 15 de desconto em um pedido. Os comerciantes também podem oferecer descontos personalizados, como "compre um e ganhe outro sem custo financeiro", usando os campos de especificação relevantes. Obrigatório. offer_specification pode ser apenas de um dos tipos a seguir:
discount_percent

float

Porcentagem da fatura com desconto. [0, 100] Para ofertas de 1+1 ou 50% de desconto aplicáveis a toda a refeição (por exemplo, buffet 1+1, 1+1 na conta inteira, 1+1 no menu fixo), esse valor pode ser definido como 50.
discount_value

Money

Valor fixo do desconto.
other_offer_detail_text

string

Texto em formato livre para descrever o desconto. Para ofertas específicas de 1+1 (por exemplo, 1+1 bebidas, +1 prato principal, 1+1 itens selecionados do menu), esses detalhes devem ser descritos aqui.

OfferMode

[START offer_mode_definition] Especifica o método ou canal pelo qual o usuário pode aproveitar a oferta.

Tipos enumerados
OFFER_MODE_OTHER Usado para métodos de atendimento não cobertos por outros modos específicos.
OFFER_MODE_WALK_IN A oferta está disponível para visitas no local sem reserva prévia.
OFFER_MODE_FREE_RESERVATION A oferta é válida quando um usuário faz uma reserva que não exige uma taxa inicial.
OFFER_MODE_PAID_RESERVATION A oferta é válida quando um usuário faz uma reserva que exige pagamento antecipado.
OFFER_MODE_ONLINE_ORDER A oferta é válida para pedidos feitos em um site ou plataforma digital.
OFFER_MODE_GIFT_CARD_PURCHASE Indica que a compra de um vale-presente é a principal etapa necessária para adquirir a oferta.

OfferRestrictions

[START offer_restrictions_definition] Próxima tag: 11

Campos
combinable_with_other_offers

bool

Se esta oferta pode ser combinada com outras. Quando definido como "true", os parceiros podem especificar com quais ofertas ela pode ser combinada. Se "combinable_offer_categories" e "combinable_offer_ids" estiverem definidos, qualquer oferta que corresponda a uma das condições acima poderá ser combinada.
combinable_offer_categories[]

OfferCategory

Lista de tipos de ofertas que podem ser combinadas com esta. Por exemplo, essa oferta pode ser combinada com outros cupons. Se "combinable_with_other_offers" for verdadeiro e esse campo não estiver definido, todos os tipos poderão ser combinados.
combinable_offer_ids[]

string

Lista de "offer_ids" que podem ser combinados com esta oferta. Algumas ofertas só podem ser combinadas com outros offer_ids específicos (que podem ser considerados ofertas principais). Se "combinable_with_other_offers" for verdadeiro e esse campo não estiver definido, todos os IDs de oferta poderão ser combinados.
inclusions[]

OfferCondition

Lista de condições que precisam ser atendidas para que a oferta seja válida (por exemplo, bebidas não alcoólicas, alimentos).
exclusions[]

OfferCondition

Lista de condições que invalidariam a oferta (por exemplo, buffet, combos e coquetéis).
min_guest

int32

O número mínimo de pessoas necessárias para aproveitar a oferta.
food_offer_restrictions

FoodOfferRestrictions

Restrições específicas para ofertas de alimentos.
special_conditions[]

string

Condições especiais desta oferta que precisam ser mostradas ao usuário. Exemplos: "Válido apenas para pagamento em [área]", "Não aceita pagamentos on-line"

OfferSource

[START offer_source_definition]

Tipos enumerados
OFFER_SOURCE_UNSPECIFIED
OFFER_SOURCE_AGGREGATOR

OfferTag

[START offer_tag_definition]

Tipos enumerados
OFFER_TAG_UNSPECIFIED O valor de enumeração UNSPECIFIED ou padrão não deve ser usado em feeds.
OFFER_TAG_NEW_YEAR_SPECIAL
OFFER_TAG_VALENTINES_SPECIAL

PaymentInstrument

[START payment_instrument_definition]

Campos
items[]

PaymentInstrumentItem

Lista de instrumentos de pagamento que podem ser usados para aproveitar a oferta. Obrigatório.
provider_name

string

Nome do provedor do instrumento de pagamento. Pode ser um parceiro bancário, o nome de um banco etc. Por exemplo: American Express, HDFC, ICICI.

PaymentInstrumentItem

[START payment_instrument_item_definition]

Campos
type

PaymentInstrumentType

Tipo do instrumento de pagamento. Obrigatório.
name

string

Nome do item do instrumento de pagamento, como o nome do cartão de crédito. Por exemplo: HDFC Infinia, American Express Platinum. Obrigatório.

PaymentInstrumentType

[START payment_instrument_type_definition]

Tipos enumerados
PAYMENT_INSTRUMENT_TYPE_UNSPECIFIED O valor de enumeração UNSPECIFIED ou padrão não deve ser usado em feeds.
PAYMENT_INSTRUMENT_CREDIT_CARD
PAYMENT_INSTRUMENT_DEBIT_CARD
PAYMENT_INSTRUMENT_BANK_ACCOUNT
PAYMENT_INSTRUMENT_UPI
PAYMENT_INSTRUMENT_ONLINE_WALLET
PAYMENT_INSTRUMENT_NETBANKING

Assinatura

[START subscription_definition]

Campos
name

string

O nome da assinatura. Obrigatório.
subscription_auto_added

bool

Indica se a assinatura é adicionada automaticamente quando um usuário aproveita esta oferta.
cost

Money

O custo da assinatura. Obrigatório.
subscription_duration

Duration

Por quanto tempo a assinatura é válida no subscription_cost. Obrigatório.
terms_and_conditions_url

string

URL dos termos e condições do parceiro relevantes para esta assinatura.

Termos

[START terms_definition]

Campos
url

string

URL dos Termos e Condições do parceiro.
restricted_to_certain_users

bool

Se a oferta é restrita a determinados usuários.
terms_and_conditions

string

Texto principal dos Termos e Condições fornecido pelo parceiro.
additional_terms_and_conditions[]

string

Termos e condições além dos T&C principais do parceiro.