# 設定即時「DataForSEO 搜尋量」任務

**API:** Data API

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

**Tags:** DataForSEO

針對一組 `keywords`，從點擊流面板而非廣告平台推導的搜尋量。`use_clickstream` 用於切換混合比例。回傳 `location_code`、`language_code`、`use_clickstream`、`items_count` 與 `items`。採用 DataForSEO 的信封結構：資料位於 `tasks[0].result`，結果狀態位於 `tasks[0].status_code`——被拒絕的請求仍會回傳 HTTP 200。點擊流搜尋量常與 `post_dataforseo_keywords_gads_search_volume_live` 不一致，而這正是重點：一個衡量廣告主看到什麼，另一個衡量人們實際做了什麼。

### 計費參考

- 計量方式：依回報的回應成本計量。
- 參考請求估算：0.09 美元。
- 參考客戶倍率：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>關鍵字將轉換為小寫格式<p><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>可個別向 <code>https://api.dataforseo.com/v3/keywords_data/clickstream_data/locations_and_languages</code> 發出請求，取得帶 <code>location_name</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>若使用此欄位，可個別向 <code>https://api.dataforseo.com/v3/keywords_data/clickstream_data/locations_and_languages</code> 發出請求，取得帶 <code>location_code</code> 的可用地點清單<br>範例：<br><code class=\"long-string\">2826</code>"
          },
          "language_name": {
            "type": "string",
            "description": "<em>搜尋引擎語言全名</em><br><strong>未指定 <code>language_code</code> 時為必填欄位</strong><br>可個別向 <code>https://api.dataforseo.com/v3/keywords_data/clickstream_data/locations_and_languages</code> 發出請求，取得可用語言及其 <code>language_name</code> 清單<br>範例：<br><code class=\"long-string\">English</code>"
          },
          "language_code": {
            "type": "string",
            "description": "<em>搜尋引擎語言代碼</em><br><strong>未指定 <code>language_name</code> 時為必填欄位</strong><br>可個別向 <code>https://api.dataforseo.com/v3/keywords_data/clickstream_data/locations_and_languages</code> 發出請求，取得可用語言及其 <code>language_code</code> 清單<br>範例：<br><code class=\"long-string\">en</code>"
          },
          "use_clickstream": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "<em>使用點擊流資料提供結果</em><br>選填欄位<br>若設定為 <code>true</code>，你將取得根據點擊流資料的 DataForSEO 搜尋量值；<br>若設定為 <code>false</code>，將使用 Bing 搜尋量資料計算 DataForSEO 搜尋量；<br>預設值：<code>true</code>；<br><strong>注意：</strong>Bing 搜尋量僅適用於 <a href=\"https://docs.dataforseo.com/v3/keywords_data/bing/search_volume_history/locations_and_languages/?bash\" rel=\"noopener noreferrer\" target=\"_blank\">Bing Search Volume History Locations</a> 與 <a href=\"https://docs.dataforseo.com/v3/keywords_data/bing/locations/?bash\" rel=\"noopener noreferrer\" target=\"_blank\">Bing Ads Locations</a> 端點中提供的地點；即使將此參數設定為 <code>false</code>，其他任何地點的搜尋量值仍將根據點擊流資料計算"
          },
          "tag": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>使用者自訂任務識別碼</em><br>選填欄位<br><em>字元數上限為 255</em><br>可使用此參數識別任務，並將其與結果對應<br>可在回應的 <code>data</code> 物件中找到指定的 <code>tag</code> 值"
          }
        },
        "example": [
          {
            "location_code": 2840,
            "language_code": "en",
            "tag": "test-tag",
            "keywords": [
              "you tube",
              "youtube",
              "youtub"
            ]
          }
        ]
      }
    ]
  },
  "example": [
    {
      "location_code": 2840,
      "language_code": "en",
      "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_KeywordsDataClickstreamDataDataforseoSearchVolumeLiveResponseInfo"
    }
  ]
}
```

### 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": "任務總費用，美元",
      "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": "任務的狀態碼\n由 DataForSEO 產生，範圍如下：10000-60000\n完整回應碼清單請見此處"
    },
    "status_message": {
      "type": [
        "string",
        "null"
      ],
      "description": "任務的資訊訊息\n完整的一般資訊訊息清單請見此處"
    },
    "time": {
      "type": [
        "string",
        "null"
      ],
      "description": "執行時間，秒"
    },
    "cost": {
      "type": [
        "number",
        "null"
      ],
      "description": "任務總費用，美元",
      "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_KeywordsDataClickstreamDataDataforseoSearchVolumeLiveResponseInfo

`#/components/schemas/Response36Afe1097B20_KeywordsDataClickstreamDataDataforseoSearchVolumeLiveResponseInfo`

```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_KeywordsDataClickstreamDataDataforseoSearchVolumeLiveTaskInfo"
              }
            ]
          },
          "description": "<em>任務陣列</em>"
        }
      }
    }
  ]
}
```

### Response36Afe1097B20_KeywordsDataClickstreamDataDataforseoSearchVolumeLiveResultInfo

`#/components/schemas/Response36Afe1097B20_KeywordsDataClickstreamDataDataforseoSearchVolumeLiveResultInfo`

```json
{
  "type": "object",
  "properties": {
    "location_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>POST 陣列中的地點代碼</em><br>若沒有資料，則該值為 <code>null</code>"
    },
    "language_code": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>POST 陣列中的語言代碼<br></em><br><strong>注意：</strong>若 POST 陣列中的關鍵字拼寫有誤，將傳回拼寫正確之關鍵字的資料；<br>我們使用 Google Ads API 的功能檢查並驗證關鍵字拼寫，<a href=\"https://support.google.com/google-ads/answer/7476658\" target=\"_blank\" rel=\"noopener noreferrer\">透過此連結進一步瞭解</a>"
    },
    "use_clickstream": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "<em>表示 <code>use_clickstream</code> 參數是否啟用</em><br>可能的值：<code>true</code>、<code>false</code>"
    },
    "items_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>傳回於 <code>items</code> 陣列中的結果數</em>"
    },
    "items": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "object",
          "null"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/Response36Afe1097B20_KeywordsDataClickstreamDataSearchVolumeLiveItem"
          }
        ]
      },
      "description": "<em>關鍵字陣列</em><br>包含關鍵字及其搜尋量"
    }
  }
}
```

### Response36Afe1097B20_KeywordsDataClickstreamDataDataforseoSearchVolumeLiveTaskInfo

`#/components/schemas/Response36Afe1097B20_KeywordsDataClickstreamDataDataforseoSearchVolumeLiveTaskInfo`

```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_KeywordsDataClickstreamDataDataforseoSearchVolumeLiveResultInfo"
              }
            ]
          },
          "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>物件陣列，包含一年中某個月的搜尋量"
    }
  }
}
```

### 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": "每月平均搜尋量"
    }
  }
}
```
