# 「クリックストリーム検索ボリューム（一括）」ライブタスクの設定

**API:** Data API

**Endpoint:** `POST /v1/beta/dataforseo/keywords_data/clickstream_data/bulk_search_volume/live`

**Tags:** DataForSEO

1 回の呼び出しで多数の `keywords` のクリックストリーム検索ボリュームを、言語の次元なしで取得します。DataForSEO のエンベロープに包まれます。データは `tasks[0].result`、結果は `tasks[0].status_code` に格納され、拒否されたリクエストでも HTTP 200 が返ります。キーワードごとに言語を指定する版は `post_dataforseo_keywords_clickstream_search_volume_live` です。料金はキーワード単位ではなく呼び出し単位なので、リストにはこちらを使ってください。

### 料金の参考情報

- 計測方法：報告されたレスポンスコスト。
- 参考リクエスト見積もり：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>対象キーワード</em><br><strong>必須フィールド</strong><br>UTF-8 エンコーディング<br>この配列で指定できるキーワードの最大数: 1000<br>各キーワードは 3 文字以上である必要があります<br>キーワードは小文字形式に変換されます<br><strong>注意:</strong> 一部の記号や文字（UTF 記号、絵文字など）は使用できません<br>使用できる記号や文字については、<a href=\"https://dataforseo.com/help-center/using-symbols-in-keywords-when-setting-a-google-ads-task\" target=\"_blank\" rel=\"noopener noreferrer\">こちらの記事</a>を参照してください<p>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\" rel=\"noopener noreferrer\" target=\"_blank\">ヘルプセンター記事</a>を参照してください"
          },
          "location_name": {
            "type": "string",
            "description": "<em>所在地の正式名</em><br><strong><code>location_code</code> を指定しない場合は必須フィールド</strong><br><strong>注意:</strong> <code>location_name</code> または <code>location_code</code> のいずれかを指定する必要があります<br>利用可能な所在地とその <code>location_name</code> の一覧は、<br><code>https://api.dataforseo.com/v3/keywords_data/clickstream_data/locations_and_languages</code> に個別にリクエストして取得できます<br>例:<br><code class=\"long-string\">United Kingdom</code>"
          },
          "location_code": {
            "type": "integer",
            "description": "<em>所在地コード</em><br><strong><code>location_name</code> を指定しない場合は必須フィールド</strong><br><strong>注意:</strong> <code>location_name</code> または <code>location_code</code> のいずれかを指定する必要があります<br>利用可能な所在地とその <code>location_code</code> の一覧は、<br><code>https://api.dataforseo.com/v3/keywords_data/clickstream_data/locations_and_languages</code> に個別にリクエストして取得できます<br>例:<br><code class=\"long-string\">2840</code>"
          },
          "tag": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>ユーザー定義のタスク識別子</em><br>任意フィールド<br><em>文字数上限は 255 です</em><br>このパラメーターを使ってタスクを識別し、結果と照合できます<br>指定した <code>tag</code> の値は、レスポンスの <code>data</code> オブジェクトに含まれます"
          }
        },
        "example": [
          {
            "location_code": 2840,
            "tag": "test-tag",
            "keywords": [
              "you tube",
              "youtube",
              "youtub"
            ]
          }
        ]
      }
    ]
  },
  "example": [
    {
      "location_code": 2840,
      "tag": "test-tag",
      "keywords": [
        "you tube",
        "youtube",
        "youtub"
      ]
    }
  ]
}
```

## Responses

### 200 — 操作成功

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

**application/json**

Schema: object | null

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

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

`#/components/schemas/Response36Afe1097B20_KeywordsDataClickstreamDataBulkSearchVolumeLiveResponseInfo`

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

### Response36Afe1097B20_KeywordsDataClickstreamDataBulkSearchVolumeLiveResultInfo

`#/components/schemas/Response36Afe1097B20_KeywordsDataClickstreamDataBulkSearchVolumeLiveResultInfo`

```json
{
  "type": "object",
  "properties": {
    "location_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>POST 配列内のロケーションコード</em>"
    },
    "items_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em><code>items</code> 配列で返される結果の数</em>",
      "format": "int64"
    },
    "items": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "object",
          "null"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/Response36Afe1097B20_KeywordsDataClickstreamDataSearchVolumeLiveItem"
          }
        ]
      },
      "description": "<em>キーワードと関連データを含みます</em>"
    }
  }
}
```

### Response36Afe1097B20_KeywordsDataClickstreamDataBulkSearchVolumeLiveTaskInfo

`#/components/schemas/Response36Afe1097B20_KeywordsDataClickstreamDataBulkSearchVolumeLiveTaskInfo`

```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_KeywordsDataClickstreamDataBulkSearchVolumeLiveResultInfo"
              }
            ]
          },
          "description": "<em>結果の配列</em>"
        }
      }
    }
  ]
}
```

### Response36Afe1097B20_KeywordsDataClickstreamDataSearchVolumeLiveItem

`#/components/schemas/Response36Afe1097B20_KeywordsDataClickstreamDataSearchVolumeLiveItem`

```json
{
  "type": "object",
  "properties": {
    "keyword": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>POST 配列で指定されたキーワード</em>"
    },
    "search_volume": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>キーワードの現在の検索ボリューム</em>",
      "format": "int64"
    },
    "monthly_searches": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "object",
          "null"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/Response36Afe1097B20_MonthlySearchesInfo"
          }
        ]
      },
      "description": "<em>月間検索ボリューム</em><br>1 年の中のある月の検索ボリュームを含むオブジェクトの配列"
    }
  }
}
```

### 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": "月間平均検索ボリューム"
    }
  }
}
```