# 設定 YouTube 自然搜尋任務 **API:** Data API **Endpoint:** `POST /v1/beta/dataforseo/serp/youtube/organic/task_post` **Tags:** DataForSEO 將 YouTube 上某個關鍵字的排名結果排入佇列，在 `tasks[0].id` 中傳回任務 `id`。採用 DataForSEO 的信封結構：資料位於 `tasks[0].result`，結果狀態位於 `tasks[0].status_code`——被拒絕的請求仍會回傳 HTTP 200。即時版本會立即回應，對單次查詢更簡單；當批次作業會超過一次工具呼叫的時間時，請使用佇列。 ### 計費參考 - 計量方式：依回報的回應成本計量。 - 參考請求估算：0.02 美元。 - 參考客戶倍率：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": { "keyword": { "type": "string", "description": "keyword\n必填欄位\n在 keyword 欄位中最多可指定 700 個字元\n所有 %## 都將被解碼（另外，字元 ‘+’ 會被解碼為空白字元）\n如果需要在 keyword 中使用 “%” 字元，請將其指定為 “%25”；\n如果需要在 keyword 中使用 “+” 字元，請將其指定為 “%2B”；\n有關 DataForSEO API 中 keyword 和 keywords 欄位的規則與限制，請參閱這篇說明中心文章" }, "location_code": { "type": [ "integer", "null" ], "description": "搜尋引擎地點代碼\n未指定 location_name 時為必填欄位\n如果使用此欄位，則無需指定 location_name\n可單獨向 https://api.dataforseo.com/v3/serp/youtube/locations 發出請求，取得搜尋引擎支援的地點及其 location_code 清單\n範例：\n2840" }, "language_code": { "type": [ "string", "null" ], "description": "搜尋引擎語言代碼\n未指定 language_name 時為必填欄位\n如果使用此欄位，則無需指定 language_name\n可單獨向 https://api.dataforseo.com/v3/serp/youtube/languages 發出請求，取得搜尋引擎支援的語言及其 language_code 清單\n範例：\nen" }, "device": { "type": [ "string", "null" ], "description": "裝置類型\n選填欄位\n傳回特定裝置類型的結果\n可用值：desktop、mobile" }, "priority": { "type": [ "integer", "null" ], "description": "任務優先順序\n選填欄位\n可取以下值：\n1 – 一般執行優先順序（預設設定）\n2 – 高執行優先順序\n高執行優先順序的任務將額外收費。\n費用可在定價頁計算。" }, "pingback_url": { "type": [ "string", "null" ], "description": "已完成任務的通知 URL\n選填欄位\n任務完成後，我們會向你指定的 URL 傳送 GET 請求進行通知\n可將 ‘$id’ 字串用作 $id 變數，將 ‘$tag’ 用作經 URL 編碼的 $tag 變數。傳送請求前我們會設定必要的值。\n範例：\nhttp://your-server.com/pingscript?id=$id\nhttp://your-server.com/pingscript?id=$id&tag=$tag\n注意：pingback_url 中的特殊字元會進行 URL 編碼；\n例如，# 字元會被編碼為 %23\n詳情請參閱我們的說明中心" }, "postback_url": { "type": [ "string", "null" ], "description": "用於傳送任務結果的返回 URL\n選填欄位\n任務完成後，我們會將結果以 gzip 格式壓縮，並向你指定的 postback_url 傳送 POST 請求\n可將 ‘$id’ 字串用作 $id 變數，將 ‘$tag’ 用作經 URL 編碼的 $tag 變數。傳送請求前我們會設定必要的值。\n範例：\nhttp://your-server.com/postbackscript?id=$id\nhttp://your-server.com/postbackscript?id=$id&tag=$tag\n注意：postback_url 中的特殊字元會進行 URL 編碼；\n例如，# 字元會被編碼為 %23\n詳情請參閱我們的說明中心" }, "postback_data": { "type": [ "string", "null" ], "description": "postback_url 資料類型\n指定 postback_url 時為必填欄位\n對應將傳送到你伺服器的資料類型\n可能的值：\nadvanced" }, "location_name": { "type": [ "string", "null" ], "description": "搜尋引擎地點全名\n未指定 location_code 時為必填欄位\n如果使用此欄位，則無需指定 location_code\n可單獨向 https://api.dataforseo.com/v3/serp/youtube/locations 發出請求，取得搜尋引擎支援的地點及其 location_name 清單\n範例：\nUnited States" }, "language_name": { "type": [ "string", "null" ], "description": "搜尋引擎語言全名\n未指定 language_code 時為必填欄位\n如果使用此欄位，則無需指定 language_code\n可單獨向 https://api.dataforseo.com/v3/serp/youtube/languages 發出請求，取得搜尋引擎支援的語言及其 language_name 清單\n範例：\nEnglish" }, "os": { "type": [ "string", "null" ], "description": "裝置作業系統\n選填欄位\n如果在 device 欄位中指定 desktop，請從以下值中選擇：windows、macos\n預設值：windows\n如果在 device 欄位中指定 mobile，請從以下值中選擇：android、ios\n預設值：android" }, "tag": { "type": [ "string", "null" ], "description": "使用者自訂任務識別碼\n選填欄位\n字元數上限為 255\n可使用此參數識別任務，並將其與結果對應\n可在回應的 data 物件中找到指定的 tag 值" }, "search_param": { "type": [ "string", "null" ], "description": "搜尋查詢的附加參數\n選填欄位\n範例：\nsp=EgIQAg%253D%253D" }, "block_depth": { "type": [ "integer", "null" ], "description": "解析深度\n選填欄位\nSERP 中的結果區塊數量\n預設值：20\n最大值：700\n注意：你的帳戶將按每個最多包含 20 個結果區塊的 SERP 計費；\n因此，如果搜尋引擎傳回超過 20 筆結果，將區塊深度設為高於 20 可能產生額外費用；\n如果指定的區塊深度高於回應中的結果數量，差額將自動退還至你的帳戶餘額" } }, "example": [ { "language_code": "en", "location_code": 2840, "keyword": "audi" } ] } ] }, "example": [ { "language_code": "en", "location_code": 2840, "keyword": "audi" } ] } ``` ## Responses ### 200 — 操作成功 Headers: - `X-Request-Id` (string) — 聯絡 Felo 支援時需提供的請求識別碼。 **application/json** Schema: object | null ```json { "type": [ "object", "null" ], "oneOf": [ { "$ref": "#/components/schemas/Response36Afe1097B20_SerpYoutubeOrganicTaskPostResponseInfo" } ] } ``` ### 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_SerpYoutubeOrganicTaskPostResponseInfo `#/components/schemas/Response36Afe1097B20_SerpYoutubeOrganicTaskPostResponseInfo` ```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_SerpYoutubeOrganicTaskPostTaskInfo" } ] }, "description": "任務陣列" } } } ] } ``` ### Response36Afe1097B20_SerpYoutubeOrganicTaskPostTaskInfo `#/components/schemas/Response36Afe1097B20_SerpYoutubeOrganicTaskPostTaskInfo` ```json { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": [ "object", "null" ], "description": "結果陣列在此情況下，該值將為 null" } } } ] } ```