Package madden.ingestion.offer

Index

ActionType

[START action_type_definition] Représente le mode de traitement de l'offre. Si une offre peut être partagée sur plusieurs modes de traitement, des offres en double doivent être créées pour chaque mode de traitement.

Enums
ACTION_TYPE_UNSPECIFIED
ACTION_TYPE_FOOD_DELIVERY L'offre s'applique aux services de livraison de nourriture.
ACTION_TYPE_FOOD_TAKEOUT L'offre s'applique aux commandes de plats à emporter ou à retirer.
ACTION_TYPE_DINING L'offre concerne les repas sur place dans un restaurant.
ACTION_TYPE_SHOPPING_IN_STORE L'offre s'applique aux achats hors ligne effectués en magasin.

AdditionalFee

[START additional_fee_definition]

Champs
name

string

Nom des frais supplémentaires. Exemples : frais de commodité, frais de traitement, etc. Obligatoire.
fee

Fee

Bon de réduction

[START coupon_definition]

Champs
text

string

Texte du bon de réduction que le fournisseur de l'offre souhaite afficher aux utilisateurs.
code

string

Un code promotionnel est requis pour profiter de l'offre. Obligatoire.

Fee

[START fee_definition] Identifiant suivant : 5

Champs
unit

FeeUnit
type

FeeType

Champ d'union cost.

cost ne peut être qu'un des éléments suivants :
amount

Money
amount_range

MoneyRange

FeeType

[START fee_type_definition]

Enums
FEE_TYPE_UNSPECIFIED La valeur d'énumération UNSPECIFIED ou par défaut ne doit pas être utilisée dans les flux.
FEE_TYPE_FIXED
FEE_TYPE_VARIABLE

FeeUnit

[START fee_unit_definition]

Enums
FEE_UNIT_UNSPECIFIED La valeur d'énumération UNSPECIFIED ou par défaut ne doit pas être utilisée dans les flux.
FEE_UNIT_PER_GUEST
FEE_UNIT_PER_TRANSACTION

FixedDenominations

Champs
amounts[]

Money

Liste de toutes les valeurs discrètes disponibles (par exemple, [100, 500, 1000]).

FoodOfferRestrictions

[START food_offer_restrictions_definition]

Champs
meal_types[]

MealType

Types de repas auxquels l'offre peut s'appliquer, comme le déjeuner ou le dîner. Si ce paramètre n'est pas défini, l'offre peut s'appliquer à tous les types de repas.
restricted_to_certain_courses

bool

Indique si l'offre ne peut être appliquée qu'à certains cours.

GiftCardInfo

[START gift_card_info_definition]

Champs

Champ d'union denomination_type.

denomination_type ne peut être qu'un des éléments suivants :
fixed_denominations

FixedDenominations

Utilisé lorsque la carte est disponible pour des montants fixes spécifiques.
custom_range

MoneyRange

Utilisé lorsque la marque permet aux utilisateurs de choisir une valeur faciale personnalisée (flexible) dans une plage définie.

MealType

[START meal_type_definition]

Enums
MEAL_TYPE_UNSPECIFIED La valeur d'énumération UNSPECIFIED ou par défaut ne doit pas être utilisée dans les flux.
MEAL_TYPE_BREAKFAST
MEAL_TYPE_LUNCH
MEAL_TYPE_DINNER

MoneyRange

[START money_range_definition]

Champs
min_amount

Money
max_amount

Money

Offre

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

Champs
offer_id

string

ID unique de l'offre. Obligatoire.
entity_ids[]

string

Liste des marchands participant à cette offre.
add_on_offer_applicable_to_all_entities

bool

Si la valeur est "true", cette offre s'applique à toutes les entités de l'agrégateur. Ne s'applique qu'aux offres de modules complémentaires.
offer_source

OfferSource

Une offre peut être proposée par l'agrégateur, un marchand individuel ou même un tiers en tant que module complémentaire. Obligatoire.
action_type

ActionType

Service qui propose l'offre. Un offer_id ne peut appartenir qu'à un seul action_type. Si une offre peut être partagée entre plusieurs types de services, vous devez créer des offres en double avec des ID uniques pour chaque type de service. Obligatoire.
offer_modes[]

OfferMode

Méthodes pour profiter de l'offre : en magasin, sur réservation, en ligne, etc. Obligatoire.
offer_category

OfferCategory

Catégorie de l'offre. Obligatoire.
source_assigned_priority

int32

Entier non négatif ([1-100], où 1 représente la priorité la plus élevée) indiquant le niveau de priorité de l'offre attribué par la source. Lorsque plusieurs offres sont disponibles pour le même marchand, cela constitue un signal pour le classement des offres. 0 indique que la priorité n'est pas définie.
offer_details

OfferDetails

Détails de l'offre, tels que la remise, le coût de la réservation, etc. Obligatoire.
offer_restrictions

OfferRestrictions

Décrit les restrictions de l'offre (par exemple, si un abonnement ou un instrument de paiement est requis, si cette offre peut être combinée avec d'autres offres (et de quels types), etc.). Obligatoire.
coupon

Coupon

Informations sur un bon de réduction. Obligatoire pour offer_category: OFFER_CATEGORY_ADD_ON_COUPON_OFFER.
payment_instrument

PaymentInstrument

Détails d'un mode de paiement. Obligatoire pour offer_category: OFFER_CATEGORY_ADD_ON_PAYMENT_OFFER.
subscription

Subscription

Détails d'un abonnement. Obligatoire pour offer_category: OFFER_CATEGORY_ADD_ON_SUBSCRIPTION_OFFER.
terms

Terms

Conditions d'utilisation de l'offre. Obligatoire.
validity_periods[]

ValidityPeriod

Période de validité de l'offre. Décrivez la période de validité de l'offre, y compris les heures de début et de fin, les jours de la semaine, etc. Obligatoire.
offer_url

string

URL de la page de l'offre du marchand. Obligatoire pour offer_category: OFFER_CATEGORY_BASE_OFFER.
image_url

string

URL de l'image de l'offre du marchand.
tags[]

OfferTag

Tags spéciaux associés à l'offre. Il permet d'identifier les offres spéciales telles que "Fêtes", "Meilleures notes", "Les plus réservés", etc.
brand_id

string

Obligatoire pour les offres de cartes cadeaux afin d'identifier la marque qui propose l'offre.

OfferCategory

[START offer_category_definition] Catégorie de l'offre. Une offre de base est une offre standard disponible pour tous les clients, par exemple "10 % de remise pour toute dépense supérieure à 100 €". Les champs correspondants seront définis pour une offre de base limitée par un bon de réduction ou un mode de paiement. Nous proposons également des offres de complément, comme ADD_ON_PAYMENT_OFFER. Ces offres peuvent être ajoutées à d'autres offres pour bénéficier de remises supplémentaires.

Enums
OFFER_CATEGORY_UNSPECIFIED La valeur d'énumération UNSPECIFIED ou par défaut ne doit pas être utilisée dans les flux.
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]

Champs
description

string

OfferDetails

[START offer_details_definition] Next tag: 15

Champs
offer_display_text

string

Texte de l'offre que le fournisseur souhaite afficher aux clients sur la page de résultats de recherche. Obligatoire.
max_discount_value

Money

Remise maximale dont vous pouvez bénéficier. Par exemple, 10 % de remise jusqu'à 100 €.
min_spend_value

Money

Valeur minimale des dépenses pour bénéficier de la remise. Par exemple, 10 % de remise lorsque le prix total est de 100 $ou plus.
booking_cost

Money

Coût de la réservation de cette offre. Par exemple, 100 $ de remise sur l'addition finale lorsqu'une table est réservée au prix de 15 $.
booking_cost_unit

FeeUnit

Unité du coût de la réservation. Par exemple, par personne et par transaction.
convenience_fee

Fee
booking_cost_adjustable

bool

Indique si le coût de la réservation est ajustable, c'est-à-dire s'il est déduit de la facture finale. Par exemple : 30 % de remise sur le dîner avec réservation. Le coût de la réservation est de 15 $, qui seront déduits de la facture finale. La facture finale sera donc : Total dépensé - 30 % - 15 $
additional_fees[]

AdditionalFee

Frais supplémentaires facturés à l'utilisateur. Exemples : frais de commodité, de traitement, de livraison, d'emballage, de service, etc.
gift_card_info

GiftCardInfo

Détails spécifiques aux offres de cartes cadeaux.
Champ d'union offer_specification. La remise peut être exprimée en pourcentage ou en valeur fixe soustraite de la valeur totale. Par exemple : 1. 10 % de remise sur la facture finale. 2. 15 $ de remise sur une commande Les marchands peuvent également proposer des remises personnalisées, comme "deux pour le prix d'un", dans les champs de spécification correspondants. Obligatoire. offer_specification ne peut être qu'un des éléments suivants :
discount_percent

float

Pourcentage de remise sur la facture. [0, 100] Pour les offres 1+1 ou 50 % de réduction applicables à l'ensemble du repas (par exemple, buffet 1+1, 1+1 sur l'ensemble de l'addition, 1+1 sur le menu), cette valeur peut être définie sur 50.
discount_value

Money

Valeur fixe de la remise.
other_offer_detail_text

string

Texte libre pour décrire la remise. Pour les offres spécifiques "1+1" (par exemple, 1+1 boissons, +1 plat principal, 1+1 éléments de menu sélectionnés), ces détails doivent être décrits ici.

OfferMode

[START offer_mode_definition] Spécifie la méthode ou le canal par lesquels l'utilisateur peut bénéficier de l'offre.

Enums
OFFER_MODE_OTHER À utiliser pour les méthodes de traitement non couvertes par d'autres modes spécifiques.
OFFER_MODE_WALK_IN L'offre est disponible pour les visites sur place sans réservation préalable.
OFFER_MODE_FREE_RESERVATION L'offre s'applique lorsqu'un utilisateur effectue une réservation qui ne nécessite pas de frais initiaux.
OFFER_MODE_PAID_RESERVATION L'offre s'applique lorsqu'un utilisateur effectue une réservation qui nécessite un paiement anticipé.
OFFER_MODE_ONLINE_ORDER L'offre est valable pour les commandes passées sur un site Web ou une plate-forme numérique.
OFFER_MODE_GIFT_CARD_PURCHASE Indique que l'achat d'une carte cadeau est la principale étape requise pour profiter de l'offre.

OfferRestrictions

[START offer_restrictions_definition] Next tag: 11

Champs
combinable_with_other_offers

bool

Indique si cette offre est cumulable avec d'autres. Si la valeur est "true", les partenaires peuvent spécifier les offres avec lesquelles cette offre peut être combinée. Si les deux attributs combinable_offer_categories et combinable_offer_ids sont définis, toute offre correspondant à l'une des conditions ci-dessus sera combinable.
combinable_offer_categories[]

OfferCategory

Liste des types d'offres avec lesquels cette offre peut être combinée. Par exemple, cette offre peut être cumulable avec d'autres bons de réduction. Si combinable_with_other_offers est défini sur "true" et que ce champ n'est pas défini, tous les types seront combinables.
combinable_offer_ids[]

string

Liste des offer_ids avec lesquels cette offre peut être combinée. Certaines offres ne peuvent être combinées qu'avec certains autres offer_ids spécifiques (qui peuvent être considérés comme des offres parentes). Si combinable_with_other_offers est défini sur "true" et que ce champ n'est pas défini, tous les ID d'offres seront combinables.
inclusions[]

OfferCondition

Liste des conditions à remplir pour que l'offre soit valable (par exemple, boissons non alcoolisées, nourriture).
exclusions[]

OfferCondition

Liste des conditions qui invalideraient l'offre (par exemple, buffet, offres combinées et cocktails).
min_guest

int32

Nombre minimal de personnes requis pour profiter de l'offre.
food_offer_restrictions

FoodOfferRestrictions

Restrictions spécifiques aux offres de restauration.
special_conditions[]

string

Conditions spéciales de cette offre qui doivent être présentées à l'utilisateur. Exemples : "Valable uniquement pour les paiements dans [zone]", "Exclut les paiements en ligne"

OfferSource

[START offer_source_definition]

Enums
OFFER_SOURCE_UNSPECIFIED
OFFER_SOURCE_AGGREGATOR

OfferTag

[START offer_tag_definition]

Enums
OFFER_TAG_UNSPECIFIED La valeur d'énumération UNSPECIFIED ou par défaut ne doit pas être utilisée dans les flux.
OFFER_TAG_NEW_YEAR_SPECIAL
OFFER_TAG_VALENTINES_SPECIAL

PaymentInstrument

[START payment_instrument_definition]

Champs
items[]

PaymentInstrumentItem

Liste des instruments de paiement pouvant être utilisés pour profiter de l'offre. Obligatoire.
provider_name

string

Nom du fournisseur du mode de paiement. Il peut s'agir d'un partenaire bancaire, du nom d'une banque, etc. Par exemple : American Express, HDFC, ICICI.

PaymentInstrumentItem

[START payment_instrument_item_definition]

Champs
type

PaymentInstrumentType

Type de l'instrument de paiement. Obligatoire.
name

string

Nom de l'élément du mode de paiement, comme le nom de la carte de crédit. Par exemple : HDFC Infinia, American Express Platinum. Obligatoire.

PaymentInstrumentType

[START payment_instrument_type_definition]

Enums
PAYMENT_INSTRUMENT_TYPE_UNSPECIFIED La valeur d'énumération UNSPECIFIED ou par défaut ne doit pas être utilisée dans les flux.
PAYMENT_INSTRUMENT_CREDIT_CARD
PAYMENT_INSTRUMENT_DEBIT_CARD
PAYMENT_INSTRUMENT_BANK_ACCOUNT
PAYMENT_INSTRUMENT_UPI
PAYMENT_INSTRUMENT_ONLINE_WALLET
PAYMENT_INSTRUMENT_NETBANKING

Abonnement

[START subscription_definition]

Champs
name

string

Nom de l'abonnement. Obligatoire.
subscription_auto_added

bool

Indique si l'abonnement est ajouté automatiquement lorsqu'un utilisateur profite de cette offre.
cost

Money

Coût de l'abonnement. Obligatoire.
subscription_duration

Duration

Durée de validité de l'abonnement au prix subscription_cost. Obligatoire.
terms_and_conditions_url

string

URL des conditions d'utilisation du partenaire concernant cet abonnement.

Conditions d'utilisation

[START terms_definition]

Champs
url

string

URL des conditions d'utilisation du partenaire.
restricted_to_certain_users

bool

Indique si l'offre est réservée à certains utilisateurs.
terms_and_conditions

string

Texte principal des conditions d'utilisation fournies par le partenaire.
additional_terms_and_conditions[]

string

Conditions d'utilisation supplémentaires à celles principales du partenaire.