Package madden.ingestion.offer

Index

ActionType

[START action_type_definition] Stellt den Erfüllungsmodus des Angebots dar. Wenn ein Angebot für mehrere Fulfillment-Modi freigegeben werden kann, müssen für jeden Fulfillment-Modus doppelte Angebote erstellt werden.

Enums
ACTION_TYPE_UNSPECIFIED
ACTION_TYPE_FOOD_DELIVERY Das Angebot gilt für Lieferservices für Lebensmittel.
ACTION_TYPE_FOOD_TAKEOUT Das Angebot gilt für Bestellungen von Speisen zum Mitnehmen oder zur Abholung.
ACTION_TYPE_DINING Das Angebot gilt für das Essen vor Ort in einem Restaurant.
ACTION_TYPE_SHOPPING_IN_STORE Das Angebot gilt für Offline- und Ladenkäufe.

AdditionalFee

[START additional_fee_definition]

Felder
name

string

Der Name der zusätzlichen Gebühr. Beispiele: Zahlungsgebühr, Bearbeitungsgebühr usw. Erforderlich.

fee

Fee

Gutschein

[START coupon_definition]

Felder
text

string

Der Gutscheintext, den der Angebotsanbieter Nutzern präsentieren möchte.

code

string

Zum Einlösen des Angebots ist ein Gutscheincode erforderlich. Erforderlich.

Gebühr

[START fee_definition] Nächste ID: 5

Felder
unit

FeeUnit

type

FeeType

Union-Feld cost.

Für cost ist nur einer der folgenden Werte zulässig:

amount

Money

amount_range

MoneyRange

FeeType

[START fee_type_definition]

Enums
FEE_TYPE_UNSPECIFIED Der UNSPECIFIED- oder Standard-Enum-Wert sollte nicht in Feeds verwendet werden.
FEE_TYPE_FIXED
FEE_TYPE_VARIABLE

FeeUnit

[START fee_unit_definition]

Enums
FEE_UNIT_UNSPECIFIED Der UNSPECIFIED- oder Standard-Enum-Wert sollte nicht in Feeds verwendet werden.
FEE_UNIT_PER_GUEST
FEE_UNIT_PER_TRANSACTION

FixedDenominations

Felder
amounts[]

Money

Eine Liste aller verfügbaren diskreten Beträge (z.B. [100, 500, 1000]).

FoodOfferRestrictions

[START food_offer_restrictions_definition]

Felder
meal_types[]

MealType

Die Mahlzeitentypen, auf die das Angebot angewendet werden kann, z. B. Mittag- oder Abendessen. Wenn nicht festgelegt, kann das Angebot auf alle Mahlzeitentypen angewendet werden.

restricted_to_certain_courses

bool

Gibt an, ob das Angebot nur auf bestimmte Kurse angewendet werden kann.

GiftCardInfo

[START gift_card_info_definition]

Felder

Union-Feld denomination_type.

Für denomination_type ist nur einer der folgenden Werte zulässig:

fixed_denominations

FixedDenominations

Wird verwendet, wenn die Geschenkkarte in bestimmten, festen Beträgen verfügbar ist.

custom_range

MoneyRange

Wird verwendet, wenn die Marke es Nutzern erlaubt, einen benutzerdefinierten (flexiblen) Nennwert innerhalb eines definierten Bereichs auszuwählen.

MealType

[START meal_type_definition]

Enums
MEAL_TYPE_UNSPECIFIED Der UNSPECIFIED- oder Standard-Enum-Wert sollte nicht in Feeds verwendet werden.
MEAL_TYPE_BREAKFAST
MEAL_TYPE_LUNCH
MEAL_TYPE_DINNER

MoneyRange

[START money_range_definition]

Felder
min_amount

Money

max_amount

Money

Angebot

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

Felder
offer_id

string

Eindeutige ID des Angebots. Erforderlich.

entity_ids[]

string

Liste der Händler, die an diesem Angebot teilnehmen.

add_on_offer_applicable_to_all_entities

bool

Wenn „true“, gilt dieses Angebot für alle Rechtssubjekte unter dem Aggregator. Gilt nur für Add-on-Angebote.

offer_source

OfferSource

Ein Angebot kann vom Aggregator, einem einzelnen Händler oder sogar von einem Drittanbieter als Add-on bereitgestellt werden. Erforderlich.

action_type

ActionType

Der Dienst, der das Angebot bereitstellt. Eine offer_id kann nur zu einem action_type gehören. Wenn ein Angebot für mehrere Diensttypen freigegeben werden kann, müssen für jeden Diensttyp doppelte Angebote mit eindeutigen IDs erstellt werden. Erforderlich.

offer_modes[]

OfferMode

Die Methoden, mit denen das Angebot genutzt werden kann – z. B. ohne Reservierung, mit Reservierung, online usw. Erforderlich.

offer_category

OfferCategory

Die Kategorie des Angebots. Erforderlich.

source_assigned_priority

int32

Nicht negative Ganzzahl ([1–100], wobei 1 die höchste Priorität darstellt), die das von der Quelle zugewiesene Prioritätsniveau des Angebots angibt. Wenn mehrere Angebote für denselben Händler verfügbar sind, ist dies ein Signal für das Ranking von Angeboten. Der Wert 0 gibt an, dass die Priorität nicht festgelegt ist.

offer_details

OfferDetails

Details zum Angebot, z. B. Rabatt, Buchungskosten usw. Erforderlich.

offer_restrictions

OfferRestrictions

Beschreibt, wie das Angebot eingeschränkt ist, z.B. ob ein Abo oder Zahlungsmittel erforderlich ist, ob dieses Angebot mit anderen Angeboten kombiniert werden kann (und mit welchen Typen) usw. Erforderlich.

coupon

Coupon

Details zu einem Gutschein. Erforderlich für offer_category: OFFER_CATEGORY_ADD_ON_COUPON_OFFER.

payment_instrument

PaymentInstrument

Details zu einem Zahlungsmittel. Erforderlich für offer_category: OFFER_CATEGORY_ADD_ON_PAYMENT_OFFER.

subscription

Subscription

Details eines Abos. Erforderlich für offer_category: OFFER_CATEGORY_ADD_ON_SUBSCRIPTION_OFFER.

terms

Terms

Nutzungsbedingungen des Angebots. Erforderlich.

validity_periods[]

ValidityPeriod

Der Gültigkeitszeitraum des Angebots. Beschreibt den Zeitraum, für den das Angebot gilt, einschließlich Start- und Endzeit, Wochentage usw. Erforderlich.

offer_url

string

URL zur Angebotsseite des Händlers. Erforderlich für offer_category: OFFER_CATEGORY_BASE_OFFER.

image_url

string

URL zum Angebotsbild des Händlers.

tags[]

OfferTag

Spezielle Tags, die mit dem Angebot verknüpft sind. Damit werden Sonderangebote wie „Festlich“, „Bestseller“ oder „Am häufigsten gebucht“ identifiziert.

brand_id

string

Erforderlich für Geschenkkartenangebote, um die Marke zu identifizieren, die das Angebot anbietet.

OfferCategory

[START offer_category_definition] Kategorie des Angebots. Ein Basisangebot ist ein Standardangebot, das allen Kunden zur Verfügung steht, z. B. 10% Rabatt auf Ausgaben über 100 $. Bei einem Basisangebot, das durch einen Gutschein oder ein Zahlungsmittel eingeschränkt ist, sind die entsprechenden Felder festgelegt. Außerdem haben wir Add-on-Angebote wie ADD_ON_PAYMENT_OFFER. Solche Angebote können zu anderen Angeboten hinzugefügt werden, um zusätzliche Rabatte zu erhalten.

Enums
OFFER_CATEGORY_UNSPECIFIED Der UNSPECIFIED- oder Standard-Enum-Wert sollte nicht in Feeds verwendet werden.
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]

Felder
description

string

OfferDetails

[START offer_details_definition] Nächstes Tag: 15

Felder
offer_display_text

string

Der Angebotstext, den der Angebotsanbieter Kunden auf der Suchergebnisseite präsentieren möchte. Erforderlich.

max_discount_value

Money

Der maximale Rabatt, der in Anspruch genommen werden kann. Beispiel: 10% Rabatt auf bis zu 100 $.

min_spend_value

Money

Der Mindestbetrag, der ausgegeben werden muss, um den Rabatt zu erhalten. Beispiel: 10% Rabatt ab einem Gesamtpreis von 100 $.

booking_cost

Money

Die Kosten für die Buchung dieses Angebots. Beispiel: 100 $ Rabatt auf die Endabrechnung, wenn ein Tisch für 15 $reserviert wird.

booking_cost_unit

FeeUnit

Die Einheit der Buchungskosten. Zum Beispiel pro Person und pro Transaktion.

convenience_fee

Fee

booking_cost_adjustable

bool

Gibt an, ob die Buchungskosten anpassbar sind, d.h., ob sie von der Endabrechnung abgezogen werden. Beispiel: 30% Rabatt auf das Abendessen mit Reservierung. Die Reservierung kostet 15 $, die auf die endgültige Rechnung angerechnet werden. Die endgültige Rechnung sieht also so aus: Gesamtausgaben – 30 % – 15 $

additional_fees[]

AdditionalFee

Zusätzliche Gebühren, die dem Nutzer in Rechnung gestellt werden. Beispiele: Gebühren für Komfort, Bearbeitung, Lieferung, Verpackung, Service usw.

gift_card_info

GiftCardInfo

Details speziell für Geschenkkartenangebote.

Union-Feld offer_specification. Der Rabatt kann ein Prozentsatz oder ein fester Wert sein, der vom Gesamtwert abgezogen wird. Beispiel: 1. 10% Rabatt auf die Endabrechnung. 2. 15 $ Rabatt auf eine Bestellung. Händler können auch benutzerdefinierte Rabatte wie „Zwei zum Preis von einem“ über die entsprechenden Spezifikationsfelder anbieten. Erforderlich. Für offer_specification ist nur einer der folgenden Werte zulässig:
discount_percent

float

Prozentsatz der Rechnung, auf den ein Rabatt gewährt wird. [0, 100] Bei 1+1- oder 50 %-Rabattangeboten, die für das gesamte Menü gelten (z.B. 1+1-Buffet, 1+1 auf die gesamte Rechnung, 1+1 auf das Menü), kann dieser Wert auf 50 festgelegt werden.

discount_value

Money

Fester Wert des Rabatts.

other_offer_detail_text

string

Freitext zur Beschreibung des Rabatts. Bei bestimmten 1+1-Angeboten (z.B. 1+1 Getränke, +1 Hauptgericht, 1+1 ausgewählte Menüpunkte) sollten diese Details hier beschrieben werden.

OfferMode

[START offer_mode_definition] Gibt die Methode oder den Channel an, über die bzw. den der Nutzer das Angebot in Anspruch nehmen kann.

Enums
OFFER_MODE_OTHER Für Erfüllungsmethoden, die nicht von anderen spezifischen Modi abgedeckt werden.
OFFER_MODE_WALK_IN Das Angebot ist für Besuche vor Ort ohne vorherige Reservierung verfügbar.
OFFER_MODE_FREE_RESERVATION Das Angebot gilt, wenn ein Nutzer eine Reservierung vornimmt, für die keine Vorauszahlung erforderlich ist.
OFFER_MODE_PAID_RESERVATION Das Angebot gilt, wenn ein Nutzer eine Reservierung vornimmt, für die eine Vorauszahlung erforderlich ist.
OFFER_MODE_ONLINE_ORDER Das Angebot gilt für Bestellungen, die über eine Website oder digitale Plattform aufgegeben werden.
OFFER_MODE_GIFT_CARD_PURCHASE Gibt an, dass der Kauf einer Geschenkkarte der primäre Schritt ist, der zum Erhalt des Angebots erforderlich ist.

OfferRestrictions

[START offer_restrictions_definition] Nächstes Tag: 11

Felder
combinable_with_other_offers

bool

Ob dieses Angebot mit anderen Angeboten kombiniert werden kann. Wenn „true“, können Partner angeben, mit welchen Angeboten dieses Angebot kombiniert werden kann. Wenn sowohl „combinable_offer_categories“ als auch „combinable_offer_ids“ festgelegt sind, ist jedes Angebot, das einer der oben genannten Bedingungen entspricht, kombinierbar.

combinable_offer_categories[]

OfferCategory

Liste der Angebotstypen, mit denen dieses Angebot kombiniert werden kann. Dieses Angebot kann beispielsweise mit anderen Gutscheinen kombiniert werden. Wenn „combinable_with_other_offers“ auf „true“ gesetzt ist und dieses Feld nicht festgelegt ist, können alle Typen kombiniert werden.

combinable_offer_ids[]

string

Liste der offer_ids, mit denen dieses Angebot kombiniert werden kann. Einige Angebote können nur mit bestimmten anderen offer_ids (übergeordnete Angebote) kombiniert werden. Wenn „combinable_with_other_offers“ auf „true“ gesetzt ist und dieses Feld nicht festgelegt ist, können alle Angebots-IDs kombiniert werden.

inclusions[]

OfferCondition

Liste der Bedingungen, die erfüllt sein müssen, damit das Angebot gültig ist (z.B. alkoholfreie Getränke, Speisen).

exclusions[]

OfferCondition

Liste der Bedingungen, die das Angebot ungültig machen (z.B. Buffet, Kombiangebote und Cocktails).

min_guest

int32

Die Mindestanzahl an Personen, die erforderlich ist, um das Angebot in Anspruch zu nehmen.

food_offer_restrictions

FoodOfferRestrictions

Einschränkungen für Essensangebote

special_conditions[]

string

Besondere Bedingungen für dieses Angebot, die dem Nutzer angezeigt werden müssen. Beispiele: „Nur gültig für Zahlungen in [Bereich]“, „Gilt nicht für Onlinezahlungen“

OfferSource

[START offer_source_definition]

Enums
OFFER_SOURCE_UNSPECIFIED
OFFER_SOURCE_AGGREGATOR

OfferTag

[START offer_tag_definition]

Enums
OFFER_TAG_UNSPECIFIED Der UNSPECIFIED- oder Standard-Enum-Wert sollte nicht in Feeds verwendet werden.
OFFER_TAG_NEW_YEAR_SPECIAL
OFFER_TAG_VALENTINES_SPECIAL

PaymentInstrument

[START payment_instrument_definition]

Felder
items[]

PaymentInstrumentItem

Liste der Zahlungsmittel, die für das Angebot verwendet werden können. Erforderlich.

provider_name

string

Name des Anbieters des Zahlungsmittels. Das kann ein Bankpartner oder der Name einer Bank sein, z. B. American Express, HDFC oder ICICI.

PaymentInstrumentItem

[START payment_instrument_item_definition]

Felder
type

PaymentInstrumentType

Typ des Zahlungsmittels. Erforderlich.

name

string

Name des Zahlungsmittels, z. B. der Name der Kreditkarte. Beispiele: HDFC Infinia, American Express Platinum. Erforderlich.

PaymentInstrumentType

[START payment_instrument_type_definition]

Enums
PAYMENT_INSTRUMENT_TYPE_UNSPECIFIED Der UNSPECIFIED- oder Standard-Enum-Wert sollte nicht in Feeds verwendet werden.
PAYMENT_INSTRUMENT_CREDIT_CARD
PAYMENT_INSTRUMENT_DEBIT_CARD
PAYMENT_INSTRUMENT_BANK_ACCOUNT
PAYMENT_INSTRUMENT_UPI
PAYMENT_INSTRUMENT_ONLINE_WALLET
PAYMENT_INSTRUMENT_NETBANKING

Abo

[START subscription_definition]

Felder
name

string

Der Name des Abos. Erforderlich.

subscription_auto_added

bool

Gibt an, ob das Abo automatisch hinzugefügt wird, wenn ein Nutzer dieses Angebot in Anspruch nimmt.

cost

Money

Die Kosten des Abos. Erforderlich.

subscription_duration

Duration

Wie lange das Abo zum angegebenen Abopreis gültig ist. Erforderlich.

terms_and_conditions_url

string

URL zu den für dieses Abo relevanten Nutzungsbedingungen des Partners.

Nutzungsbedingungen

[START terms_definition]

Felder
url

string

URL zu den Nutzungsbedingungen des Partners.

restricted_to_certain_users

bool

Gibt an, ob das Angebot auf bestimmte Nutzer beschränkt ist.

terms_and_conditions

string

Primärer Nutzungsbedingungen-Text, der vom Partner bereitgestellt wird.

additional_terms_and_conditions[]

string

Zusätzliche Nutzungsbedingungen des Partners.