概要
この 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, percentage_of_base, 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" percentage_of_base="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>
要素と属性
Promotions メッセージには、次の要素と属性があります。
| 要素 / @属性 | 発生回数 | タイプ | 説明 | 
|---|---|---|---|
| Promotions | 1 | Complex element | Promotions メッセージのルート要素。 | 
| Promotions / @partner | 1 | string | このメッセージのパートナー アカウント。この文字列の値は、Hotel Center の 
        [アカウント設定] ページに表示されている [パートナーキー] の値です。 複数のアカウントのフィードを提供するバックエンドを使用している場合、この値は、同じアカウントの  | 
| Promotions / @id | 1 | string | このリクエスト メッセージの一意の識別子。この値はレスポンス メッセージ内で返されます。使用できる文字は、a ~ z、A ~ Z、0 ~ 9、_(アンダースコア)、-(ダッシュ)です。 | 
| Promotions / @timestamp | 1 | DateTime | このメッセージの作成日時。 | 
| Promotions / HotelPromotions | 0..n | HotelPromotions | 宿泊施設のプロモーション。各プロモーションは 1 つの宿泊施設に適用されます。 
 | 
| Promotions / HotelPromotions / @hotel_id | 1 | string | 宿泊施設の一意の識別子。この値は、ホテルリスト フィードの <listing>要素の<id>を使用して指定した HotelID と一致する必要があります。HotelID は Hotel Center にも表示されます。 | 
| Promotions / HotelPromotions / @action | 0..1 | enum | 指定する場合、値は  指定しない場合、現在のメッセージで指定されている各プロモーションは次のいずれかになります。 
 | 
| Promotions / HotelPromotions / Promotion | 0..99 | Promotion | 宿泊施設の 1 件のプロモーション。 99 件以上のプロモーションを使用する必要がある場合は、テクニカル アカウント マネージャー(TAM)にお問い合わせください。 | 
| Promotions / HotelPromotions / Promotion / @id | 1 | string | プロモーションの一意の識別子。最大 40 文字まで使用できます。使用できる文字は、a ~ z、A ~ Z、0 ~ 9、_(アンダースコア)、-(ダッシュ)、. です。(ピリオド)です。 | 
| Promotions /HotelPromotions / Promotion / @action | 0..1 | enum | 指定する場合、値は  
 | 
| 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 | 期間の開始日または日時(宿泊施設のタイムゾーンに基づく)。 
 | 
| Promotions / HotelPromotions / Promotion / BookingDates / DateRange / @end | 0..1 | Date または DateTime | 期間の終了日または日時(宿泊施設のタイムゾーンに基づく)。 
 | 
| Promotions / HotelPromotions / Promotion / BookingDates / DateRange / @days_of_week | 0..1 | string | 期間で許可される曜日です。指定しないと、期間内のすべての曜日が許可されます。文字列の各文字で曜日を指定します。たとえば、「MTWHF」は、期間で平日を許可することを指定します。 有効な文字は次のとおりです。 
 任意の文字の組み合わせが有効です。 | 
| Promotions / HotelPromotions / Promotion / BookingWindow | 0..1 | BookingWindow | チェックイン日を基準にして予約が行われる必要がある期間を指定します(宿泊施設のタイムゾーンに基づく)。たとえば、予約期間には、チェックインの 7 日前から 180 日前までを設定できます。 | 
| Promotions / HotelPromotions / Promotion / BookingWindow / @min | 0..1 | integer or duration | プロモーションを適用するために予約が行われる必要がある場合の、チェックイン前の最小期間。これが指定されていない場合、または値が 0の場合、最小値はありません。有効な値の型は次のとおりです。 
 | 
| Promotions / HotelPromotions / Promotion / BookingWindow / @max | 0..1 | integer or duration | プロモーションを適用するために予約が行われる必要がある場合の、チェックイン前の最大日数です。これが指定されていない場合、または値が 0の場合、最大値はありません。有効な値の型は次のとおりです。 
 | 
| Promotions / HotelPromotions / Promotion / Ceiling | 0..1 | Ceiling | プロモーションを適用した後に料金に設定できる最大値に関する制限を定義します。 プロモーションでは常に  重ね合わせが構成されている場合、 例: 
 
 計算順序は次のとおりです。 
 60 が全体的な上限としてより厳しいという点は、その上限が独自のプロモーションにのみ有効であり、プロモーション スタック全体にまたがる単一の上限が存在しないため、無関係です。 | 
| Promotions / HotelPromotions / Promotion / Ceiling / @amount_per_night | 1 | float | 割引を適用した後の宿泊料金の最大額。 
 
 | 
| Promotions / HotelPromotions / Promotion / Floor | 0..1 | Floor | プロモーションを適用した後に料金に設定できる最小値に関する制限を定義します。 プロモーションでは常に  無料宿泊に  重ね合わせが構成されている場合、 例: 
 
 計算順序は次のとおりです。 
 90 が全体的な下限としてより厳しいという点は、そのプロモーションにのみ有効であり、プロモーション スタック全体にわたる単一の下限を設定できないため、無関係です。 | 
| Promotions / HotelPromotions / Promotion / Floor / @amount_per_night | 1 | float | 割引が適用された後の宿泊料金の最小額。 
 
 | 
| Promotions / HotelPromotions / Promotion / CheckinDates | 0..1 | CheckinDates | プロモーションを適用するためにチェックインが行われる必要があるタイミングを定義する 1 つ以上の期間のコンテナ。 | 
| Promotions / HotelPromotions / Promotion / CheckinDates / DateRange | 1..20 | DateRange | プロモーションを適用するためにチェックインが行われる必要があるタイミングを指定する期間。1 件以上のプロモーションを削除する場合、この要素は不要です。 YearlessDate 形式もサポートされています。 
 | 
| 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」は、期間で平日を許可することを指定します。 有効な文字は次のとおりです。 
 任意の文字の組み合わせが有効です。 | 
| Promotions / HotelPromotions / Promotion / CheckoutDates | 0..1 | CheckoutDates | プロモーションを適用するためにチェックアウトが行われる必要があるタイミングを定義する 1 つ以上の期間のコンテナ。 | 
| Promotions / HotelPromotions / Promotion / CheckoutDates / DateRange | 1..20 | DateRange | プロモーションを適用するためにチェックアウトが行われる必要があるタイミングを指定する期間。1 件以上のプロモーションを削除する場合、この要素は不要です。 YearlessDate 形式もサポートされています。 
 | 
| 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」は、期間で平日を許可することを指定します。 有効な文字は次のとおりです。 
 任意の文字の組み合わせが有効です。 | 
| 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 | 
 このプロモーションに適用する割引を指定します。 | 
| Promotions / HotelPromotions / Promotion / Discount / @percentage | 0..1 | float | 
 割引率を指定する 0 ~ 100 の 10 進値。これは  例: 
 | 
| Promotions / HotelPromotions / Promotion / Discount / @percentage_of_base | 0..1 | float | 
 基本割引の割合を指定する 0 ~ 100 の 10 進値。 
 例: 
 | 
| Promotions / HotelPromotions / Promotion / Discount / @fixed_amount | 0..1 | float | 
 
 例: 
 | 
| Promotions / HotelPromotions / Promotion / Discount / @fixed_amount_per_night | 0..1 | float | 
 
 例: 
 | 
| Promotions / HotelPromotions / Promotion / Discount / @fixed_price | 0..1 | float | 
 1 泊の料金として  
 例: 
 | 
| Promotions / HotelPromotions / Promotion / Discount / @fixed_price_per_night | 0..1 | float | 
 
 
 
 例: 
 | 
| Promotions / HotelPromotions / Promotion / Discount / @applied_nights | 0..1 | integer | これは  割引が適用される宿泊日数(最安値が先頭)。1 ~ 99 の整数を指定する必要があります。指定しない場合、すべての宿泊に割引が適用されます。 | 
| Promotions / HotelPromotions / Promotion / Discount / FreeNights | 0..1 | FreeNights | 最低宿泊日数を満たした場合の滞在中の特定の泊数に対する割引を指定します。この要素を使用する場合、親 Discount要素の属性は使用できません。 | 
| Promotions / HotelPromotions / Promotion / Discount / FreeNights / @stay_nights | 1 | integer | 割引を適用するために必要な宿泊日数。各割引は、宿泊日数の個別のセグメントに適用されます。 たとえば、 | 
| 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 | 割引を複数の宿泊日数セグメントに適用できるかどうか。 たとえば、 | 
| Promotions / HotelPromotions / Promotion / Discount / @rank | 0..1 | integer | このプロモーションにランクを割り当て、ランク選択に登録します。ランク選択では、ランクが最も低いプロモーションのみが適用対象として選択されます。値は 1 ~ 99 の範囲で指定する必要があります。複数のプロモーションが同じランクを共有している場合は、1 つが任意に選択されて適用されます。 | 
| Promotions / HotelPromotions / Promotion / BestDailyDiscount | 1 | Discount | 
 1 泊に適用できる 1 日あたりの割引を指定します。これは、滞在全体に割引を適用する  各プロパティには、「1 日あたりのベスト」と見なされるプロモーションのグループを 1 つ設定できます。つまり、宿泊する 1 泊ごとに、その夜に適用できる割引率が最も高い「1 日あたりの最適な」プロモーション 1 つが選択され、適用される可能性があります。 
 このタイプの割引で  | 
| Promotions / HotelPromotions / Promotion / BestDailyDiscount / @percentage | 0..1 | float | 
 割引率を指定する 0 ~ 100 の 10 進値。これは  例: 
 | 
| Promotions / HotelPromotions / Promotion/ BestDailyDiscount / @fixed_amount | 0..1 | float | 
 1 泊あたりの  例: 
 | 
| Promotions / HotelPromotions / Promotion/ BestDailyDiscount / @fixed_price | 0..1 | float | 
 
 例: 
 | 
| Promotions / HotelPromotions / Promotion / InventoryCount | 0..1 | InventoryCount | このプロモーションを適用するために必要な空室の客室数に関する制限を定義します。割引は、制約を満たす宿泊にのみ適用されます。 fixed_amountの割引とは併用できません。空室の数は、OTA_HotelInvCountNotifRQ(InvCount)と OTA_HotelAvailNotifRQ(BookingLimit)のいずれかを使用して指定します。 | 
| Promotions / HotelPromotions / Promotion / InventoryCount / @min | 0..1 | integer | 宿泊料金にプロモーションを適用するために空室である必要がある客室の最小数。これが指定されていない場合、最小値はありません。 | 
| Promotions / HotelPromotions / Promotion / InventoryCount / @max | 0..1 | integer | 宿泊料金にプロモーションを適用するために空室である必要がある客室の最大数。これが指定されていない場合、最大値はありません。 | 
| 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 処理をトリガーするメンバーシップ料金ルールのコンテナ。 
 | 
| 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 | 料金プランを指定します。料金プランは、パッケージ、料金、空室状況の組み合わせで定義されます。また、Transaction(宿泊施設データ)、OTA_HotelRateAmountNotifRQ、OTA_HotelAvailNotifRQ の各メッセージにより定義され、PackageID により識別されます。 | 
| Promotions / HotelPromotions / Promotion / RatePlans / RatePlan / @id | 1 | string | 料金プランの一意の識別子。この値は PackageID の値に対応します。PackageID の値は、Transaction(宿泊施設データ)メッセージの <PackageData>と、<OTA_HotelRateAmountNotifRQ>メッセージと<OTA_HotelAvailNotifRQ>メッセージ両方の<StatusApplicationControl>のRatePlanCode属性にあります。最大 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 つの料金に複数のプロモーションを適用できます。 
 許可されている組み合わせの中で、割引が最大であるプロモーションのセットが料金に適用されます。 | 
| Promotions / HotelPromotions / Promotion / StayDates | 0..1 | StayDates | 季節割引に対応するためなど、プロモーションの適用方法を決定する 1 つ以上の期間のコンテナ。 | 
| Promotions / HotelPromotions / Promotion / StayDates / @application | 1 | enum | プロモーションの適用方法を記述します。 指定できる値は次のとおりです。 
 この属性は常に指定する必要があります。 
 | 
| Promotions / HotelPromotions / Promotion / StayDates / DateRange | 1..99 | DateRange | プロモーションを適用する日付を指定する期間。 YearlessDate 形式もサポートされています。 
 特定の曜日にプロモーションを許可するように  | 
| 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を指定しない場合、期間はstart日以降の実質的に無制限となります。
 | 
| Promotions / HotelPromotions / Promotion / StayDates / DateRange / @days_of_week | 0..1 | string | 期間で許可される曜日です。指定しないと、期間内のすべての曜日が許可されます。文字列の各文字で曜日を指定します。たとえば、「MTWHF」は、期間で平日を許可することを指定します。 有効な文字は次のとおりです。 
 任意の文字の組み合わせが有効です。 | 
| Promotions / HotelPromotions / Promotion / UserCountries | 0..1 | UserCountries | プロモーションの対象となるユーザーの所在地(国)をリストするコンテナ。指定した場合は、リストにある国の対象ユーザーにのみ割引料金が提供されます。指定しない場合は、すべての国の対象ユーザーに割引料金が提供されます。 | 
| Promotions / HotelPromotions / Promotion / UserCountries / @type | 0..1 | enum | UserCountries 仕様のタイプ。 有効な値は  UserCountries  UserCountries  UserCountries  | 
| Promotions / HotelPromotions / Promotion / UserCountries / Country | 1..300 | Country | ユーザーがプロモーションの対象となる国を 1 つ定義します。 | 
| Promotions / HotelPromotions / Promotion / UserCountries / Country / @code | 1 | string | CLDR 国コード( DEやFRなど)。国によっては、CLDR 国コードが 2 文字の ISO 国コードと同じではないことに注意してください。また、CLDR 地域コードはサポートされていません。 | 
例
宿泊施設あたりのプロモーション数の上限は 500 件です。宿泊施設からプロモーションを削除するには、「1 件のプロモーションを削除する」の例を参照してください。
基本的なメッセージ
次の例に基本的な 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>
すべてのプロモーションをオーバーレイする
次の例は、1 つ以上の新しいプロモーションが含まれる宿泊施設の <HotelPromotions> をオーバーレイする方法を示しています。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 要素が start 属性と end 属性で DateTime 型として使用されている場合を示しています。この予約日付の制限では、2020 年 7 月 1 日 6 時 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 泊目については、「5 月」プロモーションで「一般」割引よりも割引率が高くなっています。したがって、[may] が選択されている場合、固定割引額は 50 になります。
宿泊については、「fiesta」プロモーションにより 1 泊あたり 5 ドル、合計 10 ドルの割引が適用されます。「fiesta」のスタッキング タイプが any に設定されているため、この割引は、最適な日別割引と組み合わせてスタッキングできます。base に設定されている場合、最適な日別割引と「fiesta」割引の組み合わせのみが適用されます。詳細については、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 メッセージには、次の要素と属性があります。
| 要素 / @属性 | 発生回数 | タイプ | 説明 | 
|---|---|---|---|
| PromotionsResponse | 1 | Complex element | 受信した Promotions Request メッセージの成功または問題を示すルート要素。 | 
| PromotionsResponse / @timestamp | 1 | DateTime | このメッセージの作成日時。 | 
| PromotionsResponse / @id | 1 | string | 関連する Promotions メッセージから得られる一意の識別子。 | 
| PromotionsResponse / @partner | 1 | string | このメッセージのパートナー アカウント。 | 
| PromotionsResponse / Success | 0..1 | Success | Promotions メッセージが正常に(警告、エラー、失敗が発生せずに)処理されたことを示します。 各メッセージには、 | 
| PromotionsResponse / Issues | 0..1 | Issues | Promotions メッセージの処理中に発生した 1 つ以上の問題のコンテナ。 各メッセージには、 | 
| PromotionsResponse / Issues / Issue | 1..n | Issue | Promotions メッセージの処理中に発生した警告、エラー、または失敗の説明。これらの問題の詳細については、フィード ステータスのエラー メッセージをご覧ください。 | 
| PromotionsResponse / Issues / Issue / @code | 1 | integer | 問題の識別子。 | 
| PromotionsResponse / Issues / Issue / @status | 1 | enum | 発生した問題の種類。 有効な値は  | 
例
成功
以下は、正常に処理された Promotions メッセージに対するレスポンスです。
<?xml version="1.0" encoding="UTF-8"?>
<PromotionsResponse timestamp="2020-05-18T16:20:00-04:00"
                    id="12345678"
                    partner="partner_key">
  <Success/>
</PromotionsResponse>
問題
以下は、エラーのため処理されなかった Promotions メッセージに対するレスポンスです。
<?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>