# 设置 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" } } } ] } ```