# 「検索ボリューム」ライブタスクの設定

**API:** Data API

**Endpoint:** `POST /v1/beta/dataforseo/keywords_data/bing/search_volume/live`

**Tags:** DataForSEO

`keywords` のリストに対する Bing の検索ボリューム。`keyword`、`location_code`、`language_code`、`search_partners`、`device`、`competition`、`cpc`、`search_volume`、`categories`、`monthly_searches` を返します。`categories` がある点（Google の対応版は返しません）と、`competition_index` がない点に注意してください。DataForSEO のエンベロープに包まれます。データは `tasks[0].result`、結果は `tasks[0].status_code` に格納され、拒否されたリクエストでも HTTP 200 が返ります。Google 側の対応は `post_dataforseo_keywords_gads_search_volume_live` です。オーディエンスが Google だけではない場合は両方を実行してください。このエンドポイントの submit / fetch のペアは、待ちきれないほど大きなバッチ向けに、同じ価格で同じ処理を非同期に実行します。

### 料金の参考情報

- 計測方法：報告されたレスポンスコスト。
- 参考リクエスト見積もり：0.09 USD。
- 参照用の顧客乗数：1.0。確定済みの顧客金額に再適用しないでください。

参照用のメタデータのみであり、アカウントへの見積もり、保証された価格、支出上限ではありません。リソースクレジットは Felo クレジットではありません。最終的な請求は Felo の請求記録に従います。

## Base URL

- `https://openapi.felo.ai`

## Authentication

- `FeloBearerAuth` (http bearer, bearer format Felo API Key)
- `FeloApiKey` (apiKey in header `X-API-Key`)

## Request body

Required: **no**

### application/json

Schema:

```json
{
  "type": "array",
  "items": {
    "type": [
      "object",
      "null"
    ],
    "oneOf": [
      {
        "type": "object",
        "properties": {
          "keywords": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "<em>keywords</em><br><strong>必須フィールド</strong><br>指定できるキーワードの最大数: 1000<br>各キーワードの最大文字数: 100<br>指定したキーワードは小文字に変換され、データは別の配列で提供されます。DataForSEO API の <code>keyword</code> フィールドと <code>keywords</code> フィールドのルールと制限については、こちらの <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" target=\"_blank\" rel=\"noopener noreferrer\">ヘルプセンター記事</a>を参照してください"
          },
          "location_name": {
            "type": "string",
            "description": "<em>検索エンジンの所在地の正式名</em><br><strong><code>location_code</code> または <code>location_coordinate</code> を指定しない場合は必須フィールド</strong><br><strong>このフィールドを使用する場合、<code>location_code</code> または <code>location_coordinate</code> を指定する必要はありません</strong><br><code>https://api.dataforseo.com/v3/keywords_data/bing/locations</code> に個別にリクエストすると、検索エンジンの利用可能な所在地とその <code>location_name</code> の一覧を取得できます<br>例:<br><code class=\"long-string\">London,England,United Kingdom</code>"
          },
          "location_code": {
            "type": "integer",
            "description": "<em>検索エンジンの所在地コード</em><br><strong><code>location_name</code> または <code>location_coordinate</code> を指定しない場合は必須フィールド</strong><br><strong>このフィールドを使用する場合、<code>location_name</code> または <code>location_coordinate</code> を指定する必要はありません</strong><br><code>https://api.dataforseo.com/v3/keywords_data/bing/locations</code> に個別にリクエストすると、検索エンジンの利用可能な所在地とその <code>location_code</code> の一覧を取得できます<br>例:<br><code class=\"long-string\">2840</code>"
          },
          "location_coordinate": {
            "type": "string",
            "description": "<em>所在地の GPS 座標</em><br><strong><code>location_name</code> または <code>location_code</code> を指定しない場合は必須フィールド</strong><br><strong>このフィールドを使用する場合、<code>location_name</code> または <code>location_code</code> を指定する必要はありません</strong><br><code>location_coordinate</code> パラメーターは <em>\"緯度,経度\"</em> 形式で指定します<br><strong>データは、指定した座標が属する国について提供されます</strong><br>例:<br><code class=\"long-string\">52.6178549,-155.352142</code>"
          },
          "language_name": {
            "type": "string",
            "description": "<em>検索エンジンの言語の正式名</em><br><strong><code>language_code</code> を指定しない場合は必須フィールド</strong><br>このフィールドを使用する場合、<code>language_code</code> を指定する必要はありません<br>サポートされている言語:<br><code>English</code>、<code>French</code>、<code>German</code>"
          },
          "language_code": {
            "type": "string",
            "description": "<em>検索エンジンの言語コード</em><br><strong><code>language_name</code> を指定しない場合は必須フィールド</strong><br>このフィールドを使用する場合、<code>language_name</code> を指定する必要はありません<br>サポートされている言語:<br><code class=\"long-string\">en</code>、<code>fr</code>、<code>de</code>"
          },
          "device": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>デバイスの種類</em><br>任意フィールド<br>特定のデバイスの種類のデータを取得する場合は、このフィールドを指定してください<br>指定可能な値: <code>all</code>、<code>mobile</code>、<code>desktop</code>、<code>tablet</code><br>デフォルト値: <code>all</code>"
          },
          "sort_by": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>結果の並べ替えパラメーター</em><br>任意フィールド<br>これらのパラメーターを使用して、<code>search_volume</code>、<code>cpc</code>、<code>competition</code>、<code>relevance</code> で結果を降順に並べ替えられます<br>デフォルト値: <code>relevance</code>"
          },
          "date_from": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>期間の開始日</em><br>任意フィールド<br>最小値: 今日から 24 か月前<br>このフィールドを指定しない場合、直近 12 か月分のデータが提供されます<br>最小値: 今日から 2 年前<br><a href=\"/v3/keywords_data/bing/status/\" target=\"_blank\" rel=\"noopener noreferrer\">Status エンドポイント</a> が <code>actual_data</code> フィールドで <code>false</code> を返す場合、<code>date_from</code> は先々月以前に設定できます<br><a href=\"/v3/keywords_data/bing/status/\" target=\"_blank\" rel=\"noopener noreferrer\">Status エンドポイント</a> が <code>actual_data</code> フィールドで <code>true</code> を返す場合、<code>date_from</code> は先月以前に設定できます<br>日付形式: <code>\"yyyy-mm-dd\"</code><br>例:<br><code>\"2020-01-01\"</code><strong>注意:</strong> 過去 1 年の日付にカスタム期間を使用することはお勧めしません"
          },
          "date_to": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>期間の終了日</em><br>任意フィールド<br>このフィールドを指定しない場合、直近 12 か月分のデータが提供されます<br>最小値: 今日から 2 年前<br>最大値: 今日から 1 か月後<br><strong>注意:</strong> 過去 1 年の日付にカスタム期間を使用することはお勧めしません<br>日付形式: <code>\"yyyy-mm-dd\"</code><br>例:<br><code>\"2020-03-15\"</code><strong>注意:</strong> 過去 1 年の日付にカスタム期間を使用することはお勧めしません"
          },
          "search_partners": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "<em>Bing 検索パートナーの種類</em><br>任意フィールド<br><code class=\"prettyprint\">true</code> を指定すると、Bing、Yahoo、AOL の検索をホストする Bing、Yahoo、AOL およびパートナーサイトの所有、運営、シンジケートネットワーク全体の結果が提供されます。<br>デフォルト値: <code>false</code> - Bing、AOL、Yahoo の検索ネットワークの結果が返されます"
          },
          "tag": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>ユーザー定義のタスク識別子</em><br>任意フィールド<br><em>文字数上限は 255 です</em><br>このパラメーターを使ってタスクを識別し、結果と照合できます<br>指定した <code>tag</code> の値は、レスポンスの <code>data</code> オブジェクトに含まれます"
          }
        },
        "example": [
          {
            "location_name": "United States",
            "language_code": "en",
            "keywords": [
              "tom and jerry",
              "silicon valley",
              "spider man"
            ]
          }
        ]
      }
    ]
  },
  "example": [
    {
      "location_name": "United States",
      "language_code": "en",
      "keywords": [
        "tom and jerry",
        "silicon valley",
        "spider man"
      ]
    }
  ]
}
```

## Responses

### 200 — 操作成功

Headers:
- `X-Request-Id` (string) — Felo サポートに問い合わせる際に伝えるリクエスト識別子。

**application/json**

Schema: object | null

```json
{
  "type": [
    "object",
    "null"
  ],
  "oneOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_KeywordsDataBingSearchVolumeLiveResponseInfo"
    }
  ]
}
```

### 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_KeywordsDataBingSearchVolumeLiveResponseInfo

`#/components/schemas/Response36Afe1097B20_KeywordsDataBingSearchVolumeLiveResponseInfo`

```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_KeywordsDataBingSearchVolumeLiveTaskInfo"
              }
            ]
          },
          "description": "<em>タスクの配列</em>"
        }
      }
    }
  ]
}
```

### Response36Afe1097B20_KeywordsDataBingSearchVolumeLiveResultInfo

`#/components/schemas/Response36Afe1097B20_KeywordsDataBingSearchVolumeLiveResultInfo`

```json
{
  "type": "object",
  "properties": {
    "keyword": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>POST 配列内のキーワード</em>"
    },
    "location_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>POST 配列内のロケーションコード</em><br>データがない場合、値は <code>null</code> になります"
    },
    "language_code": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>POST 配列内の言語コード</em><br>データがない場合、値は <code>null</code> になります"
    },
    "search_partners": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "<em>パートナー ネットワークからのデータがレスポンスに含まれるかどうかを示します</em>"
    },
    "device": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>POST 配列内のデバイスタイプ</em><br>データがない場合、値は <code>null</code> です"
    },
    "competition": {
      "type": [
        "number",
        "null"
      ],
      "description": "<em>競合</em><br>指定したキーワードの有料 SERP における相対的な競合の程度のみを表します。この値は Bing Ads データに基づきます。<br>可能な値：<code>0.1</code>、<code>0.5</code>、<code>0.9</code><code>0.1</code> - 低競合、<br><code>0.5</code> - 中競合、<br><code>0.9</code> - 高競合。<br>データがない場合、値は <code>null</code> です"
    },
    "cpc": {
      "type": [
        "number",
        "null"
      ],
      "description": "<em>クリック単価</em><br>キーワードに対してこれまで支払われた平均クリック単価（USD）を表します。<br>データがない場合、値は <code>null</code> です"
    },
    "search_volume": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>月間平均検索ボリューム<br></em>ユーザーのターゲティングに応じた、指定したキーワード アイデアの Bing 検索エンジンでの（おおよその）検索数を表します。<br>検索ボリュームは最も近い 10 単位に丸められます。<br>データがない場合、値は <code>null</code> です",
      "format": "int64"
    },
    "categories": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "string",
          "null"
        ]
      },
      "description": "<em>製品とサービスのカテゴリ</em><br>このエンドポイントでは API がカテゴリを返しません。パラメーターは常に <code>null</code> になります"
    },
    "monthly_searches": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "object",
          "null"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/Response36Afe1097B20_MonthlySearchesInfo"
          }
        ]
      },
      "description": "<em>月間検索数</em><br>指定した地理的位置を対象とした、このキーワード アイデアの（おおよその）検索数（過去 12 か月分の利用可能なデータ）を表します<br>データがない場合、値は <code>null</code> です"
    }
  }
}
```

### Response36Afe1097B20_KeywordsDataBingSearchVolumeLiveTaskInfo

`#/components/schemas/Response36Afe1097B20_KeywordsDataBingSearchVolumeLiveTaskInfo`

```json
{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo"
    },
    {
      "type": "object",
      "properties": {
        "result": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": [
              "object",
              "null"
            ],
            "oneOf": [
              {
                "$ref": "#/components/schemas/Response36Afe1097B20_KeywordsDataBingSearchVolumeLiveResultInfo"
              }
            ]
          },
          "description": "<em>結果の配列</em>"
        }
      }
    }
  ]
}
```

### Response36Afe1097B20_MonthlySearchesInfo

`#/components/schemas/Response36Afe1097B20_MonthlySearchesInfo`

```json
{
  "type": "object",
  "properties": {
    "year": {
      "type": [
        "integer",
        "null"
      ],
      "description": "年"
    },
    "month": {
      "type": [
        "integer",
        "null"
      ],
      "description": "月"
    },
    "search_volume": {
      "type": [
        "integer",
        "null"
      ],
      "description": "月間平均検索ボリューム"
    }
  }
}
```