keyword フィールドには最大 700 文字まで指定できますkeyword に “%” 文字を使用する場合は “%25” と指定してください； DataForSEO API の keyword および keywords フィールドのルールと制限については、こちらのヘルプセンター記事をご覧ください"
},
"priority": {
"type": [
"integer",
"null"
],
"description": "タスクの優先度
任意フィールド
次の値を指定できます：
1 – 通常の実行優先度（デフォルトで設定）
2 – 高い実行優先度。実行優先度の高いタスクには追加料金がかかります。
コストは料金ページで計算できます。"
},
"location_name": {
"type": "string",
"description": "検索エンジンのロケーションの正式名location_code または location_coordinate を指定しない場合は必須フィールド
このフィールドを使用する場合、location_code または location_coordinate を指定する必要はありませんlocation_name を含む利用可能なロケーションの一覧は、https://api.dataforseo.com/v3/business_data/google/locations に個別にリクエストして取得できます
例：London,England,United Kingdom
注意：正確な検索結果を得るため、指定した location_name がキーワードに自動的に追加されます"
},
"location_code": {
"type": "integer",
"description": "検索エンジンのロケーションコードlocation_name または location_coordinate を指定しない場合は必須フィールド
このフィールドを使用する場合、location_name または location_coordinate を指定する必要はありませんlocation_code を含む利用可能なロケーションの一覧は、https://api.dataforseo.com/v3/business_data/google/locations に個別にリクエストして取得できます
例：2840"
},
"location_coordinate": {
"type": "string",
"description": "ロケーションの GPS 座標location_name または location_code を指定しない場合は必須フィールド
このフィールドを使用する場合、location_name または location_code を指定する必要はありませんlocation_coordinate パラメータは \"latitude,longitude\" 形式で指定します
\"latitude\" と \"longitude\" の小数点以下の最大桁数：7
注意：座標を使用してロケーションを設定する場合、検索は最も近い集落で行われます；
例：53.476225,-2.243572"
},
"search_this_area": {
"type": [
"boolean",
"null"
],
"description": "表示されているエリア内のホテルを表示
任意フィールド
次の値を指定できます：true、false
デフォルト値：truefalse に設定すると、search_this_area モードがオフになります
注意：search_this_area モードがオフの場合、検索時に location_name は keyword に追加されません
このパラメータの詳細については、ヘルプセンターをご覧ください"
},
"language_name": {
"type": "string",
"description": "検索エンジンの言語の正式名language_code を指定しない場合は必須フィールド
このフィールドを使用する場合、language_code を指定する必要はありませんlanguage_name を付した利用可能な言語のリストは、https://api.dataforseo.com/v3/business_data/google/languages に個別にリクエストして取得できます
例：English"
},
"language_code": {
"type": "string",
"description": "検索エンジンの言語コードlanguage_name を指定しない場合は必須フィールド
このフィールドを使用する場合、language_name を指定する必要はありませんlanguage_code を付した利用可能な言語のリストは、https://api.dataforseo.com/v3/business_data/google/languages に個別にリクエストして取得できます
例：en"
},
"depth": {
"type": [
"integer",
"null"
],
"description": "解析深度
任意フィールド
Google Hotels 内の結果数
デフォルト値：18 件の自然検索結果
最大値：140
注意：レスポンスに有料掲載が含まれているかどうかに関係なく、アカウントには自然検索結果 18 件ごとに課金されます；
そのため、Google Hotels が 18 件を超える結果を返した場合、深度を 18 より大きく設定すると追加料金が発生する可能性があります；
指定した深度がレスポンス内の結果数より大きい場合、その差額はアカウント残高に自動的に返金されます"
},
"check_in": {
"type": [
"string",
"null"
],
"description": "チェックイン日
任意フィールド
このフィールドを指定しない場合、明日の日付がデフォルトで使用されます；
日付形式：\"yyyy-mm-dd\"
例：\"2019-01-15\"
注意：値は今日の日付より前にすることはできません"
},
"check_out": {
"type": [
"string",
"null"
],
"description": "チェックアウト日
任意フィールド
このフィールドを指定しない場合、当社のシステムはデフォルトで 2 日後の日付を適用します；
日付形式：\"yyyy-mm-dd\"
例：\"2019-01-15\"
注意：値は check_in 以下にすることはできません；check_in と check_out の値の範囲は 30 日を超えることはできません"
},
"currency": {
"type": [
"string",
"null"
],
"description": "通貨
任意フィールド
例：\"USD\""
},
"adults": {
"type": [
"integer",
"null"
],
"description": "大人の人数
任意フィールド
このフィールドを指定しない場合、デフォルト値 2 が適用されます；
大人と子供を合わせて最大 6 名まで指定できることに注意してください
例：1"
},
"children": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "子供の人数と年齢
任意フィールド
このフィールドを指定しない場合、検索に子供は含まれません；
子供の年齢は 0 から 17 までです；
大人と子供を合わせて最大 6 名まで指定できることに注意してください
14 歳の子供を 1 名含める場合は、次の値を設定します：[14]
13 歳の子供 1 名と 8 歳の子供 1 名を含める場合は、次の値を設定します：[13,8]"
},
"stars": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "ホテルの星の数
任意フィールド
5 つ星ホテルの一覧のみを取得する場合は、このフィールドを [5] に設定します
例：[3,4,5]"
},
"min_rating": {
"type": [
"number",
"null"
],
"description": "最低評価
任意フィールド
このフィールドを使用して、特定の値より高い宿泊客評価を指定できます
例：2.5"
},
"sort_by": {
"type": [
"string",
"null"
],
"description": "結果の並べ替えパラメーター
任意フィールド
このフィールドを使用して結果を並べ替えられます
指定可能な並べ替えの種類：relevance – 最も関連性の高い順に並べ替えlowest_price – 最低価格順に並べ替えhighest_rating – 最高評価順に並べ替えmost_reviewed – レビュー数が多い順に並べ替え
デフォルト値：relevance"
},
"min_price": {
"type": [
"integer",
"null"
],
"description": "1 泊あたりの最低価格
任意フィールド
この値の通貨は currency フィールドによって決まります
例：100"
},
"max_price": {
"type": [
"integer",
"null"
],
"description": "1 泊あたりの最高価格
任意フィールド
この値の通貨は currency フィールドによって決まります
例：600"
},
"free_cancellation": {
"type": [
"boolean",
"null"
],
"description": "無料キャンセル可能なホテル
任意フィールド
予約を無料でキャンセルできるホテルの一覧を取得する場合は、このフィールドを true に設定します
デフォルト値：false"
},
"is_vacation_rentals": {
"type": [
"boolean",
"null"
],
"description": "バケーションレンタルを検索
任意フィールド
ホテルではなくバケーションレンタルの一覧を取得する場合は、このフィールドを true に設定します
デフォルト値：false"
},
"amenities": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "ホテルの設備
任意フィールド
このフィールドを使用して、さまざまなホテルの設備を指定できます
例： [
\"free_parking\",
\"pets_allowed\"
]
指定可能な値：\"air_conditioning\","
},
"tag": {
"type": [
"string",
"null"
],
"description": "ユーザー定義のタスク識別子
\"all_inclusive_available\",
\"bar\",
\"free_breakfast\",
\"fitness_center\",
\"kid_friendly\",
\"free_parking\",
\"pets_allowed\",
\"pool\",
\"restaurant\",
\"room_service\",
\"spa\",
\"free_wifi\",
\"parking\",
\"indoor_pool\",
\"outdoor_pool\",
\"wheelchair_accessible\",
\"beach_access\"
任意フィールド
文字数上限は 255 です
このパラメーターを使ってタスクを識別し、結果と照合できます
指定した tag の値は、レスポンスの data オブジェクトに含まれます"
},
"postback_url": {
"type": [
"string",
"null"
],
"description": "タスク結果を送信する URL
任意フィールド
タスクが完了すると、その結果を gzip 形式で圧縮し、指定した postback_url に POST リクエストで送信します
‘$id’ 文字列を $id 変数として、‘$tag’ を URL エンコードされた $tag 変数として使用できます。リクエストを送信する前に必要な値を設定します。
例：http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tag
注意：postback_url の特殊文字は URL エンコードされます；
たとえば、# 文字は %23 にエンコードされます
詳細はヘルプセンターを参照してください"
},
"pingback_url": {
"type": [
"string",
"null"
],
"description": "完了したタスクの通知 URL
任意フィールド
タスクが完了すると、指定した URL に GET リクエストを送信して通知します
‘$id’ 文字列を $id 変数として、‘$tag’ を URL エンコードされた $tag 変数として使用できます。リクエストを送信する前に必要な値を設定します。
例：http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tag
注意：pingback_url の特殊文字は URL エンコードされます；
たとえば、# 文字は %23 にエンコードされます
詳細はヘルプセンターを参照してください"
}
},
"example": [
{
"language_code": "en",
"location_name": "New York,New York,United States",
"keyword": "cheap hotel",
"check_in": "2023-06-01",
"check_out": "2023-06-30",
"currency": "USD",
"adults": 2,
"children": [
"14"
],
"sort_by": "highest_rating",
"priority": 2,
"tag": "example"
}
]
}
]
},
"example": [
{
"language_code": "en",
"location_name": "New York,New York,United States",
"keyword": "cheap hotel",
"check_in": "2023-06-01",
"check_out": "2023-06-30",
"currency": "USD",
"adults": 2,
"children": [
"14"
],
"sort_by": "highest_rating",
"priority": 2,
"tag": "example"
}
]
}
```
## Responses
### 200 — 操作成功
Headers:
- `X-Request-Id` (string) — Felo サポートに問い合わせる際に伝えるリクエスト識別子。
**application/json**
Schema: object | null
```json
{
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_BusinessDataGoogleHotelSearchesTaskPostResponseInfo"
}
]
}
```
### 400 — リクエストを処理できませんでした。リクエストパラメータを確認してください。
### 401 — 有効な Felo API キーが必要です。
### 402 — 請求要件が満たされていないため、リクエストを続行できません。
### 403 — このアカウントにはこの操作を行う権限がありません。
### 429 — リクエストまたは支出の上限に達しました。
### 502 — サービスがリクエストを完了できませんでした。
### 503 — API または請求サービスが一時的に利用できません。
### 504 — リクエストの処理中にサービスがタイムアウトしました。
### default — エラーレスポンス。上流のパススルーレスポンスはプロバイダーの形式を使用する場合があります
**application/json**
Schema:
```json
{}
```
## Schema definitions
### Response36Afe1097B20_BaseResponseInfo
`#/components/schemas/Response36Afe1097B20_BaseResponseInfo`
```json
{
"properties": {
"version": {
"type": [
"string",
"null"
],
"description": "API の現在のバージョン"
},
"status_code": {
"type": [
"integer",
"null"
],
"description": "一般的なステータスコード\nレスポンスコードの完全な一覧はこちらです"
},
"status_message": {
"type": [
"string",
"null"
],
"description": "一般的な情報メッセージ\n一般的な情報メッセージの完全な一覧はこちらです"
},
"time": {
"type": [
"string",
"null"
],
"description": "合計実行時間（秒）"
},
"cost": {
"type": [
"number",
"null"
],
"description": "タスクの総コスト（USD）",
"format": "double"
},
"tasks_count": {
"type": [
"integer",
"null"
],
"description": "tasks 配列内のタスク数",
"format": "int64"
},
"tasks_error": {
"type": [
"integer",
"null"
],
"description": "エラーで返された tasks 配列内のタスク数",
"format": "int64"
}
}
}
```
### Response36Afe1097B20_BaseResponseTaskInfo
`#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo`
```json
{
"properties": {
"id": {
"type": [
"string",
"null"
],
"description": "タスク識別子\n当社システム内で UUID 形式の一意のタスク識別子"
},
"status_code": {
"type": [
"integer",
"null"
],
"description": "タスクのステータスコード\nDataForSEO によって生成され、次の範囲の値になります: 10000-60000\nレスポンスコードの完全な一覧はこちらです"
},
"status_message": {
"type": [
"string",
"null"
],
"description": "タスクの情報メッセージ\n一般的な情報メッセージの完全な一覧はこちらです"
},
"time": {
"type": [
"string",
"null"
],
"description": "実行時間（秒）"
},
"cost": {
"type": [
"number",
"null"
],
"description": "タスクの総コスト（USD）",
"format": "double"
},
"result_count": {
"type": [
"integer",
"null"
],
"description": "result 配列内の要素数",
"format": "int64"
},
"path": {
"type": [
"array",
"null"
],
"items": {
"type": [
"string",
"null"
]
},
"description": "URL パス"
},
"data": {
"type": [
"object",
"null"
],
"additionalProperties": {
"type": [
"object",
"null"
]
},
"description": "POST リクエストで指定したものと同じパラメーターを含みます"
}
}
}
```
### Response36Afe1097B20_BusinessDataGoogleHotelSearchesTaskPostResponseInfo
`#/components/schemas/Response36Afe1097B20_BusinessDataGoogleHotelSearchesTaskPostResponseInfo`
```json
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseInfo"
},
{
"type": "object",
"properties": {
"tasks": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_BusinessDataGoogleHotelSearchesTaskPostTaskInfo"
}
]
},
"description": "タスクの配列"
}
}
}
]
}
```
### Response36Afe1097B20_BusinessDataGoogleHotelSearchesTaskPostTaskInfo
`#/components/schemas/Response36Afe1097B20_BusinessDataGoogleHotelSearchesTaskPostTaskInfo`
```json
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo"
},
{
"type": "object",
"properties": {
"result": {
"type": [
"object",
"null"
],
"description": "結果の配列
この場合、値は null になります"
}
}
}
]
}
```