Hotel API リファレンス

  • [アーティクル]

注:

このベータ版のHotel Price Adsは、一部の参加者のみが利用できます。 ベータ リリース プログラムへの参加の詳細については、アカウント マネージャーに問い合わせるか、 こちらで登録してください。

API とドキュメントは変更される可能性があります。

Hotel API を使用すると、ホテル広告キャンペーンと入札を管理できます。

エンドポイント

エンドポイントの構築に使用するベース URI を次に示します。

  • 運用—https://partner.api.bingads.microsoft.com/Travel/v1/

エンドポイントには、顧客とアカウントのリソースが含まれている必要があります。

https://partner.api.sandbox.bingads.microsoft.com/Travel/V1/Customers({customerId})/Accounts({accountId})/

{customerId} を顧客の CustomerId に、{accountId} を顧客の CustomerAccountId に設定します。

次に、次の表のテンプレートを追加して、ホテルリソースを追加、取得、更新します。 たとえば、ホテル グループを取得または追加するには、次のエンドポイントを使用します。

https://partner.api.sandbox.bingads.microsoft.com/Travel/V1/Customers({customerId})/Accounts({accountId})/SubAccounts('{subAccountId}')/HotelGroups

注:

SubAccounts、HotelGroups、Hotels、ReportJobs の ID は文字列であり、単一引用符で囲む必要があります。 たとえば、SubAccounts('12345')/HotelGroups です。 これは SubAccounts、HotelGroups、Hotels、ReportJobs にのみ適用されます。顧客とアカウントには単一引用符を使用しないでください。

SubAccounts テンプレート

動詞 説明
取得 指定したアカウントに対して定義された宿泊キャンペーン (旧称ホテル キャンペーン) の一覧を取得します。

注: 既定では、リストには最大 1,000 個のキャンペーンが含まれています。 サブアカウント内のキャンペーンの合計数を確認するには、 $count クエリ パラメーターを使用します。 返すキャンペーンの数を指定するには、 $top クエリ パラメーターを使用します。 サブアカウント内のすべてのキャンペーンをページングするには、$topと $skip クエリ パラメーターを使用します。

応答本文: CollectionResponse オブジェクトが 含まれています。 valueフィールドには、SubAccount オブジェクトの一覧が含まれています。
投稿 指定したアカウントにサブアカウントを追加します。 サブアカウントは宿泊キャンペーンと考えることができます。 サブアカウントを使用して、ホテル広告キャンペーンを論理的に整理します。 アカウントごとに最大 50 件のアクティブな宿泊キャンペーンを利用できます。

要求本文: 追加する SubAccount が含まれます。

応答本文: 成功した場合は、 AddResponse オブジェクトが 含まれます。 valueフィールドには、追加された宿泊キャンペーンの ID が含まれます。

SubAccounts('{subAccountId}') テンプレート

動詞 説明
取得 指定したサブアカウントを取得します。

応答本文: SubAccount オブジェクトが含まれています。

テンプレート パラメーター:
  • {subAccountId}—取得するサブアカウントの ID に設定します。
PATCH サブアカウントを更新します。

要求本文: 更新するフィールドのみを指定する SubAccount オブジェクトが含まれています。

応答本文: なし。 成功した場合は、HTTP 状態コード 204 を返します。

テンプレート パラメーター:
  • {subAccountId}—更新するサブアカウントの ID に設定します。

SubAccounts('{subAccountId}')/HotelGroups テンプレート

動詞 説明
取得 指定したサブアカウント内のホテル グループの一覧を取得します。

注: 既定では、リストには最大 1,000 個のホテル グループが含まれています。 サブアカウント内のグループの合計数を確認するには、 $count クエリ パラメーターを使用します。 返すグループの数を指定するには、 $top クエリ パラメーターを使用します。 サブアカウント内のすべてのグループをページングするには、$topと $skip クエリ パラメーターを使用します。

応答本文: CollectionResponse オブジェクトが 含まれています。 valueフィールドには、HotelGroup オブジェクトの一覧が含まれています。

テンプレート パラメーター:
  • {subAccountId}—取得するホテル グループを含むサブアカウントの ID に設定します。
投稿 指定したサブアカウントにホテル グループを追加します。 ホテル グループを使用して、ホテル価格広告の論理グループを作成します。 サブアカウントごとに最大 1,000 のアクティブなホテル グループを作成できます。

要求本文: サブアカウントに追加する HotelGroup が含まれています。

応答本文: 成功した場合は、 AddResponse オブジェクトが 含まれます。 valueフィールドには、追加されたホテル グループの ID が含まれます。

テンプレート パラメーター:
  • {subAccountId}—ホテル グループを追加するサブアカウントの ID に設定します。

SubAccounts('{subAccountId}')/HotelGroups('{hotelGroupId}') テンプレート

動詞 説明
取得 指定したホテル グループを取得します。

応答本文: HotelGroup オブジェクトが含まれます。

テンプレート パラメーター:
  • {subAccountId}—ホテル グループを含むサブアカウントの ID に設定します。
  • {hotelGroupId}取得するホテル グループの ID に設定します。
PATCH ホテル グループを更新します。

要求本文: 更新するフィールドのみを指定する HotelGroup オブジェクトが含まれます。

応答本文: なし。 成功した場合は、HTTP 状態コード 204 を返します。

テンプレート パラメーター:
  • {subAccountId}—ホテル グループを含むサブアカウントの ID に設定します。
  • {hotelGroupId}更新するホテル グループの ID に設定します。
削除 ホテル グループを削除します。

要求本文: なし。

応答本文: なし。 成功した場合は、HTTP 状態コード 204 を返します。

テンプレート パラメーター:
  • {subAccountId}—ホテル グループを含むサブアカウントの ID に設定します。
  • {hotelGroupId}削除するホテル グループの ID に設定します。

SubAccounts('{subAccountId}')/Hotels テンプレート

動詞 説明
取得 指定したサブアカウント内のホテル価格広告の一覧を取得します。 このリストには、サブアカウント内のすべてのホテル グループのすべてのホテルが含まれています。

注: 既定では、リストには最大 1,000 軒のホテルが含まれています。 サブアカウント内のホテルの合計数を確認するには、 $count クエリ パラメーターを使用します。 返すホテルの数を指定するには、 $top クエリ パラメーターを使用します。 サブアカウント内のすべてのホテルをページングするには、$topと $skip クエリ パラメーターを使用します。

注: この呼び出しを使用して、UI エクスペリエンスでのみホテルを通じてページを表示します。 この呼び出しを使用してすべてのホテルをダウンロードしないでください。 すべてのホテルをダウンロードするには、代わりに レポート機能を 使用します。

応答本文: CollectionResponse オブジェクトが 含まれています。 フィールドには value 、 Hotel オブジェクトの一覧が含まれます。

テンプレート パラメーター:
  • {subAccountId}—取得するホテルを含むサブアカウントの ID に設定します。
.

SubAccounts('{subAccountId}')/HotelGroups('{hotelGroupId}')/ホテルテンプレート

動詞 説明
取得 指定したホテル グループ内のホテル価格広告の一覧を取得します。

注: 既定では、リストには最大 1,000 軒のホテルが含まれています。 ホテル グループ内のホテルの合計数を確認するには、 $count クエリ パラメーターを使用します。 返すホテルの数を指定するには、 $top クエリ パラメーターを使用します。 グループ内のすべてのホテルをページングするには、$topと $skip クエリ パラメーターを使用します。

注: この呼び出しを使用して、UI エクスペリエンスでのみホテルを通じてページを表示します。 この呼び出しを使用してすべてのホテルをダウンロードしないでください。 すべてのホテルをダウンロードするには、代わりに レポート機能を 使用します。

応答本文: CollectionResponse オブジェクトが 含まれています。 フィールドには value 、 Hotel オブジェクトの一覧が含まれます。

テンプレート パラメーター:
  • {subAccountId}—ホテル グループを含むサブアカウントの ID に設定します。
  • {hotelGroupId}—取得するホテルを含むホテル グループの ID に設定します。
.

SubAccounts('{subAccountId}')/HotelGroups('{hotelGroupId}')/Hotels('{hotelId}') テンプレート

動詞 説明
取得 指定したホテル広告を取得します。

応答本文: Hotel オブジェクトが含まれています。

テンプレート パラメーター:
  • {subAccountId}—ホテル グループを含むサブアカウントの ID に設定します。
  • {hotelGroupId}取得するホテルを含むホテル グループの ID に設定します。
  • {hotelId}—取得するホテル広告に設定します。
PATCH ホテルの広告を更新します。

要求本文: 更新するフィールドのみを指定する Hotel オブジェクトが含まれています。

応答本文: なし。 成功した場合は、HTTP 状態コード 204 を返します。

テンプレート パラメーター:
  • {subAccountId}—ホテル グループを含むサブアカウントの ID に設定します。
  • {hotelGroupId}更新するホテルを含むホテル グループの ID に設定します。
  • {hotelId}更新するホテルの ID に設定します。 このパラメーターは、Microsoft がホテルに割り当てた ID、または広告主がホテルに割り当てた ID に設定できます。 広告主の ID に設定する場合は、クエリ パラメーターを PartnerHotelIdtrue に設定する必要があります。
クエリ パラメーター:
  • PartnerHotelId— リソース パラメーターに、広告主がホテルに{hotelId}割り当てた ID が含まれている場合は、true に設定します。 このパラメーターが false に設定されているか、存在しない場合、ID は Microsoft によって割り当てられた ID です。 既定値は false です。

SubAccounts('{subAccountId}')/グループ化されていないテンプレート

動詞 説明
取得 グループ化されていないホテル グループのホテルの一覧を取得します。 サブアカウントを作成すると、サービスによってグループ化されていないホテル グループが作成されます。 他のグループに関連付けられていないホテル フィードのすべてのホテルは、このグループに配置されます。 このグループ内のホテルを別のホテル グループに関連付けるには、 関連付け テンプレートを参照してください。

注: 既定では、リストには最大 1,000 軒のホテルが含まれています。 グループ化されていないホテル グループ内のホテルの合計数を確認するには、 $count クエリ パラメーターを使用します。 返すホテルの数を指定するには、 $top クエリ パラメーターを使用します。 グループ内のすべてのホテルをページングするには、$topと $skip クエリ パラメーターを使用します。

注: この呼び出しを使用して、UI エクスペリエンスでのみホテルを通じてページを表示します。 この呼び出しを使用してすべてのホテルをダウンロードしないでください。 すべてのホテルをダウンロードするには、代わりに レポート機能を 使用します。

応答本文: CollectionResponse オブジェクトが 含まれています。 フィールドには value 、 Hotel オブジェクトの一覧が含まれます。

テンプレート パラメーター:
  • {subAccountId}— 取得するグループ化されていないホテル価格広告を含むサブアカウントの ID に設定します。

SubAccounts('{subAccountId}')/関連付けテンプレート

動詞 説明
取得 ホテルとホテルグループの関連付けの一覧を取得します。

注: 既定では、リストには最大 1,000 個の関連付けが含まれています。 サブアカウント内の関連付けの合計数を確認するには、 $count クエリ パラメーターを使用します。 返す関連付けの数を指定するには、 $top クエリ パラメーターを使用します。 サブアカウント内のすべての関連付けをページングするには、$top と $skip クエリ パラメーターを使用します。

応答本文: CollectionResponse オブジェクトが 含まれています。 valueフィールドには、HotelAssociation オブジェクトの一覧が含まれています。

テンプレート パラメーター:
  • {subAccountId}—取得する関連付けを含むサブアカウントの ID に設定します。

SubAccounts('{subAccountId}')/Associate template

動詞 説明
投稿 ホテルとホテルのグループの関連付けの一覧をサブアカウントに追加します。

要求本文: AssociationCollection オブジェクトが 含まれています。 HotelAssociationフィールドには、最大 500 個の HotelAssociation オブジェクトを含むリストが含まれています。 各オブジェクトは、ホテルをホテル グループに関連付けます。

1 つのホテルを 1 つのホテル グループにのみ関連付けることができます。 既定では、ホテルは グループ化されていない ホテル グループに関連付けられます。 ホテルを新しいホテル グループに関連付けるには、このテンプレートを使用します。 ホテルを新しいホテル グループに関連付けると、サービスは以前の関連付けを削除します。

応答本文: CollectionResponse オブジェクトが 含まれています。 valueフィールドには、HotelAssociation オブジェクトの一覧が含まれています。 一覧には、検証に失敗した関連付けのみが含まれています。 エラーがない場合、リストは空です。 関連付けのフィールドには、関連付 Errors けが失敗した理由の一覧が含まれています。

テンプレート パラメーター:
  • {subAccountId}—関連付けを追加するサブアカウントの ID に設定します。

ReportJobs テンプレート

動詞 説明
投稿 レポート キューにレポート要求を追加します。

要求本文: キューに追加するレポート要求を定義する ReportJob オブジェクトが含まれます。

応答本文: レポート要求がキューに正常に追加された場合、本文はレポート ジョブの ID を含む AddResponse オブジェクトです。 後続の GET 要求で ID を使用して、レポート ジョブの状態を取得します ( ReportJobs('{jobId}') テンプレートを参照してください)。

ReportJobs('{jobId}')

動詞 説明
取得 指定したレポート ジョブの状態を取得します。

応答本文: ReportJob オブジェクトが含まれます。 フィールドを Status 使用して、ジョブがいつ終了するかを判断します。 ジョブが完了したら、フィールドの Url URL を使用してレポートをダウンロードします。

テンプレート パラメーター:
  • {jobId}—状態を取得するレポート ジョブの ID。 POST 要求が返したレポート ジョブの ID に設定します。

$batch テンプレート

動詞 説明
投稿 最大 500 個の要求を含むバッチ要求を送信します。 続きを読む

要求本文: 個々の要求の文字列が含まれます。

応答本文: 対応する応答の文字列が含まれます。

クエリ パラメーター

要求で指定できるクエリ パラメーターを次に示します。

パラメーター 説明
$count 応答にフィールドが含まれる @odata.count かどうかを決定する OData パラメーター。 通常、このパラメーターは、ホテル グループの一覧など、エンティティの一覧を要求するときに含めます。 @odata.countフィールドには、要求で返されるリソース エンティティではなく、使用可能なリソース エンティティの合計数が含まれています。 たとえば、$top を 40 に設定しても、1,000 個のエンティティが存在する場合は、 @odata.count 40 ではなく 1,000 に設定されます。 カウントを含める場合は、$countを true に設定 します。
$filter データのフィルター処理に使用される式の一覧を指定する OData パラメーター。

メモ： $filter パラメーターは 、/Associations リソースでのみ使用できます。 詳細については、「 ホテルの関連付けのフィルター処理」を参照してください。
$select 応答に含めるフィールドのコンマ区切りのリストを指定する OData パラメーター。 フィールド名では大文字と小文字が区別されます。 たとえば、応答にホテルの名前、パートナー ID、入札フィールドを含める場合は、次のパラメーターを指定します。

$select=Name,PartnerHotelId,Bid
$skip エンティティを返す前にスキップするリソース エンティティの数を指定する OData パラメーター。 $skip値は、$topの倍数である必要があります。 範囲外の値を指定した場合、応答には空のセットが含まれます。 リソース エンティティの一覧を表示するには、$topと$skipを使用します。
$top 返すリソース エンティティの数を指定する OData パラメーター。 既定値は 1,000 で、指定できる最大値は 5,000 です。 リソース エンティティの一覧を表示するには、$topと$skipを使用します。

ヘッダー

要求ヘッダーと応答ヘッダーを次に示します。

ヘッダー 説明
Authorization 要求ヘッダー。

このヘッダーをベアラー OAuth アクセス トークンに設定します。 たとえば、"Authorization: Bearer QTkxRUFBRjEzOTUyNEIx...." です。 トークンの取得については、「はじめに」を参照してください。
Content-Type 要求ヘッダーと応答ヘッダー。

要求または応答の本文内のコンテンツの種類。 POST と PATCH の場合は、このヘッダーを に application/json設定します。
X-MS-RequestId 応答ヘッダー。

要求の詳細を含むログ エントリの ID。 エラーが発生した場合は、常にこの ID をキャプチャする必要があります。 問題を特定して解決できない場合は、この ID をサポート チームに提供する他の情報と共に含めます。

注:

この API では、認証に対してのみ OAuth アクセス トークンの使用がサポートされています (「承認ヘッダー」を参照してください)。 UserName ヘッダーと Password ヘッダーを使用して、従来の資格情報を指定することはできません。

この API では、開発者トークンは必要ありません。 DeveloperToken ヘッダーを含める場合、API はそれを無視します。

リソース オブジェクト

API で使用されるリソース オブジェクトを次に示します。

オブジェクト 説明
AddResponse リソースを追加する要求の応答オブジェクトを定義します。
AdsApiError 発生したエラーを定義します。
AdvanceBookingWindowMultiplier ユーザーが指定した日数を事前に予約した場合に基準入札を調整する金額を定義します。
AssociationCollection ホテルの関連付けのコレクションを定義します。
Budget サブアカウント内のホテル価格広告の 1 日あたりの予算を定義します。
CollectionResponse リソースの一覧を取得する要求の応答オブジェクトを定義します。
CheckinDayOfWeekMultiplier ユーザーが指定した平日のいずれかにチェックインした場合に基準入札を調整する金額を定義します。
DateTypeMultiplier ユーザーが特定の日付を使用してホテルを検索した場合に基となる入札単価を調整する金額を定義します。
DeviceMultiplier ユーザーが指定したデバイスのいずれかを使用してホテルを検索している場合に、基本入札額を調整する金額を定義します。
FixedBid 固定入札金額を定義します。
ホテル ホテル広告を定義します。
HotelAssociation ホテルとホテル グループの関連付けを定義します。
HotelGroup ホテル価格広告の論理グループを定義します。
LengthOfStayMultiplier ユーザーが指定した日数以上滞在する場合に基づく入札単価を調整する金額を定義します。
PercentageBid 1 泊あたりの合計客室料金の割合に基づいて入札を定義します。
ReportJob レポート ジョブを定義します。
SiteMultiplier ユーザーが指定したBingサイトの 1 つでホテルを検索している場合に、基準入札額を調整する金額を定義します。
SubAccount 最上位レベルのホテル価格広告のグループ化を定義します。 これは論理的に宿泊キャンペーンと考えることができます。
UserCountryMultiplier ユーザーがBingドメインのいずれかにアクセスする場合に、基準入札を調整する金額を定義します。

注:

応答オブジェクトにはコンテキスト フィールドが含まれます。 このフィールドは将来抑制される可能性があるため、モデルが変更される可能性があるため、依存関係を取得しないでください。 このフィールドに依存すると、将来コードが壊れる可能性があります。

AddResponse

リソースを追加する要求の応答オブジェクトを定義します。

名前 値 型
値 追加したリソースの ID。 object

AdsApiError

発生したエラーを定義します。

名前 値 型
コード エラーを識別するシンボリック コード。 コードの一覧については、「 エラー コード」を参照してください。 文字列
メッセージ エラーの説明。 String
パラメーター エラーの原因となったオブジェクト、フィールド、またはパラメーターの名前。 String

AdvanceBookingWindowMultiplier

ユーザーが指定した日数を事前に予約した場合に基準入札を調整する金額を定義します。

名前 値 型 追加する Update
要因 基本入札を調整する割合。 有効な範囲は 0.00 から 11.00 です。 たとえば、固定入札が $5 で、乗数が 5 の場合、最終的な入札額は $25 です。 同じ乗数を使用して、パーセンテージの入札が 5% で部屋の合計レートが $100 の場合、最終的な入札額は $25 です。 倍精度浮動小数点数 必須 省略可能
MinimumNumberOfDays ご予約の最低日数を事前に指定してください。 指定した日数以上前に予約が行われる場合は、乗数を適用します。 整数 必須 省略可能
@odata.type オブジェクトの型。 このフィールドは "#Model.AdvanceBookingWindowMultiplier" に設定されます。 文字列 必須 必須

AssociationCollection

ホテルの関連付けのコレクションを定義します。

名前 値 型 追加する Update
HotelAssociations ホテルおよびホテル グループの関連付けの一覧。 リストには、最大 500 個の関連付けが含まれる場合があります。 HotelAssociation[] 必須 該当なし

Bid

入札の基底クラスを定義します。

このクラスは指定しないでください。代わりに FixedBid クラスまたは PercentageBid クラスを 指定してください。

名前 値 型 追加する Update
Amount ドルの入札金額。 市場の有効な入札範囲の詳細については、「通貨 」トピックの 「通貨値」の表を参照してください。 顧客のアカウントは、使用する通貨を指定します。 倍精度浮動小数点数 必須 省略可能

Budget

サブアカウント内のホテル価格広告の 1 日あたりの予算を定義します。

名前 値 型 追加する Update
Amount 1 日の予算金額。 市場の有効な予算の詳細については、「通貨 」トピックの 「通貨値」テーブルを参照してください。 顧客のアカウントは、予算に使用される通貨を指定します。 倍精度浮動小数点数 必須 省略可能

CheckinDayOfWeekMultiplier

ユーザーが指定した平日のいずれかにチェックインした場合に基準入札を調整する金額を定義します。

名前 値 型 追加する Update
DaysOfWeek 平日の一覧。 ユーザーが指定した日のいずれかを確認している場合は、乗数を適用します。 大文字と小文字を区別する値を次に示します。

  • 月曜日
  • 火曜日
  • 水曜日
  • 木曜日
  • 金曜日
  • 土曜日
  • 日曜日
 String[] 必須 省略可能
要因 基本入札を調整する割合。 有効な範囲は 0.00 から 10.00 です。 たとえば、固定入札が $5 で、乗数が 5 の場合、最終的な入札額は $25 です。 同じ乗数を使用して、パーセンテージの入札が 5% で部屋の合計レートが $100 の場合、最終的な入札額は $25 です。 倍精度浮動小数点数 必須 省略可能
@odata.type オブジェクトの型。 このフィールドは "#Model.CheckinDayOfWeekMultiplier" に設定されます。 文字列 必須 必須

CollectionResponse

リソースの一覧を取得する要求の応答オブジェクトを定義します。

名前 値 型
値 要求されたリソースの一覧。 要求に応じて、リストには次のいずれかの種類のオブジェクトが含まれます。たとえば、ホテル グループの一覧を要求する場合は、 value オブジェクトの HotelGroup 一覧が含まれます。 object[]
@odata.count 使用可能なリソース エンティティの合計数。内 Valueのエンティティの数ではありません。 応答には、要求に $count クエリ パラメーターを含める場合にのみ、このフィールドが含まれます。

DateTypeMultiplier

ユーザーが特定の日付を使用してホテルを検索した場合に基となる入札単価を調整する金額を定義します。

名前 値 型 追加する Update
DateType 検索で使用される日付の種類。 大文字と小文字を区別する値を次に示します。

  • 既定値 - ユーザーが特定の日付を使用してホテルを検索しませんでした
  • [選択済み] - ユーザーが特定の日付を使用してホテルを検索しました。
 String[] 必須 省略可能
要因 基本入札を調整する割合。 有効な範囲は 0.00 から 10.00 です。 たとえば、固定入札が $5 で、乗数が 5 の場合、最終的な入札額は $25 です。 同じ乗数を使用して、パーセンテージの入札が 5% で部屋の合計レートが $100 の場合、最終的な入札額は $25 です。 倍精度浮動小数点数 必須 省略可能
@odata.type オブジェクトの型。 このフィールドは "#Model.DateTypeMultiplier" に設定されます。 String 必須 必須

DeviceMultiplier

ユーザーが指定したデバイスのいずれかを使用してホテルを検索している場合に、基本入札額を調整する金額を定義します。

名前 値 型 追加する Update
DeviceTypes デバイスの種類の一覧。 ユーザーがデバイスの種類を使用してホテルを検索している場合は、乗数を適用します。 大文字と小文字を区別する値を次に示します。

  • Desktop
  • Mobile
  • Tablet
 String[] 必須 省略可能
要因 基本入札を調整する割合。 有効な範囲は 0.00 から 10.00 です。 たとえば、固定入札が $5 で、乗数が 5 の場合、最終的な入札額は $25 です。 同じ乗数を使用して、パーセンテージの入札が 5% で部屋の合計レートが $100 の場合、最終的な入札額は $25 です。 倍精度浮動小数点数 必須 省略可能
@odata.type オブジェクトの型。 このフィールドは "#Model.DeviceMultiplier" に設定されます。 文字列 必須 必須

FixedBid

固定入札金額を定義します。

名前 値 型 追加する Update
Amount 固定ドルの入札金額。 市場の有効な入札範囲の詳細については、「通貨 」トピックの 「通貨値」の表を参照してください。 顧客のアカウントは、使用する通貨を指定します。

入札金額は 1 泊あたりの入札額です。 たとえば、入札額が $3.50 で、旅程が 3 泊の場合、最終的な入札額は $10.50 です。		 倍精度浮動小数点数 必須 省略可能
@odata.type オブジェクトの型。 このフィールドは "#Model.FixedBid" に設定されます。 文字列 必須 必須

ホテル

ホテル広告を定義します。

名前 値 型 追加する Update
Bid 基本入札。 1 つ以上の乗数を指定しない限り、Microsoft はこの入札をオークションで使用します (「」を参照)。BidMultipliers 入札を指定しない場合、ホテルはその順序でホテル グループまたはサブアカウントから入札を継承します。 ホテルを取得するときに、ホテルが入札を指定していない場合、このフィールドには継承された入札が含まれます。

指定できる入札の種類を次に示します。ホテルを一時停止するには、入札率を指定し、その入札金額をゼロ (0) に設定します。

ホテルの入札を削除するには、null に設定 Bid します。		 object 該当なし 省略可能
BidMultipliers 基本入札に適用する乗数の一覧。 Microsoft は、基準入札に乗数を適用し、調整された入札をオークションで使用します。 ホテルが入札を指定しない場合、乗数は継承された入札を調整します。

乗数を指定しない場合、ホテルはその順序でホテル グループまたはサブアカウントからそれらを継承します。 ホテルを取得するときに、ホテルで乗数が指定されていない場合、このフィールドには継承された乗数が含まれます。

ホテルで乗数を指定し、それらを削除する場合は、空の配列に設定 BidMultipliers します。

指定できる乗数の種類を次に示します。		 object[] 該当なし 省略可能
BidMultiplierSource 入札乗数のソース。 使用可能な値を次に示します。
  • SubAccount
  • HotelGroup
  • ホテル
たとえば、ホテルグループとホテル グループで乗数が指定されていない場合、ホテルはサブアカウントから乗数を継承します。 この場合、このフィールドは SubAccount に設定されます。		 String 該当なし 読み取り専用
BidSource 入札のソース。 使用可能な値を次に示します。
  • SubAccount
  • HotelGroup
  • ホテル
たとえば、ホテルで入札が指定されている場合、このフィールドは Hotel に設定されます。		 String 該当なし 読み取り専用
CountryCode ホテルがある国の 2 文字の ISO 3116 郡コード。 国は、ホテルフィードファイルでホテルに指定した国と同じです。 String 読み取り専用 読み取り専用
Id ホテルを一意に識別するシステム生成 ID。 String 該当なし 必須
名前 ホテルの名前。 名前は、ホテル フィード ファイルで指定した名前と同じです。 String 該当なし 読み取り専用
PartnerHotelId ホテル フィード ファイル内のホテルを識別するために使用した ID。 String 該当なし 読み取り専用
状態 ホテル エンティティの状態。 使用可能な値を次に示します。
  • アクティブ - ホテルは削除されず、更新される可能性があります。
  • 削除済み - ユーザーがホテルを削除しました。 ユーザーは UI のみを使用してホテルを削除できます。
 文字列 該当なし 読み取り専用

HotelAssociation

ホテルとホテル グループの関連付けを定義します。

[更新] 列には、HTTP 更新操作がないため、N/A 値が含まれています。 ホテルの関連付けを更新するには、Add (POST) 操作を使用します。 [関連付け] テンプレートを参照してください。

名前 値 型 追加する Update
エラー 関連付けが検証に失敗した理由の一覧。

応答には、関連付けを追加しようとしたときに検証に失敗した場合にのみ、このフィールドが含まれます。		 AdsApiError 読み取り専用 該当なし
HotelGroupId ホテルを関連付けるホテル グループの ID。 String 必須 該当なし
HotelGroupName ホテル グループの名前。 String 読み取り専用 該当なし
HotelId 指定したホテル グループに関連付けるホテルの ID (を参照)。HotelGroupId ホテルを 1 つのホテル グループにのみ関連付けることができます。

既定では、すべてのホテルは、ユーザー定義グループか既定のグループ化されていないホテル グループかに関係なく、ホテル グループ に 関連付けられます。 あるグループから別のグループにホテルを移動するには、ホテル ID と新しいホテル グループ ID を指定する新しい関連付けを投稿します。サービスは、以前の関連付けを削除します。		 String 必須 該当なし
HotelName ホテルの名前。 String 読み取り専用 該当なし
PartnerHotelId ホテル フィード ファイルでホテルを指定するために使用した ID。 String 読み取り専用 該当なし

HotelGroup

ホテルの論理グループを定義します。

名前 値 型 追加する Update
Bid 入札を指定しない場合、グループ内のホテルが継承する基本入札。 使用方法については、Hotel オブジェクトを参照してくださいBid。

入札を指定しない場合、グループはサブアカウントから入札を継承します。 ホテル グループを取得するときに、グループで入札が指定されていない場合、このフィールドには継承された入札が含まれます。

指定できる入札の種類を次に示します。グループ内のすべてのホテルを一時停止するには、入札率を指定し、その入札金額をゼロ (0) に設定します。

グループの入札を削除するには、null に設定 Bid します。		 object 省略可能 オプション
BidMultipliers 乗数を指定しない場合に、グループ内のホテルが継承する乗数の一覧。 使用方法については、Hotel オブジェクトを参照してくださいBidMultipliers。

乗数を指定しない場合、グループはサブアカウントからそれらを継承します。

ホテル グループで乗数を指定し、それらを削除する場合は、空の配列に設定 BidMultipliers します。

指定できる乗数の種類を次に示します。		 object[] 省略可能 オプション
BidMultiplierSource 入札乗数のソース。 使用可能な値を次に示します。
  • SubAccount
  • HotelGroup
たとえば、ホテル グループが乗数を指定しなかった場合、ホテル グループはサブアカウントから乗数を継承します。 この場合、このフィールドは SubAccount に設定されます。		 String 読み取り専用 読み取り専用
BidSource 入札のソース。 使用可能な値を次に示します。
  • SubAccount
  • HotelGroup
たとえば、ホテル グループで乗数を指定する場合、このフィールドは HotelGroup に設定されます。		 String 読み取り専用 読み取り専用
HotelAssociationCount ホテル グループに関連付けられているホテルの数。 符号なし整数 (Unsigned Integer) 読み取り専用 読み取り専用
Id グループを一意に識別するシステム生成 ID。 String 読み取り専用 必須
名前 グループの名前を指定します。 名前には、最大 256 文字を含む場合があります。 String 必須 読み取り専用
状態 ホテル グループ エンティティの状態。 使用可能な値を次に示します。
  • [アクティブ] - ホテル グループは削除されず、更新される可能性があります。
  • 削除済み - ユーザーはホテル グループを削除しました。 ユーザーは、UI のみを使用してホテル グループを削除できます。
 文字列 読み取り専用 読み取り専用

LengthOfStayMultiplier

ユーザーが指定した日数以上滞在する場合に基づく入札単価を調整する金額を定義します。

名前 値 型 追加する Update
要因 基本入札を調整する割合。 有効な範囲は 0.00 から 10.00 です。 たとえば、固定入札が $5 で、乗数が 5 の場合、最終的な入札額は $25 です。 同じ乗数を使用して、パーセンテージの入札が 5% で部屋の合計レートが $100 の場合、最終的な入札額は $25 です。 倍精度浮動小数点数 必須 省略可能
MinimumNumberOfNights 乗数を適用するために必要な最小宿泊日数。 ユーザーが指定した日数以上滞在している場合は、乗数を適用します。 有効な値は 1 から 14 です。 整数 必須 省略可能
@odata.type オブジェクトの型。 このフィールドは "#Model.LengthOfStayMultiplier" に設定されます。 文字列 必須 必須

乗数

乗数の基底クラスを定義します。

このクラスは指定しないでください。代わりに 、UserCountryMultiplier などの乗数クラスのいずれかを指定してください。

名前 値 型 追加する Update
要因 基本入札を調整する割合。 有効な範囲は 0.00 から 10.00 です。 たとえば、固定入札が $5 で、乗数が 5 の場合、最終的な入札額は $25 です。 同じ乗数を使用して、パーセンテージの入札が 5% で部屋の合計レートが $100 の場合、最終的な入札額は $25 です。 倍精度浮動小数点数 必須 省略可能

PercentageBid

税金やその他の料金を含む、1 泊あたりの客室料金の割合に基づいて入札を定義します。

名前 値 型 追加する Update
Amount 入札額の割合。 有効な範囲は 0 から 1,000 です。 たとえば、部屋の合計レートの 5% を入札するには、5.0 に設定 Amount します。

入札金額は 1 泊あたりの入札額です。 たとえば、入札が 3% の場合、合計客室料金は $99 で、旅程は 3 泊の滞在の場合、最終的な入札額は $8.91 です。		 倍精度浮動小数点数 必須 省略可能
@odata.type オブジェクトの型。 このフィールドは "#Model.PercentageBid" に設定されます。 文字列 必須 必須

ReportJob

レポート ジョブを定義します。

名前 値 型 追加する
段組み レポートに含める列の一覧。 レポートに含まれる順序は未確定です。 レポート サービスは、明示的に要求されていない他の関連する列もインターリーブする場合があります。 列名は大文字と小文字を区別します。 列名の一覧については、「要求するレポートの種類のレポート列」を参照してください (たとえば、PerformanceReport の場合は、「 パフォーマンス レポート列」を参照してください)。 列には、1 つのディメンション型列と 1 つのメトリック型列をリース時に含める必要があります。 String[] 必須
圧縮 レポートに適用する圧縮の種類。 大文字と小文字を区別しない値を次に示します。
  • Zip
既定値は圧縮なしです。		 文字列 省略可能
EndDate YYYY-MM-dd 形式のレポートの UTC 終了日。 月と日には 2 桁の数字を含む必要があります。 たとえば、2018-1-4 の代わりに 2018-01-04 を使用します。

レポートには、開始日と終了日に含まれるデータが含まれています。 終了日は開始日以降である必要があります。

メモ： ジョブの状態を取得するためにポーリングすると、サービスは YYYY-MM-ddTHH:mm:ssZ (2017-10-30T00:00:00Z など) の形式で日付を返します。		 String 必須
Filter 適用する OData フィルター文字列。 フィルター文字列の最大長は 1,000 文字です。 フィルターの使用については、「 レポート データのフィルター処理」を参照してください。

メモ： 指定したレポート列名と列挙値では、大文字と小文字が区別されます。 たとえば、devicetype ではなく DeviceType を指定し、デスクトップではなく Desktop を指定する必要があります。		 String 省略可能
フォーマット レポート内のコンテンツの形式。 大文字と小文字を区別しない値を次に示します。
  • CSV
既定値は CSV です。		 String 省略可能
HotelGroupId レポートを制限するホテルの ID。 このフィールドを設定するには、 も設定 SubaccountIdする必要があります。 文字列 省略可能
Id レポート ジョブを一意に識別する ID。 String 読み取り専用
IncludeNonPerformingHotels レポート期間中にインプレッションを受け取っていないホテルがレポートに含まれるかどうかを示すブール値。 パフォーマンスの高いホテルを含める場合は、このフィールドを true に設定します。それ以外の場合は false。 既定値は false です。

パフォーマンスの高いホテルを要求するときに指定できる列に関する制限事項については、「 レポートにパフォーマンスの高いホテルを含める」を参照してください。		 ブール型 省略可能
ReportType ダウンロードするエンティティまたはレポートの種類。 大文字と小文字を区別する値を次に示します。 String 必須
StartDate YYYY-MM-dd 形式のレポートの UTC 開始日。 月と日には 2 桁の数字を含む必要があります。 たとえば、2018-1-4 は 2018-01-04 である必要があります。 指定できる最も早い日付は、今日から 3 年です。

メモ： ジョブの状態を取得するためにポーリングすると、サービスは YYYY-MM-ddTHH:mm:ssZ (2017-10-30T00:00:00Z など) の形式で日付を返します。		 String 必須
Status レポート ジョブの状態。 使用可能な値を次に示します。
  • 完了 - レポート ジョブが正常に完了しました。 レポートをダウンロードするには、フィールドの Url URL を使用します。
  • 失敗 - 何らかの理由でジョブが失敗しました。 エラーが一時的なエラーである場合は、ジョブを再送信できます。 ジョブが再度失敗した場合は、X-MS-RequestId ヘッダーで要求 ID をキャプチャし、サポートにお問い合わせください。
  • InProgress - サービスはレポートを作成中です。
  • PendingExecution - レポート要求がキューに入れられます
 String 読み取り専用
SubaccountId レポートを制限するサブアカウントの ID。 文字列 省略可能
Url ダウンロードするレポートの URL。 サービスは、完了時 Status に URL を提供します。 URL は、[完了] に設定されたレポート ジョブ Status を取得してから 5 分間有効です。 URL の有効期限が切れた場合は、GET 要求を送信して、ジョブの状態を再度取得し、新しい URL を取得します。

SiteMultiplier

ユーザーが指定したBingサイトの 1 つでホテルを検索している場合に、基準入札額を調整する金額を定義します。

名前 値 型 追加する Update
要因 基本入札を調整する割合。 有効な範囲は 0.00 から 10.00 です。 たとえば、固定入札が $5 で、乗数が 5 の場合、最終的な入札額は $25 です。 同じ乗数を使用して、パーセンテージの入札が 5% で部屋の合計レートが $100 の場合、最終的な入札額は $25 です。 倍精度浮動小数点数 必須 省略可能
サイト サイトの一覧。 ユーザーが指定したサイトを使用してホテルを検索している場合は、乗数を適用します。 大文字と小文字を区別する値を次に示します。
  • LocalUniversal - ユーザーが Bing.com のホテルを検索しています。
  • MapResults - ユーザーは Bing.com/maps のホテルを検索しています。
  • PropertyPromotionAd - マップ検索に表示される最初の結果ページ。
 String[] 必須 省略可能
@odata.type オブジェクトの型。 このフィールドは "#Model.SiteMultiplier" に設定されます。 文字列 必須 必須

SubAccount

最上位レベルのホテル価格広告のグループ化を定義します。 これは論理的に宿泊キャンペーンと考えることができます。

名前 値 型 追加する Update
Bid ホテルが継承する基本入札(または属するグループ)が入札を指定しない場合。 使用方法については、Hotel オブジェクトを参照してくださいBid。

指定できる入札の種類を次に示します。サブアカウント内のすべてのホテルを一時停止するには、入札率を指定し、その入札金額をゼロ (0) に設定します。		 object 必須 省略可能
BidMultipliers ホテルが乗数を指定しない場合、または所属するグループが継承する乗数の一覧。 既定値は 0 です。 使用方法については、Hotel オブジェクトを参照してくださいBidMultipliers。

サブアカウントで乗数を指定し、それらを削除する場合は、空の配列に設定 BidMultipliers します。

指定できる乗数の種類を次に示します。		 object[] 省略可能 オプション
DailyBudget 1 日の予算を通じて広がる。

予算を 0 に設定すると、サブアカウントのホテルが提供されなくなります。		 Budget 必須 省略可能
HotelAssociationCount サブアカウント内のホテル グループに関連付けられているホテルの数。 符号なし整数 (Unsigned Integer) 読み取り専用 読み取り専用
Id サブアカウントを一意に識別するシステム生成 ID。 String 読み取り専用 必須
MaximumBid 超過しない入札金額。 FixedBid 省略可能 オプション
名前 サブアカウントの名前。 名前には、最大 128 文字を含む場合があります。 String 必須 読み取り専用
状態 サブアカウント エンティティの状態。 使用可能な値を次に示します。
  • [アクティブ] - サブアカウントは削除されず、更新される可能性があります。
  • 削除済み — ユーザーはサブアカウントを削除しました。 ユーザーは、UI のみを使用してサブアカウントを削除できます。
 文字列 読み取り専用 読み取り専用

UserCountryMultiplier

ユーザーがBingドメインのいずれかにアクセスする場合に、基準入札を調整する金額を定義します。

名前 値 型 追加する Update
Countries 2 文字の ISO 3116 国/地域コードの一覧。 使用可能な国/地域コードの一覧については、「 許可される国/地域コード」を参照してください。

ユーザーが指定した国コードを使用してBing ドメインにアクセスする場合は、乗数を適用します。 たとえば、リストに米国と DE が含まれている場合、ユーザーが us または de 国コード (たとえば、bing.com?cc=de) で Bing.com を使用する場合、Microsoft は乗数を使用します。		 String[] 必須 省略可能
要因 基本入札を調整する割合。 有効な範囲は 0.00 から 10.00 です。 たとえば、固定入札が $5 で、乗数が 5 の場合、最終的な入札額は $25 です。 同じ乗数を使用して、パーセンテージの入札が 5% で部屋の合計レートが $100 の場合、最終的な入札額は $25 です。 倍精度浮動小数点数 必須 省略可能
@odata.type オブジェクトの型。 このフィールドは "#Model.UserCountryMultiplier" に設定されます。 String 必須 必須

HTTP 状態コード

要求は、次の HTTP 状態コードを返す場合があります。

状態コード 説明
200 リソースが正常に取得されました。
201 リソースが正常に追加されました。
204 リソースが正常に更新または削除されました。
400 要求が正しくありません。 クエリ パラメーターの値が無効であるか、要求本文のコンテンツが無効です。
401 権限がありません。 ユーザーの資格情報が無効です。
403 禁止。 レポートのダウンロード URL の有効期限が切れています。 レポートをダウンロードするための URL を取得した時点から 7 日間です。 URL の有効期限が切れた場合は、新しいジョブ要求を送信する必要があります。
404 見つかりません。
429 要求数が多すぎます。 API では、1 分あたりに行える要求の数が制限されます。 制限は文書化されておらず、変更される可能性があります。 制限を超えた場合、API はこの状態コードを返します。 要求を再送信する前に、このエラーを受信した後、60 を待つ必要があります。
500 サーバー エラー。

エラー コード

エラー コードの報告

エラー コード 説明
CompressionTypeNotSupported フィールドは Compression 、サポートされていない値に設定されます。 サポートされている圧縮アルゴリズムの一覧については、「 圧縮」を参照してください。
DuplicateValues [列] フィールドには、同じ列名が複数回含まれています。
FilterTooLong に設定 Filter した OData フィルター文字列が長すぎます。 許可される最大長については、「 フィルター」を参照してください。
FormatVersionNotSupported フィールドは Format 、サポートされていない値に設定されます。 サポートされている形式の一覧については、「 形式」を参照してください。
InvalidDateRange 指定したレポート期間が無効です。 有効な日付範囲の指定については、 StarteDate フィールドと EndDate フィールドを 参照してください。
InvalidReportName フィールドは ReportType 無効なレポート名に設定されます。 有効なレポート名の一覧については、「 ReportType」を参照してください。
InvalidSelect 指定した 1 つ以上の列が無効です。 使用した列名と、要求したレポートに関して文書化された列名を比較します。 名前では大文字と小文字が区別されます。

国または地域コード

UserCountryMultiplier のフィールドを設定するには、Countries次の国/地域コードを使用できます。

国/地域名 国/地域コード
アフガニスタン Af
アルバニア アル
アルジェリア アルジェリア
アンドラ 広告
アンゴラ Ao
アンギラ Ai
南極大陸 Aq
アンティグア バーブーダ Ag
アンティル諸島 (オランダ) AN
米領サモア AS
アルゼンチン Ar
アルメニア 午前
アルバ Aw
オーストラリア Au
オーストリア AT
アゼルバイジャン アリゾナ 州
バハマ Bs
バーレーン Bh
バングラデシュ Bd
バルバドス Bb
ベラルーシ BY
ベルギー Bve
ベリーズ Bz
バミューダ諸島 Bm
ベナン Bj
ブータン Bt
ボリビア ボー
ボスニア・ヘルツェゴビナ Ba
ボツワナ Bw
ブラジル Br
ブルネイ Bn
ブルガリア BG
ブルキナファソ Bf
ブルンジ Bi
カーボベルデ CV
カンボジア 瀬
カメルーン Cm
カナダ CA
ケイマン諸島 ケンタッキー 州
中央アフリカ共和国 Cf
チャド Td
チリ Cl
中国 Cn
クリスマス島 Cx
ココス諸島 CC
コロンビア 共同
コモロ Km
コンゴ Cg
コンゴ民主共和国 Cd
クック諸島 Ck
コスタリカ Cr
Ivory Coast (Côte d'Ivoire) CI
クロアチア HR
キプロス Cy
チェコ共和国 Cz
デンマーク DK
ジブチ Dj
ドミニカ Dm
ドミニカ共和国 DO
エクアドル Ec
エジプト 例えば
エルサルバドル SV
赤道ギニア Gq
エリトリア ER
エストニア EE
エスワティニ Sz
エチオピア Et
フォークランド諸島 Fk
フェロー諸島 FO
フィジー Fj
フィンランド FI
フランス FR
フランス領ギアナ Gf
フランス領ポリネシア Pf
ガボン GA
ガンビア Gm
ジョージア Ge
ドイツ DE
ガーナ Gh
ジブラルタル Gi
ギリシャ GR
グリーンランド Gl
グレナダ Gd
グアドループ Gp
グアム 区
グアテマラ GT
ギニア Gn
ギニアビサウ Gw
ガイアナ Gy
ハイチ Ht
ホーリー・シー バージニア 州
ホンジュラス Hn
香港 Hk
ハンガリー 胡
アイスランド は
インド IN
インドネシア ID
イラク IQ
アイルランド IE
イスラエル イリノイ
イタリア IT
ジャマイカ Jm
日本 Jp
ヨルダン ジョー
カザフスタン カザフスタン
ケニア 柯
キリバス 氣
韓国 Kr
クウェート Kw
キルギスタン Kg
ラオスPeople民主共和国 La
ラトビア Lv
レバノン ポンド
レソト Ls
リベリア Lr
リビア Ly
リヒテンシュタイン 李
リトアニア 中尉
ルクセンブルク Lu
マカオ特別行政区 Mo
マダガスカル Mg
マラウイ Mw
マレーシア 私の
モルディブ Mv
マリ Ml
マルタ 山
マーシャル諸島 Mh
マルティニーク島 Mq
モーリタニア 氏
モーリシャス Mu
マイヨット Yt
メキシコ MX
ミクロネシア Fm
モルドバ Md
モナコ Mc
モンゴル ミネソタ
モンテネグロ 私
モントセラト さん
モロッコ Ma
モザンビーク Mz
ミャンマー MM
ナミビア 該当なし
ナウル Nr
ネパール Np
オランダ NL
ニューカレドニア Nc
ニュージーランド Nz
ニカラグア Ni
ニジェール NE
ナイジェリア Ng
ニウエ ニュー
ノーフォーク島 Nf
ノルウェー 動作しない
北マケドニア Mk
北マリアナ諸島 Mp
オマーン Om
パキスタン Pk
パラオ PW
パレスチナ自治政府 Ps
パナマ Pa
パプアニューギニア Pg
パラグアイ Py
ペルー Pe
フィリピン PH
ピトケアン Pn
ポーランド PL
ポルトガル Pt
プエルトリコ Pr
カタール Qa
レユニオン 再
ルーマニア Ro
ロシア連邦 Ru
ルワンダ Rw
セントヘレナ、アセンション、トリスタンダクーニャ Sh
セントクリストファー ネイビス Kn
セントルシア Lc
サンピエール島/ミクロン島 Pm
セントビンセント グレナディーン Vc
サンマリノ Sm
サントメ・プリンシペ 聖
サウジアラビア SA
セネガル Sn
セルビア Rs
セーシェル Sc
シエラレオネ SL
シンガポール Sg
スロバキア Sk
スロベニア Si
スペイン Es
ソロモン諸島 Sb
サモア Ws
ソマリア だから
南アフリカ 座
スリランカ Lk
スリナム シニア
スウェーデン SE
スイス Ch
台湾 Tw
タジキスタン Tj
Tanzania Tz
タイ 番目
ティモール・レステ Tl
トーゴ Tg
トケラウ諸島 TK
トンガ TO
トリニダード・トバゴ TT
チュニジア テネシー
Türkiye Tr
トルクメニスタン Tm
タークス カイコス諸島 Tc
ツバル TV
ウガンダ Ug
ウクライナ Ua
アラブ首長国連邦 Ae
英国 Gb
米国 US
ウルグアイ ウルグアイ
ウズベキスタン Uz
バヌアツ Vu
ベネズエラ Ve
ベトナム Vn
バージン諸島 (イギリス) Vg
バージン諸島 (米国) Vi
ウォリス フツナ Wf
イエメン あなたがた
ザンビア ザンビア
ジンバブエ ZW