Package madden.ingestion.offer

Индекс

ActionType

[START action_type_definition] Представляет способ выполнения заказа. Если предложение можно использовать для нескольких способов выполнения заказа, то для каждого из них нужно создать отдельное предложение.

Перечисления
ACTION_TYPE_UNSPECIFIED
ACTION_TYPE_FOOD_DELIVERY Предложение распространяется на сервисы доставки еды.
ACTION_TYPE_FOOD_TAKEOUT Предложение распространяется на заказы еды навынос или самовывозом.
ACTION_TYPE_DINING Предложение действует при посещении ресторана.
ACTION_TYPE_SHOPPING_IN_STORE Предложение действует при покупках в обычных магазинах.

AdditionalFee

[START additional_fee_definition]

Поля
name

string

Название дополнительной комиссии. Примеры: сервисный сбор, плата за обработку и т. д. Обязательный атрибут.
fee

Fee

Купон

[START coupon_definition]

Поля
text

string

Текст купона, который поставщик предложения хочет показывать пользователям.
code

string

Для участия в акции требуется промокод. Обязательно.

Плата

[START fee_definition] Next ID: 5

Поля
unit

FeeUnit
type

FeeType

Объединенное поле cost.

Поле cost может иметь одно из следующих значений:
amount

Money
amount_range

MoneyRange

FeeType

[START fee_type_definition]

Перечисления
FEE_TYPE_UNSPECIFIED В фидах не следует использовать значение UNSPECIFIED или значение перечисления по умолчанию.
FEE_TYPE_FIXED
FEE_TYPE_VARIABLE

FeeUnit

[START fee_unit_definition]

Перечисления
FEE_UNIT_UNSPECIFIED В фидах не следует использовать значение UNSPECIFIED или значение перечисления по умолчанию.
FEE_UNIT_PER_GUEST
FEE_UNIT_PER_TRANSACTION

FixedDenominations

Поля
amounts[]

Money

Список всех доступных номиналов (например, [100, 500, 1000]).

FoodOfferRestrictions

[START food_offer_restrictions_definition]

Поля
meal_types[]

MealType

Типы блюд, к которым можно применить предложение, например обед или ужин. Если не задано, предложение можно применить ко всем типам блюд.
restricted_to_certain_courses

bool

Можно ли применить предложение только к определенным курсам.

GiftCardInfo

[START gift_card_info_definition]

Поля

Объединенное поле denomination_type.

Поле denomination_type может иметь одно из следующих значений:
fixed_denominations

FixedDenominations

Используется, когда подарочная карта доступна в определенных фиксированных суммах.
custom_range

MoneyRange

Используется, когда бренд позволяет пользователям выбирать номинальную стоимость в заданном диапазоне.

MealType

[START meal_type_definition]

Перечисления
MEAL_TYPE_UNSPECIFIED В фидах не следует использовать значение UNSPECIFIED или значение перечисления по умолчанию.
MEAL_TYPE_BREAKFAST
MEAL_TYPE_LUNCH
MEAL_TYPE_DINNER

MoneyRange

[START money_range_definition]

Поля
min_amount

Money
max_amount

Money

Предложение

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

Поля
offer_id

string

Уникальный идентификатор предложения. Обязательно.
entity_ids[]

string

Список продавцов, участвующих в этой акции.
add_on_offer_applicable_to_all_entities

bool

Если значение равно true, предложение применяется ко всем объектам агрегатора. Применимо только к дополнительным предложениям.
offer_source

OfferSource

Предложение может быть предоставлено агрегатором, отдельным продавцом или даже третьей стороной в качестве дополнения. Обязательно.
action_type

ActionType

Сервис, который предоставляет предложение. Одному значению offer_id может соответствовать только одно значение action_type. Если предложение можно использовать для нескольких типов услуг, то для каждого из них нужно создать отдельное предложение с уникальным идентификатором. Обязательно.
offer_modes[]

OfferMode

Способы воспользоваться предложением: посещение сервисного центра, бронирование, онлайн и т. д. Обязательный атрибут.
offer_category

OfferCategory

Категория предложения. Обязательно.
source_assigned_priority

int32

Неотрицательное целое число от 1 до 100, где 1 – наивысший приоритет. Указывает уровень приоритета предложения, назначенный источником. Если у одного продавца есть несколько специальных предложений, это будет сигналом для ранжирования. 0 означает, что приоритет не задан.
offer_details

OfferDetails

Подробная информация о предложении, например скидка, стоимость бронирования и т. д. Обязательный параметр.
offer_restrictions

OfferRestrictions

Описывает ограничения, связанные с предложением, например требуется ли подписка или способ оплаты, можно ли комбинировать это предложение с другими (и какими именно) и т. д. Обязательный атрибут.
coupon

Coupon

Сведения о купоне. Обязательно для offer_category: OFFER_CATEGORY_ADD_ON_COUPON_OFFER.
payment_instrument

PaymentInstrument

Сведения о способе оплаты. Обязательный параметр для offer_category: OFFER_CATEGORY_ADD_ON_PAYMENT_OFFER.
subscription

Subscription

Сведения о подписке. Обязательно для offer_category: OFFER_CATEGORY_ADD_ON_SUBSCRIPTION_OFFER.
terms

Terms

Условия использования предложения. Обязательно.
validity_periods[]

ValidityPeriod

Период действия предложения. Описывает период времени, в течение которого действует предложение, включая время начала и окончания, дни недели и т. д. Обязательное свойство.
offer_url

string

URL страницы предложения продавца. Обязательно для offer_category: OFFER_CATEGORY_BASE_OFFER.
image_url

string

URL изображения предложения продавца.
tags[]

OfferTag

Специальные теги, связанные с предложением. Используется для идентификации специальных предложений, например "Праздничное", "Лучшее", "Самое бронируемое" и т. д.
brand_id

string

Определяет бренд, связанный с предложением. Если правило не настроено, используется бренд по умолчанию.

OfferCategory

[START offer_category_definition] Категория предложения. Базовое предложение – это стандартное предложение, доступное всем клиентам, например скидка 10% при покупке на сумму от 100 долларов США. Если основное специальное предложение ограничено купоном или способом оплаты, будут заданы соответствующие поля. Также есть предложения типа ADD_ON_PAYMENT_OFFER. Такие предложения можно комбинировать с другими, чтобы получить дополнительные скидки.

Перечисления
OFFER_CATEGORY_UNSPECIFIED В фидах не следует использовать значение UNSPECIFIED или значение перечисления по умолчанию.
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]

Поля
description

string

OfferDetails

[START offer_details_definition] Next tag: 15

Поля
offer_display_text

string

Текст предложения, который поставщик хочет показывать клиентам на странице результатов поиска. Обязательно.
max_discount_value

Money

Максимальная скидка, которую можно получить. Например, скидка 10 % (до 100 долларов США).
min_spend_value

Money

Минимальная сумма расходов, необходимая для получения скидки. Например, скидка 10% при общей стоимости товаров от 100 долларов США.
booking_cost

Money

Стоимость бронирования по этому предложению. Например, скидка 100 долларов США на итоговый счет при бронировании столика за 15 долларов США.
booking_cost_unit

FeeUnit

Единица стоимости бронирования. Например, на человека или на транзакцию.
convenience_fee

Fee
booking_cost_adjustable

bool

Можно ли скорректировать стоимость бронирования, то есть вычесть ее из окончательного счета. Пример: скидка 30% на ужин при бронировании. Стоимость бронирования – 15 долл. США. Эта сумма будет учтена в окончательном счете. Итоговый счет: общая сумма расходов минус 30 % минус 15 долл. США.
additional_fees[]

AdditionalFee

Дополнительные комиссии, взимаемые с пользователя. Примеры: комиссия за удобство, обработку, доставку, упаковку, обслуживание и т. д.
gift_card_info

GiftCardInfo

Сведения о специальных предложениях с подарочными картами.
Объединенное поле offer_specification. Скидка может быть указана в процентах или в виде фиксированной суммы, вычитаемой из общей стоимости. Пример 1. Скидка 10% на итоговый счет. 2. Скидка 15 $ на заказ. Продавцы также могут предлагать специальные скидки, например "купи один, получи второй бесплатно", используя соответствующие поля спецификации. Обязательно. offer_specification может иметь одно из следующих значений:
discount_percent

float

Процентная доля счета, на которую распространяется скидка. [0, 100]. Для предложений "1+1" или скидки 50 %, которые распространяются на всю еду (например, "шведский стол 1+1", "1+1 на весь счет", "1+1 на комплексное меню"), можно указать значение 50.
discount_value

Money

Фиксированное значение скидки.
other_offer_detail_text

string

Текст в свободной форме с описанием скидки. Здесь нужно указать подробности специальных предложений "1+1", например "1+1 напитки", "+1 основное блюдо" или "1+1 отдельные позиции меню".

OfferMode

[START offer_mode_definition] Способ или канал, с помощью которого пользователь может воспользоваться специальным предложением.

Перечисления
OFFER_MODE_OTHER Используется для способов выполнения заказов, не охваченных другими режимами.
OFFER_MODE_WALK_IN Предложение доступно при посещении без предварительного бронирования.
OFFER_MODE_FREE_RESERVATION Предложение действует, когда пользователь делает бронирование, не требующее предоплаты.
OFFER_MODE_PAID_RESERVATION Предложение действует, когда пользователь делает бронирование, требующее предоплаты.
OFFER_MODE_ONLINE_ORDER Предложение действует при заказе на сайте или цифровой платформе.
OFFER_MODE_GIFT_CARD_PURCHASE Покупка подарочной карты – основной шаг для получения предложения.

OfferRestrictions

[START offer_restrictions_definition] Next tag: 11

Поля
combinable_with_other_offers

bool

Можно ли сочетать это предложение с другими. Если задано значение true, партнеры могут указать, с какими предложениями можно комбинировать это предложение. Если заданы оба параметра combinable_offer_categories и combinable_offer_ids, то комбинироваться будут все предложения, соответствующие одному из условий выше.
combinable_offer_categories[]

OfferCategory

Список типов предложений, с которыми можно комбинировать это предложение. Например, это предложение может сочетаться с другими купонами. Если для параметра combinable_with_other_offers задано значение true, а это поле не заполнено, то будут доступны все типы.
combinable_offer_ids[]

string

Список идентификаторов предложений, с которыми можно комбинировать это предложение. Некоторые предложения можно комбинировать только с определенными другими идентификаторами предложений (их можно считать родительскими предложениями). Если для атрибута combinable_with_other_offers задано значение true, а это поле не заполнено, то все идентификаторы предложений будут комбинируемыми.
inclusions[]

OfferCondition

Список условий, которым должно соответствовать предложение (например, безалкогольные напитки, еда).
exclusions[]

OfferCondition

Список условий, при которых предложение недействительно (например, шведский стол, комбинированные предложения и коктейли).
min_guest

int32

Минимальное количество человек, необходимое для того, чтобы воспользоваться предложением.
food_offer_restrictions

FoodOfferRestrictions

Ограничения, относящиеся к предложениям еды.
special_conditions[]

string

Специальные условия предложения, которые должны быть показаны пользователю. Примеры: "Действительно только для оплаты в [область]", "Недействительно для онлайн-платежей".

OfferSource

[START offer_source_definition]

Перечисления
OFFER_SOURCE_UNSPECIFIED
OFFER_SOURCE_AGGREGATOR

OfferTag

[START offer_tag_definition]

Перечисления
OFFER_TAG_UNSPECIFIED В фидах не следует использовать значение UNSPECIFIED или значение перечисления по умолчанию.
OFFER_TAG_NEW_YEAR_SPECIAL
OFFER_TAG_VALENTINES_SPECIAL

PaymentInstrument

[START payment_instrument_definition]

Поля
items[]

PaymentInstrumentItem

Список платежных инструментов, которые можно использовать для получения предложения. Обязательно.
provider_name

string

Название поставщика платежного инструмента. Это может быть банк-партнер, название банка и т. д. Например: American Express, HDFC, ICICI.

PaymentInstrumentItem

[START payment_instrument_item_definition]

Поля
type

PaymentInstrumentType

Тип способа оплаты. Обязательно.
name

string

Название способа оплаты, например кредитной карты. Например, HDFC Infinia, American Express Platinum. Обязательно.

PaymentInstrumentType

[START payment_instrument_type_definition]

Перечисления
PAYMENT_INSTRUMENT_TYPE_UNSPECIFIED В фидах не следует использовать значение UNSPECIFIED или значение перечисления по умолчанию.
PAYMENT_INSTRUMENT_CREDIT_CARD
PAYMENT_INSTRUMENT_DEBIT_CARD
PAYMENT_INSTRUMENT_BANK_ACCOUNT
PAYMENT_INSTRUMENT_UPI
PAYMENT_INSTRUMENT_ONLINE_WALLET
PAYMENT_INSTRUMENT_NETBANKING

Подписка

[START subscription_definition]

Поля
name

string

Название подписки. Обязательно.
subscription_auto_added

bool

Добавляется ли подписка автоматически, когда пользователь принимает это предложение.
cost

Money

Стоимость подписки. Обязательно.
subscription_duration

Duration

Срок действия подписки по указанной цене. Обязательно.
terms_and_conditions_url

string

URL условий использования партнера, относящихся к этой подписке.

Условия использования

[START terms_definition]

Поля
url

string

URL страницы с условиями использования партнера.
restricted_to_certain_users

bool

Ограничено ли предложение определенными пользователями.
terms_and_conditions

string

Основной текст условий использования, предоставленный партнером.
additional_terms_and_conditions[]

string

Условия использования, дополняющие основные условия партнера.