プロモーション

概要

この API を使用すると、適用可能な割引を指定できます。指定されたプロモーションのうち、最低価格につながる有効なプロモーションまたはプロモーション セットが適用されます。条件が満たされたときに料金を増減できる任意のレート調整をサポートする API をお探しの場合は、Rate Modifications API の使用をご検討ください。両方の API が存在する場合、プロモーションの前にレートの変更が適用されることに注意してください。

リクエスト

構文

Promotions メッセージには次の構文が使用されます。

<?xml version="1.0" encoding="UTF-8"?>
<Promotions partner= "partner_key"
            id="message_ID"
            timestamp="timestamp">
  <HotelPromotions hotel_id="HotelID" action="[overlay]">
    <Promotion id="PromotionID" action="[delete]">
      <BookingDates>
        <DateRange start="YYYY-MM-DD[THH:mm:ss]" end="YYYY-MM-DD[THH:mm:ss]"
          days_of_week="MTWHFSU_or_subset"/>
        <DateRange start="YYYY-MM-DD[THH:mm:ss]" end="YYYY-MM-DD[THH:mm:ss]"
          days_of_week="MTWHFSU_or_subset"/>
      </BookingDates>
      <BookingWindow min="integer_or_duration" max="integer_or_duration"/>
      <Ceiling amount_per_night="float"/>
      <Floor amount_per_night="float"/>
      <CheckinDates>
        <DateRange start="[YYYY-]MM-DD" end="[YYYY-]MM-DD" days_of_week="MTWHFSU_or_subset"/>
      </CheckinDates>
      <CheckoutDates>
        <DateRange start="[YYYY-]MM-DD" end="[YYYY-]MM-DD" days_of_week="MTWHFSU_or_subset"/>
      </CheckoutDates>
      <!-- Specify only one of percentage, fixed_amount, fixed_amount_per_night,
           fixed_price, or fixed_price_per_night; applied_nights is only used
           with percentage, fixed_amount_per_night, and fixed_price_per_night. -->
      <Discount percentage="float" fixed_amount="float" fixed_amount_per_night="float"
                fixed_price="float" fixed_price_per_night="float"
                applied_nights="integer_1_to_99" rank="integer_1_to_99">
        <!-- FreeNights may not be used in conjunction with attributes on Discount -->
        <FreeNights stay_nights="integer" discount_nights="integer"
                    discount_percentage="float" night_selection="[cheapest|last]"
                    repeats="boolean"/>
      </Discount>
      <!-- Exactly one of Discount or BestDailyDiscount must be specified.
           Specify only one of percentage, fixed_amount, or fixed_price. -->
      <BestDailyDiscount percentage="float" fixed_amount="float" fixed_price="float"/>
      <Devices>
        <Device type="[desktop|tablet|mobile]"/>
      </Devices>
      <InventoryCount min="integer" max="integer"/>
      <LengthOfStay min="integer" max="integer"/>
      <MembershipRateRule id="RateRuleID"/>
      <MinimumAmount before_discount="integer"/>
      <Occupancy min="integer" max="integer"/>
      <RatePlans>
        <RatePlan id="PackageID_1"/>
        <RatePlan id="PackageID_2"/>
      </RatePlans>
      <RoomTypes>
        <RoomType id="RoomID_1"/>
        <RoomType id="RoomID_2"/>
      </RoomTypes>
      <Stacking type="[any|base|none|second]"/>
      <StayDates application="[all|any|overlap]">
        <DateRange start="[YYYY-]MM-DD" end="[YYYY-]MM-DD" days_of_week="MTWHFSU_or_subset"/>
      </StayDates>
      <UserCountries type="[include|exclude]">
        <Country code="country_code"/>
      </UserCountries>
    </Promotion>
  </HotelPromotions>
</Promotions>

要素と属性

プロモーション メッセージには、次の要素と属性があります。

要素 / @Attribute 発生回数 タイプ 説明
Promotions 1 Complex element プロモーション メッセージのルート要素。
Promotions / @partner 1 string このメッセージのパートナー アカウント。この文字列値は、Hotel Center の [アカウント設定] ページに表示される「パートナー キー」の値です。

複数のアカウントにフィードを提供するバックエンドがある場合、この値は、同じアカウントの <OTA_HotelRateAmountNotifRQ> メッセージと <OTA_HotelAvailNotifRQ> メッセージの <RequestorID> 要素で指定された ID 属性値と一致する必要があります。
Promotions / @id 1 string このリクエスト メッセージの一意の識別子。この値はレスポンス メッセージで返されます。使用できる文字は、a ～ z、A ～ Z、0 ～ 9、_（アンダースコア）、-（ダッシュ）です。
Promotions / @timestamp 1 DateTime このメッセージの作成日時。
Promotions / HotelPromotions 0..n HotelPromotions

宿泊施設のプロモーション。各プロモーションは 1 つの宿泊施設に適用されます。

<Stacking> が使用されない限り、複数のプロモーションの対象となる場合は、割引が最も大きいプロモーションが予約に適用されます。
Promotions / HotelPromotions / @hotel_id 1 string 宿泊施設の一意の識別子。この値は、ホテルリスト フィードの <listing> 要素の <id> を使用して指定したホテル ID と一致する必要があります。ホテル ID は Hotel Center にも表示されます。
Promotions / HotelPromotions / @action 0..1 enum

指定する場合、値は "overlay" にする必要があります。値が "overlay" の場合、現在のメッセージで指定されたプロモーションを保存する前に、保存されているすべてのプロモーションが削除されます。

指定しない場合、現在のメッセージで指定された各プロモーションは次のいずれかになります。

  • Added（同じ id を持つ保存済みのプロモーションがない場合）
  • Updated（保存済みのプロモーションの id が同じ場合）
  • Deleted（保存されているプロモーションの id が同じで、現在のメッセージで指定されているプロモーションの action 属性の値が "delete" の場合）
Promotions / HotelPromotions / Promotion 0..99 Promotion

宿泊施設の 1 件のプロモーション。action="overlay" と <Promotion> が指定されていない場合、宿泊施設のすべてのプロモーションが削除されます。

99 個を超えるプロモーションを使用する必要がある場合は、テクニカル アカウント マネージャー（TAM）にお問い合わせください。
Promotions / HotelPromotions / Promotion / @id 1 string プロモーションの一意の識別子。使用できる最大文字数は 40 文字です。使用できる文字は、a ～ z、A ～ Z、0 ～ 9、_（アンダースコア）、-（ダッシュ）、.（ピリオド）を使用します。
Promotions /HotelPromotions / Promotion / @action 0..1 enum

指定する場合、値は delete にする必要があります。指定せず、同じ id を持つプロモーションが保存されない場合、このプロモーションは保存されます。指定しない場合、同じ id を持つプロモーションが保存されると、既存のプロモーションが更新されます。

delete を指定すると、同じ id を持つ保存済みのプロモーションが削除されます。delete を使用する場合は、<Promotion> に子要素を含めないでください。また、delete を <HotelPromotions action="overlay"/> と組み合わせて使用することはできません。
Promotions / HotelPromotions / Promotion / BookingDates 0..1 BookingDates プロモーションを適用するために予約が行われる必要があるタイミングを定義する、1 つ以上の範囲のコンテナ。
Promotions / HotelPromotions / Promotion / BookingDates / DateRange 1..99 DateRange プロモーションを適用するために予約を行う必要があるタイミングを指定する範囲。
Promotions / HotelPromotions / Promotion / BookingDates / DateRange / @start 0..1 Date または DateTime

範囲の開始日または日時（プロパティのタイムゾーンに基づく）。

  • start で指定した日付または日時は、end で指定された日付または日時よりも前（または同じ）でなければなりません。
  • start が指定されていない場合、開始時間に関して範囲は実質的に無制限になります。
  • start に日付「YYYY-MM-DD」が入力されている場合、日時「YYYY-MM-DDT00:00:00」と解釈されます。
Promotions / HotelPromotions / Promotion / BookingDates / DateRange / @end 0..1 Date または DateTime

範囲の終了日または日時（プロパティのタイムゾーンに基づく）。

  • end で指定した日付または日時は、start で指定された日付または日時よりも後である（または同じ日付または日時と同じ）必要があります。
  • end が指定されていない場合、終了時刻に関して範囲は実質的に無制限になります。
  • end を日付「YYYY-MM-DD」として指定すると、日時「YYYY-MM-DDT23:59:59」と解釈されます。
Promotions / HotelPromotions / Promotion / BookingDates / DateRange / @days_of_week 0..1 string

日付範囲内の曜日です。指定しない場合、期間内のすべての日が許可されます。文字列内の各文字は日付を示します。たとえば、「MTWHF」は、その日付範囲内で平日を許可することを指定します。

有効な文字は次のとおりです。

  • M（月曜日）
  • T（火曜日）
  • W（水曜日）
  • H（木曜日）
  • F（金曜日）
  • S（土曜日）
  • U（日曜日）

任意の文字の組み合わせが有効です。
Promotions / HotelPromotions / Promotion / BookingWindow 0..1 BookingWindow チェックイン日を基準にして予約を行う必要がある期間を指定します（プロパティのタイムゾーンに基づきます）。たとえば、チェックイン日の 7 ～ 180 日前まで予約可能期間を設定できます。
Promotions / HotelPromotions / Promotion / BookingWindow / @min 0..1 integer or duration プロモーションを適用するために予約が行われる必要がある、チェックインまでの最短期間。指定しない場合、または値が 0 の場合、最小値はありません。

有効な値の型は次のとおりです。

  • 整数: チェックイン日までの日数。たとえば、値 30 は、チェックイン日の 30 日以上前の予約にのみプロモーションが適用されることを示します。
  • ISO 8601 の期間（日、時間、分）: チェックイン日までの日数（時間数と分数で指定することもできます）。たとえば、値 P30D は、チェックイン日の 30 日以上前の予約にのみプロモーションが適用されることを示します。値が P30DT6H の場合、到着 30 日目の 18:00 までに予約する必要があります。
Promotions / HotelPromotions / Promotion / BookingWindow / @max 0..1 integer or duration プロモーションを適用するために予約が必要となるチェックインまでの最大日数。指定しない場合、または値が 0 の場合、最大値はありません。

有効な値の型は次のとおりです。

  • 整数: チェックイン日までの日数。たとえば、値 30 は、チェックイン日の 30 日前までの予約にプロモーションが適用されることを示します。
  • ISO 8601 の期間（日、時間、分）: チェックイン日までの日数（時間数と分数で指定することもできます）。たとえば、値 P30D は、チェックイン日の 30 日前までの予約にプロモーションが適用されることを示します。値が P30DT6H の場合、到着 30 日目の 18:00 以降に予約する必要があります。
Promotions / HotelPromotions / Promotion / Ceiling 0..1 Ceiling

プロモーションの適用後にレートに設定できる最大値の制限を定義します。

プロモーションでは常に <Discount> または <BestDailyDiscount> を指定する必要があります。<Ceiling> のみを適用するプロモーションを作成するには、percentage を 0 に設定して <Discount> を設定するという方法があります。

スタッキングが構成されている場合、<Ceiling> を含む複数のプロモーションを 1 回の宿泊に適用できます。各プロモーションで割引が適用され、直後に上限が適用されます。次の例は、各上限がスタック内の次のプロモーションの計算にどのように影響するかを示しています。

例:

1 泊の宿泊料金（AmountBeforeTax が 100 で、次の 2 つのプロモーションが重なった場合）。

  1. スタッキング タイプが base、fixed_amount が 25、上限 amount_per_night が 60 のプロモーション
  2. スタッキング タイプが second、fixed_amount が 25、上限 amount_per_night が 90 のプロモーション

計算の順序は次のとおりです。

  1. base プロモーションが最初に適用され、AmountBeforeTax が 75 に割引されますが、上限によって 60 に引き下げられます。
  2. second プロモーションでは、AmountBeforeTax が 60 から 35 に割引されます。これは上限の 90 より小さいため、2 番目の上限は適用されません。最終的なレートは 35 です。

60 というのは、それ自体のプロモーションに対してのみ有効であり、プロモーション スタック全体にまたがる単一の上限は存在しないため、全体の上限が 60 という指定が比較的厳しいという事実は関係ありません。
Promotions / HotelPromotions / Promotion / Ceiling / @amount_per_night 1 float

割引適用後に 1 泊の料金を設定できる最大金額。

<Floor> 要素も指定する場合は、<Floor> の amount_per_night 属性以上の値に設定する必要があります。

amount_per_night は、税金と手数料が AmountAfterTax を使用して 1 泊の料金に含まれている場合に適用されますが、TaxFeeInfo を使用して指定された場合には適用されません。
Promotions / HotelPromotions / Promotion / Floor 0..1 Floor

プロモーションの適用後にレートを設定できる最小値の制限を定義します。

プロモーションでは常に <Discount> または <BestDailyDiscount> を指定する必要があります。<Floor> のみを適用するプロモーションを作成するには、percentage を 0 に設定して <Discount> を設定するという方法があります。

<Floor> ロジックは、無料宿泊に 100% の割引が適用されていても、<FreeNights> の割引に適用されます。

スタッキングが構成されている場合、<Floor> を含む複数のプロモーションを 1 回の宿泊に適用できます。各プロモーションで割引が適用され、直後に最小価格が適用されます。次の例は、各階数が、スタック内の次のプロモーションの計算でどのように算定されるかを示しています。

例:

1 泊の宿泊料金（AmountBeforeTax が 100 で、次の 2 つのプロモーションが重なった場合）。

  1. スタッキング タイプが base、fixed_amount が 25、階数 amount_per_night が 90 のプロモーション
  2. スタッキング タイプが second、fixed_amount が 25、下限が amount_per_night のプロモーション

計算の順序は次のとおりです。

  1. 最初に base プロモーションが適用され、AmountBeforeTax が 75 に割引されますが、最小価格は 90 に引き上げられます。
  2. second プロモーションでは、AmountBeforeTax が 90 から 65 に割引されます。60 階を超えるため、2 階は適用されません。最終的なレートは 65 です。

90 がそれ自体のプロモーションに対してのみ有効であり、プロモーション スタック全体にまたがる単一の最小価格は存在しないため、全体の最小価格が 90 より厳しいという事実は関係ありません。
Promotions / HotelPromotions / Promotion / Floor / @amount_per_night 1 float

割引適用後に 1 泊の料金に設定できる最小金額。

<Ceiling> 要素も指定する場合は、<Ceiling> の amount_per_night 属性以下の値に設定する必要があります。

amount_per_night は、税金と手数料が AmountAfterTax を使用して 1 泊の料金に含まれている場合に適用されますが、TaxFeeInfo を使用して指定された場合には適用されません。
Promotions / HotelPromotions / Promotion / CheckinDates 0..1 CheckinDates プロモーションを適用するためにチェックインが行われる必要があるタイミングを定義する、1 つ以上の期間のコンテナ。
Promotions / HotelPromotions / Promotion / CheckinDates / DateRange 1..20 DateRange

プロモーションを適用するためにチェックインを行う必要があるタイミングを指定する期間。1 つ以上のプロモーションを削除する場合、この要素は必要ありません。

YearlessDate 形式もサポートされています。

  • start または end のいずれかが年のない日付である場合、両方とも年のない日付として入力する必要があります。
  • 複数年の年なし期間を設定する場合は、翌年を前後に設定することはできません。代わりに、連続する 2 つの期間として表します。たとえば、{"12-29", "01-05"} は {"12-29", "12-31"} と {"01-01", "01-05"} として表すことができます。
Promotions / HotelPromotions / Promotion / CheckinDates / DateRange / @start 0..1 Date or YearlessDate 期間の開始日（プロパティのタイムゾーンに基づく）。この日付は、end と同じかそれより前の日付にする必要があります。start が指定されていない場合、開始日に関する期間は実質的に無制限になります。
Promotions / HotelPromotions / Promotion / CheckinDates / DateRange / @end 0..1 Date or YearlessDate 期間の終了日（プロパティのタイムゾーンに基づく）。その日付を含む期間が含まれます。この日付は、start 以降の日付にする必要があります。end が指定されていない場合、終了日については、期間は事実上無制限になります。
Promotions / HotelPromotions / Promotion / CheckinDates / DateRange / @days_of_week 0..1 string

日付範囲内の曜日です。指定しない場合、期間内のすべての日が許可されます。文字列内の各文字は日付を示します。たとえば、「MTWHF」は、その日付範囲内で平日を許可することを指定します。

有効な文字は次のとおりです。

  • M（月曜日）
  • T（火曜日）
  • W（水曜日）
  • H（木曜日）
  • F（金曜日）
  • S（土曜日）
  • U（日曜日）

任意の文字の組み合わせが有効です。
Promotions / HotelPromotions / Promotion / CheckoutDates 0..1 CheckoutDates プロモーションを適用するためにチェックアウトする必要があるタイミングを定義する 1 つ以上の期間のコンテナ。
Promotions / HotelPromotions / Promotion / CheckoutDates / DateRange 1..20 DateRange

プロモーションを適用するためにチェックアウトを行う必要があるタイミングを指定する期間。1 つ以上のプロモーションを削除する場合、この要素は必要ありません。

YearlessDate 形式もサポートされています。

  • start または end のいずれかが年のない日付である場合、両方とも年のない日付として入力する必要があります。
  • 複数年の年なし期間を設定する場合は、翌年を前後に設定することはできません。代わりに、連続する 2 つの期間として表します。たとえば、{"12-29", "01-05"} は {"12-29", "12-31"} と {"01-01", "01-05"} として表すことができます。
Promotions / HotelPromotions / Promotion / CheckoutDates / DateRange / @start 0..1 Date or YearlessDate 期間の開始日（プロパティのタイムゾーンに基づく）。この日付は、end と同じかそれより前の日付にする必要があります。start が指定されていない場合、開始日に関する期間は実質的に無制限になります。
Promotions / HotelPromotions / Promotion / CheckoutDates / DateRange / @end 0..1 Date or YearlessDate 期間の終了日（プロパティのタイムゾーンに基づく）。その日付を含む期間が含まれます。この日付は、start 以降の日付にする必要があります。end が指定されていない場合、終了日については、期間は事実上無制限になります。
Promotions / HotelPromotions / Promotion / CheckoutDates / DateRange / @days_of_week 0..1 string

日付範囲内の曜日です。指定しない場合、期間内のすべての日が許可されます。文字列内の各文字は日付を示します。たとえば、「MTWHF」は、その日付範囲内で平日を許可することを指定します。

有効な文字は次のとおりです。

  • M（月曜日）
  • T（火曜日）
  • W（水曜日）
  • H（木曜日）
  • F（金曜日）
  • S（土曜日）
  • U（日曜日）

任意の文字の組み合わせが有効です。
Promotions / HotelPromotions / Promotion / Devices 0..1 Devices プロモーションの対象となるユーザー デバイスをリストするためのコンテナ。指定した場合、リストにあるデバイスの要件を満たすユーザーにのみ割引料金が提供されます。指定しない場合、任意のデバイスの対象ユーザーに割引料金が提供されます。
Promotions / HotelPromotions / Promotion / Devices / Device 1..3 Device プロモーションの対象となるユーザー デバイスの種類を 1 種類定義します。
Promotions / HotelPromotions / Promotion / Devices / Device / @type 1 enum デバイスの種類。値は desktop、tablet、または mobile にする必要があります。
Promotions / HotelPromotions / Promotion / Discount 1 Discount

Discount または BestDailyDiscount のいずれかを指定する必要があります。

このプロモーションに適用する割引を指定します。
Promotions / HotelPromotions / Promotion / Discount / @percentage 0..1 float

percentage、fixed_amount、fixed_amount_per_night、fixed_price、fixed_price_per_night のいずれか 1 つのみが必要です。

割引率を指定する 0 ～ 100 の小数値。これは AmountAfterTax（AmountAfterTax が指定されていない場合は AmountBeforeTax）に適用されます。

例:

  • AmountAfterTax が 100 で、percentage が 20 の場合:

    プロモーション率 = AmountAfterTax × (1 - 割引率)

    80.00 = 100 × (1 - 0.2)

  • AmountBeforeTax が 100、percentage が 20、TaxFeeInfo が税金 10 を指定する場合:

    プロモーションレート = AmountBeforeTax × (1 - 割引率) + 税金

    90.00 = 100 × (1 - 0.2) + 10
Promotions / HotelPromotions / Promotion / Discount / @fixed_amount 0..1 float

percentage、fixed_amount、fixed_amount_per_night、fixed_price、fixed_price_per_night のいずれか 1 つのみが必要です。

AmountAfterTax の 1 泊料金の合計（AmountAfterTax が指定されていない場合は AmountBeforeTax の 1 泊料金の合計）から差し引かれる固定金額。1 泊の料金と同じ通貨が使用されます。これが 1 泊の料金の合計よりも大きい場合、結果の値は 0 になります。

例:

  • 1 泊の料金で、AmountBeforeTax が 90、AmountAfterTax が 100、fixed_amount が 20 の場合:

    プロモーションレート = AmountAfterTax - 固定割引

    80.00 = 100 - 20

  • 1 泊の料金を計算する際に、AmountBeforeTax が 100、fixed_amount が 20、TaxFeeInfo で 8% の税金が指定されている場合:

    プロモーション料金 = (AmountBeforeTax - 固定割引) × (1 + 税金)

    86.40 = (100 - 20) × 1.08

  • 1 泊の料金を計算する際に、AmountBeforeTax が 50、fixed_amount が 60、TaxFeeInfo で税金 10 が指定されている場合は、次のようになります。

    プロモーション料金 = (AmountBeforeTax - 固定割引) × 税金

    10.00 = 0 + 10 となります。

  • 3 泊の料金で、AmountAfterTax の値が 100、110、120 で、fixed_amount が 150 の場合:

    プロモーションレート = sum(AmountAfterTax) - (固定割引)

    180.00 = (100 + 110 + 120) - 150
Promotions / HotelPromotions / Promotion / Discount / @fixed_amount_per_night 0..1 float

percentage、fixed_amount、fixed_amount_per_night、fixed_price、fixed_price_per_night のいずれか 1 つのみが必要です。

AmountAfterTax の 1 泊の料金（applied_nights が指定されている場合は最安の N）のそれぞれに適用される固定割引。AmountAfterTax が指定されていない場合は、AmountBeforeTax に適用されます。1 泊の料金と同じ通貨が使用されます。fixed_amount_per_night が 1 泊の料金よりも大きい場合、その 1 泊の料金は 0 に引き下げられます。割引によって 1 泊の料金がマイナスになることはありません。

例:

  • 3 泊の料金で、AmountAfterTax の値が 100、110、120 で、fixed_amount_per_night が 10 の場合:

    プロモーション率 = sum(AmountBeforeTax - 固定額割引)

    300.00 = ((100 - 10) + (110 - 10) + (120 - 10))

  • 3 泊の料金で、AmountAfterTax の値が 10、50、100、fixed_amount_per_night が 20 の場合:

    プロモーション率 = sum(AmountAfterTax - 固定額割引)

    110.00 = (0 + (50 - 20) + (100 - 20))
Promotions / HotelPromotions / Promotion / Discount / @fixed_price 0..1 float

percentage、fixed_amount、fixed_amount_per_night、fixed_price、fixed_price_per_night のいずれか 1 つのみが必要です。

AmountAfterTax の 1 泊の料金が指定されている場合は、宿泊料金（税金と手数料を含む）が指定された値に設定されます。AmountBeforeTax が指定されている場合、AmountAfterTax が指定されているかどうかにかかわらず、宿泊の税引前料金が指定された値に設定されます。1 泊の料金と同じ通貨が使用されます。

AmountAfterTax で税率を反映する場合、AmountBeforeTax に固定価格を設定すると、不正確な税金や手数料が発生する可能性があります。通常は、TaxFeeInfo を使用して宿泊施設の税金と手数料を指定することを強くおすすめします。

例:

  • 1 泊の料金で、AmountBeforeTax が 90、AmountAfterTax が 100、fixed_price が 80 の場合、プロモーション料金は 80 です。
  • 1 泊の料金を計算する際に、AmountBeforeTax が 100、fixed_amount が 80、TaxFeeInfo で 8% の税金が指定されている場合:

    プロモーションレート = 固定価格 × (1 + 税金)

    86.40 = 80 × 1.08

  • 3 泊の料金で、AmountAfterTax の値が 100、110、120 で、fixed_amount が 300 の場合:

    プロモーション率 = 300
Promotions / HotelPromotions / Promotion / Discount / @fixed_price_per_night 0..1 float

percentage、fixed_amount、fixed_amount_per_night、fixed_price、fixed_price_per_night のいずれか 1 つのみが必要です。

AmountAfterTax の 1 泊の料金が指定されている場合、税金と手数料を含む 1 泊の宿泊料金が指定された値に設定されます。AmountBeforeTax が指定されている場合、AmountAfterTax が指定されているかどうかにかかわらず、1 泊あたりの税引前料金が指定された値に設定されます。1 泊の料金と同じ通貨が使用されます。

AmountAfterTax で税率を反映する場合、AmountBeforeTax に固定価格を設定すると、不正確な税金や手数料が発生する可能性があります。通常は、TaxFeeInfo を使用して宿泊施設の税金と手数料を指定することを強くおすすめします。

applied_nights を指定した場合、新しい料金が最も安い N 泊に適用されます。

例:

  • 2 泊の料金で AmountBeforeTax の値が 90、90、AmountAfterTax の値が 100、100、fixed_price が 80 の場合、プロモーション料金は 80 + 80 = 160 です。
  • 2 泊の料金を計算する際に、AmountBeforeTax が 100、100、fixed_amount が 80、TaxFeeInfo で 8% の税金が指定されている場合、プロモーション料金は（80 + 80）× 1.08 = 172.8 となります。
  • 3 泊の料金で、AmountAfterTax の値が 100、110、120 で、fixed_amount が 110 の場合、プロモーション料金は 110 × 3 = 330 です。
Promotions / HotelPromotions / Promotion / Discount / @applied_nights 0..1 integer

percentage または fixed_amount_per_night でのみ使用してください。

割引が適用される宿泊日数（最低料金から順に）。1 ～ 99 の整数にする必要があります。指定しない場合、割引はすべての宿泊に適用されます。
Promotions / HotelPromotions / Promotion / Discount / FreeNights 0..1 FreeNights 最低宿泊日数に達した場合の特定の宿泊日数に対する割引を指定します。この要素が使用されている場合、親 Discount 要素の属性は使用できません。
Promotions / HotelPromotions / Promotion / Discount / FreeNights / @stay_nights 1 integer

割引を適用するために必要な宿泊日数。各割引は、個別の宿泊日数に適用されます。

たとえば、10 泊で stay_nights が 4（かつ repeats が true）の場合、2 つの宿泊セグメント（1 泊目から 4 泊目と 5 泊目から 8 泊目）があります。9 泊目と 10 泊目は宿泊セグメントに含まれません。
Promotions / HotelPromotions / Promotion / Discount / FreeNights / @discount_nights 1 integer 滞在日数の各区分に含まれる割引料金。
Promotions / HotelPromotions / Promotion / Discount / FreeNights / @discount_percentage 1 float 宿泊割引に適用される割引。この値が 50 の場合、選択した各泊が 50% 割引になります。
Promotions / HotelPromotions / Promotion / Discount / FreeNights / @night_selection 1 string cheapest または last のいずれかを指定します。last の場合、滞在日数の最終日には割引が適用されます。cheapest の場合、滞在日数の範囲内の最安値に割引が適用されます。
Promotions / HotelPromotions / Promotion / Discount / FreeNights / @repeats 1 boolean

複数の宿泊セグメントに割引を適用できるかどうか。false の場合、旅行プランの開始時の宿泊日数のみが割引されます。true の場合、宿泊のセグメントがすべて割引されます。

たとえば、stay_nights が 4 で旅行プランが 10 泊の場合、repeats が true の場合、2 つのセグメントが割引されます（1 ～ 4 泊と 5 ～ 8 泊）。ただし、repeats が false の場合は、1 つのセグメントのみが割引されます（1 ～ 4 泊）。
Promotions / HotelPromotions / Promotion / Discount / @rank 0..1 integer このプロモーションにランクを割り当てて、ランク付けされた選択にオプトインします。この場合、ランクが最も低いプロモーションのみが適用されます。値は 1 ～ 99 にする必要があります。複数のプロモーションが同じランクを共有している場合は、いずれかのプロモーションが任意に選択されて適用されます。
Promotions / HotelPromotions / Promotion / BestDailyDiscount 1 Discount

Discount または BestDailyDiscount のいずれかを指定する必要があります。

1 泊の宿泊に適用される割引額を指定します。滞在全体に割引を適用する Discount とは対照的です。

各宿泊施設には、「毎日ベスト」とみなされるプロモーションのグループを 1 つ設定できます。つまり、1 泊の宿泊日数に対して、その泊で最も割引率の高い、対象となる「1 日に最適な」プロモーションが 1 つ選択され、適用されます。

Stacking を BestDailyDiscount と同時に指定することはできません。1 泊あたりの割引が最も大きい「1 日のベスト」の割引が組み合わされ、1 泊の割引（Discount）として扱われます。また、積み重ねタイプが base に設定されます。この組み合わせた割引を、対象となる他の <Discount> プロモーションと比較し、それらと併用することで、最も割引率が大きいプロモーション（または組み合わせ）を見つけることができます。BestDailyDiscount または単一の Discount のうち、価格が低い方の組み合わせが選択され、base スタッキング タイプに適用されます。

このタイプの割引では StayDates を指定できますが、application は overlap に設定する必要があります。

.
Promotions / HotelPromotions / Promotion / BestDailyDiscount / @percentage 0..1 float

percentage、fixed_amount、fixed_price のいずれか 1 つのみが必要です。

割引率を指定する 0 ～ 100 の小数値。これは AmountAfterTax（AmountAfterTax が指定されていない場合は AmountBeforeTax）に適用されます。

例:

  • 1 泊の AmountAfterTax が 100 で、percentage が 20 の場合:

    プロモーション率 = AmountAfterTax × (1 - 割引率)

    80.00 = 100 × (1 - 0.2)

  • 宿泊の AmountBeforeTax が 100、percentage が 20、TaxFeeInfo で税金 10 が指定されている場合:

    プロモーションレート = AmountBeforeTax × (1 - 割引率) + 税金

    90.00 = 100 × (1 - 0.2) + 10
Promotions / HotelPromotions / Promotion/ BestDailyDiscount / @fixed_amount 0..1 float

percentage、fixed_amount、fixed_price のいずれか 1 つのみが必要です。

1 つの AmountAfterTax の 1 泊の料金（AmountAfterTax が指定されていない場合は AmountBeforeTax の 1 泊の料金）から差し引かれる定額。1 泊の料金と同じ通貨が使用されます。これが 1 泊の料金の合計よりも大きい場合、結果の値は 0 になります。

例:

  • 1 泊の AmountBeforeTax が 90、AmountAfterTax が 100、fixed_amount が 20 の場合:

    プロモーションレート = AmountAfterTax - 固定割引

    80.00 = 100 - 20

  • 1 泊の AmountBeforeTax が 100、fixed_amount が 20、TaxFeeInfo で 8% の税金が指定されている場合:

    プロモーション料金 = (AmountBeforeTax - 固定割引) × (1 + 税金)

    86.40 = (100 - 20) × 1.08
Promotions / HotelPromotions / Promotion/ BestDailyDiscount / @fixed_price 0..1 float

percentage、fixed_amount、fixed_price のいずれか 1 つのみが必要です。

AmountAfterTax の 1 泊の料金が指定されている場合、税金と手数料を含む 1 泊の料金が指定された値に設定されます。AmountBeforeTax が指定されている場合、AmountAfterTax が指定されているかどうかにかかわらず、宿泊の税引前料金が指定された値に設定されます。1 泊の料金と同じ通貨が使用されます。

例:

  • 1 泊の AmountBeforeTax が 90、AmountAfterTax が 100、fixed_price が 80 の場合、プロモーション料金は 80 です。
  • 1 泊の AmountBeforeTax が 100、fixed_amount が 80、TaxFeeInfo で 8% の税金が指定されている場合:

    プロモーションレート = 固定価格 × (1 + 税金)

    86.40 = 80 × 1.08
Promotions / HotelPromotions / Promotion / InventoryCount 0..1 InventoryCount このプロモーションを適用するために必要な客室数の制限を定義します。割引は、制約を満たす宿泊にのみ適用されます。fixed_amount の割引では使用できません。利用可能な部屋の数は、OTA_HotelInvCountNotifRQ（InvCount）または OTA_HotelAvailNotifRQ（BookingLimit）のいずれかで指定します。
Promotions / HotelPromotions / Promotion / InventoryCount / @min 0..1 integer 1 泊の料金にプロモーションを適用するために必要な空室の最小部屋数。指定しない場合、最小値はありません。
Promotions / HotelPromotions / Promotion / InventoryCount / @max 0..1 integer 1 泊の料金にプロモーションを適用するために必要な客室の最大数。指定しない場合、最大値はありません。
Promotions / HotelPromotions / Promotion / LengthOfStay 0..1 LengthOfStay このプロモーションを適用できる滞在日数の上限を定義します。滞在日数が最小値と最大値の範囲外の場合、プロモーションは適用されません。
Promotions / HotelPromotions / Promotion / LengthOfStay / @min 0..1 integer プロモーションを適用するために滞在で許可される最低宿泊日数。指定しない場合、最小値はありません。
Promotions / HotelPromotions / Promotion / LengthOfStay / @max 0..1 integer プロモーションを適用するために滞在で許可される最大宿泊日数。指定しない場合、最大値はありません。
Promotions / HotelPromotions / Promotion / MembershipRateRule 0..1 MembershipRateRule

関連付けられた割引に対して特定の UI 処理をトリガーするメンバーシップ料金ルールのコンテナ。

<Discount> も指定されていない限り、この要素は指定しないでください。
Promotions / HotelPromotions / Promotion / MembershipRateRule / @id 1 string

メンバーシップ プログラムに関連付けられている 料金ルールの ID。
Promotions / HotelPromotions / Promotion / MinimumAmount 0..1 MinimumAmount プロモーションを適用するために上回る必要がある、1 日の客室料金（AmountBeforeTax または AmountAfterTax のいずれか大きい方を使用）の最小合計を指定します。
Promotions / HotelPromotions / Promotion / MinimumAmount / @before_discount 1 integer プロモーションを適用するために上回る必要がある値。
Promotions / HotelPromotions / Promotion / Occupancy 0..1 Occupancy このプロモーションが適用される定員に関する制限を定義します。利用人数が最小数と最大数の範囲を超えている場合、プロモーションは適用されません。
Promotions / HotelPromotions / Promotion / Occupancy / @min 0..1 integer 割引を適用するには、ユーザー指定の宿泊人数がこの値以上である必要があります。
Promotions / HotelPromotions / Promotion / Occupancy / @max 0..1 integer 割引を適用するには、ユーザー指定の宿泊人数がこの値以下である必要があります。
Promotions / HotelPromotions / Promotion / RatePlans 0..1 RatePlans プロモーションが適用される料金プランのリストのコンテナ。<RatePlans> が指定されていない場合、プロモーションはすべての料金プランに適用されます。
Promotions / HotelPromotions / Promotion / RatePlans / RatePlan 1..n RatePlan 料金プランを指定します。料金プランは、パッケージ、料金、空室状況の組み合わせによって定義されます。この組み合わせは、トランザクション（宿泊施設データ）、OTA_HotelRateAmountNotifRQ、OTA_HotelAvailNotifRQ メッセージで定義され、PackageID で識別されます。
Promotions / HotelPromotions / Promotion / RatePlans / RatePlan / @id 1 string 料金プランの一意の識別子。この値は、Transaction（宿泊施設データ）メッセージの <PackageData> と、<OTA_HotelRateAmountNotifRQ> および <OTA_HotelAvailNotifRQ> メッセージの両方の <StatusApplicationControl> の RatePlanCode 属性の PackageID 値にマッピングされます。 入力可能な最大文字数は 50 文字です。
Promotions / HotelPromotions / Promotion / RoomTypes 0..1 RoomTypes プロモーションが適用される客室タイプのリストのコンテナ。プロモーションは、指定された各 <RoomType> に適用されます。<RoomTypes> が指定されていない場合、プロモーションはすべての客室に適用されます。
Promotions / HotelPromotions / Promotion / RoomTypes / RoomType 1..n RoomType 客室タイプを指定します。客室タイプは、Transaction（宿泊施設データ）メッセージの <RoomData> 要素で定義され、<RoomID> 値を使用して参照されます。（その <RoomID> 値は、OTA_HotelRateAmountNotifRQ メッセージの InvTypeCode 属性でも参照されます）。
Promotions / HotelPromotions / Promotion / RoomTypes / RoomType / @id 1 string インベントリの一意の識別子（客室タイプ）。この値は、Transaction（宿泊施設データ）メッセージの <RoomID> にマッピングされます。入力可能な最大文字数は 50 文字です。
Promotions / HotelPromotions / Promotion / Stacking 0..1 Stacking プロモーションの組み合わせ方法を指定します。指定しない場合、「type」は base とみなされます。
Promotions / HotelPromotions / Promotion / Stacking / @type 1 enum

この設定に応じて、1 つの料金に複数のプロモーションを適用できます。

  • any: 他のプロモーション（none を除く）と組み合わせることができますが、プロモーションの適用順序は保証されません。
  • base: 他のプロモーションの前に、条件を満たす最適な base プロモーションが選択されて適用されます。以前は base_only という名前でした。
  • second: base プロモーション（該当する場合）の後、any プロモーションの前に、最適な second プロモーションが選択されて適用されます。
  • none: 他のプロモーションとの併用はできません。

許可された組み合わせのうち、割引が最も大きいプロモーションのセットが料金に適用されます。
Promotions / HotelPromotions / Promotion / StayDates 0..1 StayDates 季節限定割引など、プロモーションの適用方法を決定する 1 つ以上の期間のコンテナ。
Promotions / HotelPromotions / Promotion / StayDates / @application 1 enum

プロモーションの適用方法を記述します。

指定できる値は次のとおりです。

  • all: 旅行プランのすべての日付が滞在日と重複する場合、旅行プランの各宿泊にプロモーションを適用します。
  • any: 旅行プランの日付が滞在期間内の日付と重複する場合、旅行プラン内のすべての宿泊にプロモーションを適用します。
  • overlap: 滞在日の範囲内の日付と重複する宿泊プランの宿泊にのみプロモーションを適用します。

この属性は常に指定する必要があります。

  • <Discount> で percentage が指定され、application が all または any に設定されている場合、割引は滞在期間全体の割合として適用されます。
  • <Discount> で percentage が指定され、application が overlap に設定されている場合、割引は重複する宿泊料金の 1 泊の料金の割合として適用されます。
  • fixed_amount を指定した <Discount> と、overlap に設定された application は、無効な組み合わせです。
  • <FreeNights> は、すべての application 値をサポートします。overlap の場合、重複する宿泊日数のみが割引要件で考慮されます。
Promotions / HotelPromotions / Promotion / StayDates / DateRange 1..99 DateRange

プロモーションが適用される日付を指定する期間。

YearlessDate 形式もサポートされています。

  • start または end のいずれかが年のない日付である場合、両方とも年のない日付として入力する必要があります。
  • 複数年の年なし期間を設定する場合は、翌年を前後に設定することはできません。代わりに、連続する 2 つの期間として表します。たとえば、{"12-29", "01-05"} は {"12-29", "12-31"} と {"01-01", "01-05"} として表すことができます。
Promotions / HotelPromotions / Promotion / StayDates / DateRange / @start 0..1 Date or YearlessDate 期間の開始日（プロパティのタイムゾーンに基づく）。この日付は、end と同じかそれより前の日付にする必要があります。start が指定されていない場合、開始日に関する期間は実質的に無制限になります。
Promotions / HotelPromotions / Promotion / StayDates / DateRange / @end 0..1 Date or YearlessDate 期間の終了日（プロパティのタイムゾーンに基づく）。その日付を含む期間が含まれます。この日付は、start 以降の日付にする必要があります。end が指定されていない場合、終了日については、期間は事実上無制限になります。
Promotions / HotelPromotions / Promotion / StayDates / DateRange / @days_of_week 0..1 string

日付範囲内の曜日です。指定しない場合、期間内のすべての日が許可されます。文字列内の各文字は日付を示します。たとえば、「MTWHF」は、その日付範囲内で平日を許可することを指定します。

有効な文字は次のとおりです。

  • M（月曜日）
  • T（火曜日）
  • W（水曜日）
  • H（木曜日）
  • F（金曜日）
  • S（土曜日）
  • U（日曜日）

任意の文字の組み合わせが有効です。
Promotions / HotelPromotions / Promotion / UserCountries 0..1 UserCountries プロモーションの対象となるユーザーの所在地（国）をリストするためのコンテナ。指定した場合、リストに記載されている国の対象ユーザーにのみ割引料金が提供されます。指定しない場合、国を問わず、対象ユーザーに割引料金が提供されます。
Promotions / HotelPromotions / Promotion / UserCountries / @type 0..1 enum UserCountry 仕様のタイプ。

有効な値は include と exclude です。

UserCountry の type が include に設定されている場合、リストに記載されている国のユーザーに適用されます。

UserCountry の type が exclude の場合、リストに記載されている国以外のユーザーにプロモーションが適用されます。

UserCountry type が設定されていない場合は、include として扱われ、リストに含まれる国のユーザーにプロモーションが適用されます。
Promotions / HotelPromotions / Promotion / UserCountries / Country 1..300 Country ユーザーがプロモーションの対象となる国を 1 つ定義します。
Promotions / HotelPromotions / Promotion / UserCountries / Country / @code 1 string CLDR 国コード（DE、FR など）。国によっては、CLDR 国コードが 2 文字の ISO 国コードと異なる場合があります。また、CLDR 地域コードもサポートされていません。

例

基本的なメッセージ

次の例は、基本的な Promotions メッセージを示しています。

<?xml version="1.0" encoding="UTF-8"?>
<Promotions partner="account_xyz"
            id="123_abc"
            timestamp="2020-05-18T16:20:00-04:00">
  <HotelPromotions hotel_id="Property_1">
    <Promotion id="1">
      <BookingDates>
         <DateRange start="2020-07-01" end="2020-07-31" days_of_week="MTWHF"/>
         <DateRange start="2020-09-01" end="2020-09-30"/>
      </BookingDates>
      <BookingWindow min="7" max="330"/>
      <CheckinDates>
         <DateRange start="2020-10-01" end="2020-10-31" days_of_week="FSU"/>
      </CheckinDates>
      <CheckoutDates>
         <DateRange start="2020-10-08" end="2020-11-07" days_of_week="FSU"/>
      </CheckoutDates>
      <Devices>
        <Device type="mobile"/>
        <Device type="tablet"/>
      </Devices>
      <Discount percentage="20" applied_nights="2"/>
      <LengthOfStay min="2" max="14"/>
      <RatePlans>
         <RatePlan id="234"/>
         <RatePlan id="567"/>
      </RatePlans>
      <RoomTypes>
         <RoomType id="123"/>
         <RoomType id="456"/>
      </RoomTypes>
      <Stacking type="base"/>
      <UserCountries>
        <Country code="US"/>
        <Country code="GB"/>
      </UserCountries>
    </Promotion>
  </HotelPromotions>
</Promotions>

在庫の条件

次の例は、入荷予定日近くに過剰在庫がある場合に割引を作成する方法を示しています。

<?xml version="1.0" encoding="UTF-8"?>
<Promotions partner="account_xyz"
            id="123_abc"
            timestamp="2020-05-18T16:20:00-04:00">
  <HotelPromotions hotel_id="Property_1">
    <Promotion id="1">
      <BookingWindow max="7"/>
      <Discount percentage="10"/>
      <InventoryCount min="3"/>
    </Promotion>
  </HotelPromotions>
</Promotions>

プロモーションを 1 つ削除する

次の例は、宿泊施設の 1 つのプロモーションを削除する方法を示しています。

<?xml version="1.0" encoding="UTF-8"?>
<Promotions partner="account_xyz"
            id="123_abc"
            timestamp="2020-05-18T16:20:00-04:00">
  <HotelPromotions hotel_id="Property_1">
    <Promotion id="1" action="delete"/>
  </HotelPromotions>
</Promotions>

すべてのプロモーションを削除する

次の例は、宿泊施設のすべてのプロモーションを削除する方法を示しています。

<?xml version="1.0" encoding="UTF-8"?>
<Promotions partner="account_xyz"
            id="123_abc"
            timestamp="2020-05-18T16:20:00-04:00">
  <HotelPromotions hotel_id="Property_1" action="overlay"/>
</Promotions>


すべてのプロモーションを重ねる

次の例は、宿泊施設の <HotelPromotions> を 1 つ以上の新しいプロモーションでオーバーレイする方法を示しています。action="overlay" の場合、現在のメッセージで指定されたプロモーションが保存される前に、保存されているすべてのプロモーションが削除されます。

<?xml version="1.0" encoding="UTF-8"?>
<Promotions partner="account_xyz"
            id="123_abc"
            timestamp="2020-05-18T16:20:00-04:00">
  <HotelPromotions hotel_id="Property_1" action="overlay">
    <Promotion id="1">
      <BookingDates>
         <DateRange start="2020-09-01" end="2020-09-30"/>
      </BookingDates>
      <Discount percentage="10"/>
      <RoomTypes>
         <RoomType id="123"/>
         <RoomType id="456"/>
      </RoomTypes>
      <RatePlans>
         <RatePlan id="234"/>
         <RatePlan id="567"/>
      </RatePlans>
      <Stacking type="base"/>
    </Promotion>
  </HotelPromotions>
</Promotions>

3 種類のスタッキング タイプ

次の例は、3 つの異なるプロモーション（base、second、any）が適用される場合を示しています。他のプロモーションのほうが割引率が高いため、none プロモーションは適用されません。元の価格が $100 の場合、割引価格は $72.90 になります。

<?xml version="1.0" encoding="UTF-8"?>
<Promotions partner="account_xyz"
            id="123_abc"
            timestamp="2020-05-18T16:20:00-04:00">
  <HotelPromotions hotel_id="Property_1">
    <Promotion id="1">
      <Discount percentage="10"/>
      <Stacking type="base"/>
    </Promotion>
    <Promotion id="2">
      <Discount percentage="10"/>
      <Stacking type="second"/>
    </Promotion>
    <Promotion id="3">
      <Discount percentage="10"/>
      <Stacking type="any"/>
    </Promotion>
    <Promotion id="4">
      <Discount percentage="25"/>
      <Stacking type="none"/>
    </Promotion>
  </HotelPromotions>
</Promotions>

スタッキングなし

次の例は、他のプロモーションを組み合わせると割引が小さくなるため、none プロモーションを使用する場合を示しています。元の価格が $100 の場合、割引価格は $75 になります。

<?xml version="1.0" encoding="UTF-8"?>
<Promotions partner="account_xyz"
            id="123_abc"
            timestamp="2020-05-18T16:20:00-04:00">
  <HotelPromotions hotel_id="Property_1">
    <Promotion id="1">
      <Discount percentage="10"/>
      <Stacking type="base"/>
    </Promotion>
    <Promotion id="2">
      <Discount percentage="10"/>
      <Stacking type="any"/>
    </Promotion>
    <Promotion id="3">
      <Discount percentage="25"/>
      <Stacking type="none"/>
    </Promotion>
  </HotelPromotions>
</Promotions>


予約可能期間の設定

次の例は、BookingWindow 要素を使用し、開始境界と終了境界が ISO 8601 の Duration タイプとして定義されている場合を示しています。この予約可能期間の制限により、到着前日の 18:00 まで、および到着 2 日目の 12:00 以降に予約する必要があります。

<?xml version="1.0" encoding="UTF-8"?>
<Promotions partner="account_xyz"
            id="123_abc"
            timestamp="2020-05-18T16:20:00-04:00">
  <HotelPromotions hotel_id="Property_1">
    <Promotion id="1">
      <BookingWindow min="P1DT6H" max="P2DT12H"/>
      <Discount percentage="20"/>
    </Promotion>
  </HotelPromotions>
</Promotions>

予約日および日時の境界

次の例は、BookingDates 要素が DateTime 型として start 属性と end 属性とともに使用されている場合を示しています。この予約日の制限により、2020 年 7 月 1 日の 06:30 から 2020 年 7 月 2 日の 18:45 までの間に予約する必要があります。

<?xml version="1.0" encoding="UTF-8"?>
<Promotions partner="account_xyz"
            id="123_abc"
            timestamp="2020-05-18T16:20:00-04:00">
  <HotelPromotions hotel_id="Property_1">
    <Promotion id="1">
      <BookingDates>
         <DateRange start="2020-07-01T06:30:00" end="2020-07-02T18:45:00"/>
      </BookingDates>
      <Discount percentage="20"/>
    </Promotion>
  </HotelPromotions>
</Promotions>

年なしの期間

次の例は、CheckInDates 要素に、年のない start フィールドと end フィールドを持つ DateRanges が含まれている場合を示しています。この例では、年に関係なく、プロモーションは 12 月 29 日から 1 月 2 日までのチェックイン日に適用されます。新しい年の境界を超える年なしの期間は無効であるため、DateRange は隣接する 2 つの期間として表されます。

<?xml version="1.0" encoding="UTF-8"?>
<Promotions partner="account_xyz"
            id="123_abc"
            timestamp="2020-05-18T16:20:00-04:00">
  <HotelPromotions hotel_id="Property_1">
    <Promotion id="1">
      <CheckInDates>
         <DateRange start="12-29" end="12-31"/>
         <DateRange start="01-01" end="01-02"/>
      </CheckInDates>
      <Discount percentage="20"/>
    </Promotion>
  </HotelPromotions>
</Promotions>


FreeNights の割引

次の例では、指定された予約日における 4 泊に対して 2 泊分の 50% の割引が適用されます。10 泊の旅行プランの場合、合計 4 泊の宿泊料金が 50% 割引になります。

<?xml version="1.0" encoding="UTF-8"?>
<Promotions partner="account_xyz"
            id="123_abc"
            timestamp="2020-05-18T16:20:00-04:00">
  <HotelPromotions hotel_id="Property_1">
    <Promotion id="1">
      <BookingDates>
        <DateRange start="2022-01-01" end="2022-05-31"/>
      </BookingDates>
      <Discount>
        <FreeNights stay_nights="4" discount_nights="2" discount_percentage="50" night_selection="cheapest" repeats="true"/>
      </Discount>
    </Promotion>
  </HotelPromotions>
</Promotions>

次の例では、指定された滞在日における 3 泊ごとに 1 泊 50% の割引が適用されます。重複する宿泊日数のみが割引の対象になります。チェックインが 2022 年 1 月 1 日、チェックアウトが 2022 年 1 月 7 日である以下の宿泊プランには、対象となる宿泊日数と割引が適用されます。

  • 2022-01-01（宿泊）
  • 2022-01-02（宿泊）
  • 2022-01-03
  • 2022-01-04（割引済み）
  • 2022-01-05（宿泊）
  • 2022-01-06（宿泊）
<?xml version="1.0" encoding="UTF-8"?>
<Promotions partner="account_xyz"
            id="123_abc"
            timestamp="2020-05-18T16:20:00-04:00">
  <HotelPromotions hotel_id="Property_1">
    <Promotion id="1">
      <StayDates application="overlap">
        <DateRange start="2022-01-01" end="2022-01-02"/>
        <DateRange start="2022-01-04" end="2022-01-06"/>
      </StayDates>
      <Discount>
        <FreeNights stay_nights="3" discount_nights="1" discount_percentage="50" night_selection="last" repeats="true"/>
      </Discount>
    </Promotion>
  </HotelPromotions>
</Promotions>


ランク付けされたセレクション

次の例では、20% オフと 15% オフの 2 つの割引を提供しています。評価中はランクが低い 15% の割引のみが適用されます。

<?xml version="1.0" encoding="UTF-8"?>
<Promotions partner="account_xyz"
            id="123_abc"
            timestamp="2020-05-18T16:20:00-04:00">
  <HotelPromotions hotel_id="Property_1">
    <Promotion id="1">
      <Discount percentage="15" rank="25"/>
    </Promotion>
    <Promotion id="2">
      <Discount percentage="20" rank="50"/>
    </Promotion>
  </HotelPromotions>
</Promotions>

BestDailyDiscount

次の例では、Discount で積み重ねられた BestDailyDiscount を適用して、2 泊の宿泊を割引します。

<?xml version="1.0" encoding="UTF-8"?>
<Promotions partner="account_xyz"
            id="123_abc"
            timestamp="2020-05-18T16:20:00-04:00">
 <HotelPromotions hotel_id="HotelID" action="overlay">
   <Promotion id="general">
     <BestDailyDiscount fixed_amount="20"/>
   </Promotion>
   <Promotion id="may">
     <BestDailyDiscount fixed_amount="50"/>
     <StayDates application="overlap">
        <DateRange start="2023-05-01" end="2023-05-31"/>
     </StayDates>
   </Promotion>
   <Promotion id="fiesta">
     <Discount fixed_amount_per_night="5"/>
     <Stacking type="any"/>
   </Promotion>
 </HotelPromotions>
</Promotions>

2023 年 4 月 30 日から 2023 年 5 月 2 日までの 2 泊の滞在を考えてみましょう。計算では、最も割引率の高い、1 日ごとの最適な割引の組み合わせが最初に見つかります。

1 泊目は「一般」プロモーションのみ、固定割引（20）が適用されます。

2 泊目は「通常」割引よりも大幅な割引になります。そのため「50%」を選択すると、固定割引額は 50 になります。

滞在については「フィエスタ」プロモーションの割引は 1 泊あたり 5 回、合計 10 回になります。「fiesta」のスタッキング タイプは any に設定されているため、最良の日別割引と組み合わせて併用できます。base に設定した場合は、最良の日別割引または「フィエスタ」割引の組み合わせのみが適用されます。詳細については、Stacking の説明をご覧ください。

全体として、宿泊料金には 20 + 50 + 10 = 80 の固定額割引が適用されます。

レスポンス

構文

PromotionsResponse メッセージには次の構文が使用されます。

<?xml version="1.0" encoding="UTF-8"?>
<PromotionsResponse timestamp="timestamp"
                    id="message_ID"
                    partner="partner_key">
  <!-- Either Success or Issues are populated. -->
  <Success/>
  <Issues>
    <Issue code="issue_code"
           status="issue_type">
      issue_description
    </Issue>
  </Issues>
</PromotionsResponse>

要素と属性

PromotionsResponse メッセージには、次の要素と属性があります。

要素 / @Attribute 発生回数 タイプ 説明
PromotionsResponse 1 Complex element 受信した Promotions リクエスト メッセージの成功または問題を示すルート要素。
PromotionsResponse / @timestamp 1 DateTime このメッセージの作成日時。
PromotionsResponse / @id 1 string 関連付けられたプロモーション メッセージからの一意の識別子。
PromotionsResponse / @partner 1 string このメッセージのパートナー アカウント。
PromotionsResponse / Success 0..1 Success Promotions メッセージが正常に処理され、警告、エラー、失敗がなかったことを示します。

各メッセージには、<Success> または <Issues> のいずれかが存在します。
PromotionsResponse / Issues 0..1 Issues プロモーション メッセージの処理中に発生した 1 つ以上の問題のコンテナ。

各メッセージには、<Success> または <Issues> のいずれかが存在します。
PromotionsResponse / Issues / Issue 1..n Issue Promotions メッセージの処理中に発生した警告、エラー、失敗の説明。これらの問題の詳細については、フィード ステータスのエラー メッセージをご覧ください。
PromotionsResponse / Issues / Issue / @code 1 integer 問題の識別子。
PromotionsResponse / Issues / Issue / @status 1 enum

発生した問題の種類。

有効な値は warning、error、failure です。

例

完了

以下は、正常に処理されたプロモーション メッセージに対するレスポンスです。

<?xml version="1.0" encoding="UTF-8"?>
<PromotionsResponse timestamp="2020-05-18T16:20:00-04:00"
                    id="12345678"
                    partner="partner_key">
  <Success/>
</PromotionsResponse>

問題

エラーのため処理されなかったプロモーション メッセージに対するレスポンスは次のとおりです。

<?xml version="1.0" encoding="UTF-8"?>
<PromotionsResponse timestamp="2020-05-18T16:20:00-04:00"
                    id="12345678"
                    partner="partner_key">
  <Issues>
    <Issue code="1001" status="error">Example</Issue>
  </Issues>
</PromotionsResponse>