Package madden.ingestion.offer

Indeks

ActionType

[START action_type_definition] Określa tryb realizacji oferty. Jeśli oferta może być udostępniana w kilku trybach realizacji, należy utworzyć zduplikowane oferty dla każdego trybu realizacji.

Wartości w polu enum
ACTION_TYPE_UNSPECIFIED
ACTION_TYPE_FOOD_DELIVERY Oferta dotyczy usług dostawy jedzenia.
ACTION_TYPE_FOOD_TAKEOUT Oferta dotyczy zamówień jedzenia na wynos lub z odbiorem.
ACTION_TYPE_DINING Oferta dotyczy posiłków w restauracji na terenie obiektu.
ACTION_TYPE_SHOPPING_IN_STORE Oferta dotyczy zakupów w sklepie stacjonarnym.

AdditionalFee

[START additional_fee_definition]

Pola
name

string

Nazwa dodatkowej opłaty. Przykłady: opłata za przetworzenie płatności, opłata manipulacyjna itp. Wymagane.
fee

Fee

Kupon

[START coupon_definition]

Pola
text

string

Tekst kuponu, który dostawca oferty chce wyświetlać użytkownikom.
code

string

Aby skorzystać z oferty, musisz użyć kodu kuponu. Wymagane.

Opłata

[START fee_definition] Next ID: 5

Pola
unit

FeeUnit
type

FeeType

Pole zbiorcze cost.

Pole cost może mieć tylko jedną z tych wartości:
amount

Money
amount_range

MoneyRange

FeeType

[START fee_type_definition]

Wartości w polu enum
FEE_TYPE_UNSPECIFIED W plikach danych nie należy używać wartości wyliczeniowej UNSPECIFIED ani domyślnej.
FEE_TYPE_FIXED
FEE_TYPE_VARIABLE

FeeUnit

[START fee_unit_definition]

Wartości w polu enum
FEE_UNIT_UNSPECIFIED W plikach danych nie należy używać wartości wyliczeniowej UNSPECIFIED ani domyślnej.
FEE_UNIT_PER_GUEST
FEE_UNIT_PER_TRANSACTION

FixedDenominations

Pola
amounts[]

Money

Lista wszystkich dostępnych nominałów (np. [100, 500, 1000]).

FoodOfferRestrictions

[START food_offer_restrictions_definition]

Pola
meal_types[]

MealType

Rodzaje posiłków, do których można zastosować ofertę, np. lunch lub kolacja. Jeśli nie zostanie ustawiony, oferta może być zastosowana do wszystkich rodzajów posiłków.
restricted_to_certain_courses

bool

Czy oferta może być zastosowana tylko do niektórych kursów.

GiftCardInfo

[START gift_card_info_definition]

Pola

Pole zbiorcze denomination_type.

Pole denomination_type może mieć tylko jedną z tych wartości:
fixed_denominations

FixedDenominations

Używane, gdy karta podarunkowa jest dostępna w określonych, stałych kwotach.
custom_range

MoneyRange

Używane, gdy marka umożliwia użytkownikom wybór niestandardowej (elastycznej) wartości nominalnej w określonym zakresie.

MealType

[START meal_type_definition]

Wartości w polu enum
MEAL_TYPE_UNSPECIFIED W plikach danych nie należy używać wartości wyliczeniowej UNSPECIFIED ani domyślnej.
MEAL_TYPE_BREAKFAST
MEAL_TYPE_LUNCH
MEAL_TYPE_DINNER

MoneyRange

[START money_range_definition]

Pola
min_amount

Money
max_amount

Money

Oferta

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

Pola
offer_id

string

Unikalny identyfikator oferty. Wymagane.
entity_ids[]

string

Lista sprzedawców, którzy biorą udział w tej ofercie.
add_on_offer_applicable_to_all_entities

bool

Jeśli wartość to prawda, oferta dotyczy wszystkich podmiotów należących do agregatora. Dotyczy tylko ofert dodatkowych.
offer_source

OfferSource

Oferta może być dostarczana przez pośrednika, pojedynczego sprzedawcę lub nawet osobę trzecią jako dodatek. Wymagane.
action_type

ActionType

Usługa, która udostępnia ofertę. Identyfikator offer_id może należeć tylko do jednego typu działania. Jeśli oferta może być udostępniana w ramach wielu typów usług, dla każdego z nich należy utworzyć zduplikowane oferty z unikalnymi identyfikatorami. Wymagane.
offer_modes[]

OfferMode

Metody skorzystania z oferty – wizyta bez rezerwacji, rezerwacja, online itp. Wymagane.
offer_category

OfferCategory

Kategoria oferty. Wymagane.
source_assigned_priority

int32

Nieujemna liczba całkowita ([1–100], gdzie 1 oznacza najwyższy priorytet) wskazująca poziom priorytetu oferty przypisany przez źródło. Gdy dla tego samego sprzedawcy dostępnych jest wiele ofert, będzie to sygnał do określania rankingu ofert. Wartość 0 oznacza, że priorytet nie jest ustawiony.
offer_details

OfferDetails

Szczegóły oferty, takie jak rabat, koszt rezerwacji itp. Wymagane.
offer_restrictions

OfferRestrictions

Opisuje ograniczenia oferty, np. czy wymagana jest subskrypcja lub instrument płatniczy, czy ofertę można łączyć z innymi ofertami (i jakimi), itp. Wymagany.
coupon

Coupon

Szczegóły kuponu. Wymagany w przypadku atrybutu offer_category: OFFER_CATEGORY_ADD_ON_COUPON_OFFER.
payment_instrument

PaymentInstrument

Szczegóły instrumentu płatniczego. Wymagany w przypadku atrybutu offer_category: OFFER_CATEGORY_ADD_ON_PAYMENT_OFFER.
subscription

Subscription

Szczegóły subskrypcji. Wymagany w przypadku atrybutu offer_category: OFFER_CATEGORY_ADD_ON_SUBSCRIPTION_OFFER.
terms

Terms

Warunki oferty. Wymagane.
validity_periods[]

ValidityPeriod

Okres ważności oferty. Opisuje okres, w którym oferta jest ważna, w tym godziny rozpoczęcia i zakończenia, dni tygodnia itp. Wymagany.
offer_url

string

Adres URL strony oferty sprzedawcy. Wymagany w przypadku atrybutu offer_category: OFFER_CATEGORY_BASE_OFFER.
image_url

string

Adres URL obrazu oferty sprzedawcy.
tags[]

OfferTag

Tagi specjalne powiązane z ofertą. Służy do identyfikowania ofert specjalnych, takich jak „Świąteczna”, „Najwyżej oceniana”, „Najczęściej rezerwowana” itp.
brand_id

string

Wymagany w przypadku ofert dotyczących kart podarunkowych, aby zidentyfikować markę oferującą daną ofertę.

OfferCategory

[START offer_category_definition] Kategoria oferty. Oferta podstawowa to standardowa oferta dostępna dla wszystkich klientów, np. 10% rabatu na wydatki powyżej 100 PLN. Oferta podstawowa ograniczona kuponem lub instrumentem płatniczym będzie miała ustawione odpowiednie pola. Mamy też oferty dodatkowe, np. ADD_ON_PAYMENT_OFFER. Takie oferty można łączyć z innymi, aby uzyskać dodatkowe rabaty.

Wartości w polu enum
OFFER_CATEGORY_UNSPECIFIED W plikach danych nie należy używać wartości wyliczeniowej UNSPECIFIED ani domyślnej.
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]

Pola
description

string

OfferDetails

[START offer_details_definition] Następny tag: 15

Pola
offer_display_text

string

Tekst oferty, który dostawca chce wyświetlać klientom na stronie wyników wyszukiwania. Wymagane.
max_discount_value

Money

Maksymalna zniżka, z której można skorzystać. Na przykład rabat 10% do 100 PLN.
min_spend_value

Money

Minimalna wartość wydatków, aby skorzystać ze zniżki. Na przykład 10% zniżki, gdy łączna cena wynosi co najmniej 100 PLN.
booking_cost

Money

Koszt rezerwacji tej oferty. Na przykład 100 zł zniżki na rachunek końcowy, gdy stolik zostanie zarezerwowany za 15 zł.
booking_cost_unit

FeeUnit

Jednostka kosztu rezerwacji. np. na osobę lub na transakcję.
convenience_fee

Fee
booking_cost_adjustable

bool

Czy koszt rezerwacji można odliczyć, tzn. czy koszt rezerwacji jest odejmowany od rachunku końcowego. Na przykład: 30% taniej na kolację po dokonaniu rezerwacji. Koszt rezerwacji wynosi 15 USD i zostanie odliczony od ostatecznej płatności. Ostateczny rachunek: wydana kwota – 30% – 15 PLN
additional_fees[]

AdditionalFee

Dodatkowe opłaty pobierane od użytkownika. Przykłady: opłata za wygodę, opłata manipulacyjna, opłata za dostawę, opłata za opakowanie, opłata za obsługę itp.
gift_card_info

GiftCardInfo

Szczegóły dotyczące ofert kart podarunkowych.
Pole zbiorcze offer_specification. Rabat może być wyrażony w procentach lub jako stała wartość odjęta od łącznej wartości. Przykład: 1. 10% zniżki na rachunek końcowy. 2. 15 USD zniżki na zamówienie. Sprzedawcy mogą też oferować rabaty niestandardowe, np. „kup jeden produkt, a drugi otrzymasz bezpłatnie”, za pomocą odpowiednich pól specyfikacji. Wymagane. offer_specification może mieć tylko jedną z tych wartości:
discount_percent

float

Procent rachunku, który jest objęty rabatem. [0, 100] W przypadku ofert typu 1+1 lub 50% zniżki na cały posiłek (np. 1+1 na bufet, 1+1 na cały rachunek, 1+1 na zestaw) tę wartość można ustawić na 50.
discount_value

Money

Stała wartość rabatu.
other_offer_detail_text

string

Dowolny tekst opisujący rabat. W przypadku konkretnych ofert 1+1 (np. 1+1 napoje, +1 danie główne, 1+1 wybrane pozycje w menu) należy podać tutaj szczegóły.

OfferMode

[START offer_mode_definition] Określa metodę lub kanał, za pomocą którego użytkownik może skorzystać z oferty.

Wartości w polu enum
OFFER_MODE_OTHER Używaj w przypadku metod realizacji zamówień, których nie obejmują inne tryby.
OFFER_MODE_WALK_IN Oferta jest dostępna w przypadku wizyt w obiekcie bez wcześniejszej rezerwacji.
OFFER_MODE_FREE_RESERVATION Oferta obowiązuje, gdy użytkownik dokona rezerwacji, która nie wymaga opłaty z góry.
OFFER_MODE_PAID_RESERVATION Oferta obowiązuje, gdy użytkownik dokona rezerwacji, która wymaga płatności z góry.
OFFER_MODE_ONLINE_ORDER Oferta jest ważna w przypadku zamówień złożonych za pomocą witryny lub platformy cyfrowej.
OFFER_MODE_GIFT_CARD_PURCHASE Wskazuje, że zakup karty podarunkowej jest głównym krokiem wymaganym do skorzystania z oferty.

OfferRestrictions

[START offer_restrictions_definition] Następny tag: 11

Pola
combinable_with_other_offers

bool

Czy tę ofertę można łączyć z innymi ofertami. Jeśli ta wartość jest prawdziwa, partnerzy mogą określić, z jakimi ofertami można łączyć tę ofertę. Jeśli ustawione są zarówno combinable_offer_categories, jak i combinable_offer_ids, każda oferta spełniająca jeden z powyższych warunków będzie mogła być łączona.
combinable_offer_categories[]

OfferCategory

Lista typów ofert, z którymi można połączyć tę ofertę. Na przykład tę ofertę można łączyć z innymi kuponami. Jeśli wartość combinable_with_other_offers to „true”, a to pole nie jest ustawione, wszystkie typy będą mogły być łączone.
combinable_offer_ids[]

string

Lista identyfikatorów ofert, z którymi można połączyć tę ofertę. Niektóre oferty można łączyć tylko z określonymi identyfikatorami innych ofert (można je uznać za oferty nadrzędne). Jeśli wartość combinable_with_other_offers to „true”, a to pole nie jest ustawione, wszystkie identyfikatory ofert będzie można łączyć.
inclusions[]

OfferCondition

Lista warunków, które muszą być spełnione, aby oferta była ważna (np. napoje bezalkoholowe, jedzenie).
exclusions[]

OfferCondition

Lista warunków, które unieważniają ofertę (np. bufet, oferty łączone i koktajle).
min_guest

int32

Minimalna liczba osób wymagana do skorzystania z oferty.
food_offer_restrictions

FoodOfferRestrictions

Ograniczenia dotyczące ofert żywności.
special_conditions[]

string

Specjalne warunki tej oferty, które muszą być wyświetlane użytkownikowi. Przykłady: „Tylko w przypadku płatności w [obszar]”, „Nie obejmuje płatności online”.

OfferSource

[START offer_source_definition]

Wartości w polu enum
OFFER_SOURCE_UNSPECIFIED
OFFER_SOURCE_AGGREGATOR

OfferTag

[START offer_tag_definition]

Wartości w polu enum
OFFER_TAG_UNSPECIFIED W plikach danych nie należy używać wartości wyliczeniowej UNSPECIFIED ani domyślnej.
OFFER_TAG_NEW_YEAR_SPECIAL
OFFER_TAG_VALENTINES_SPECIAL

PaymentInstrument

[START payment_instrument_definition]

Pola
items[]

PaymentInstrumentItem

Lista instrumentów płatniczych, których można użyć, aby skorzystać z oferty. Wymagane.
provider_name

string

Nazwa dostawcy instrumentu płatniczego. Może to być partner bankowy, nazwa banku itp. Na przykład: American Express, HDFC, ICICI.

PaymentInstrumentItem

[START payment_instrument_item_definition]

Pola
type

PaymentInstrumentType

Rodzaj instrumentu płatniczego. Wymagane.
name

string

Nazwa elementu instrumentu płatniczego, np. nazwa karty kredytowej. Na przykład: HDFC Infinia, American Express Platinum. Wymagane.

PaymentInstrumentType

[START payment_instrument_type_definition]

Wartości w polu enum
PAYMENT_INSTRUMENT_TYPE_UNSPECIFIED W plikach danych nie należy używać wartości wyliczeniowej UNSPECIFIED ani domyślnej.
PAYMENT_INSTRUMENT_CREDIT_CARD
PAYMENT_INSTRUMENT_DEBIT_CARD
PAYMENT_INSTRUMENT_BANK_ACCOUNT
PAYMENT_INSTRUMENT_UPI
PAYMENT_INSTRUMENT_ONLINE_WALLET
PAYMENT_INSTRUMENT_NETBANKING

Subskrypcja

[START subscription_definition]

Pola
name

string

Nazwa subskrypcji. Wymagane.
subscription_auto_added

bool

Czy subskrypcja jest dodawana automatycznie, gdy użytkownik skorzysta z tej oferty.
cost

Money

Koszt subskrypcji. Wymagane.
subscription_duration

Duration

Jak długo subskrypcja jest ważna w przypadku kosztu abonamentu. Wymagane.
terms_and_conditions_url

string

Adres URL warunków partnera dotyczących tej subskrypcji.

Warunki

[START terms_definition]

Pola
url

string

Adres URL warunków partnera.
restricted_to_certain_users

bool

Czy oferta jest ograniczona do określonych użytkowników.
terms_and_conditions

string

Główny tekst warunków dostarczony przez partnera.
additional_terms_and_conditions[]

string

Warunki dodatkowe do głównych warunków partnera.