# 设置实时“搜索量”任务

**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 时，两者都应运行。本端点的提交与获取配套端点会以相同价格异步完成同样的工作，适合大到无法等待的批次。

### 计费参考

- 计量方式：按上报的响应成本计量。
- 参考请求估算：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>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>最小值：距今天两年；<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>不建议对过去一年的日期使用自定义时间范围"
          },
          "date_to": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>时间范围的结束日期</em><br>可选字段<br>如果未指定此字段，将提供最近 12 个月的数据；<br>最小值：距今天两年；<br>最大值：距今天一个月；<br><strong>注意：</strong>不建议对过去一年的日期使用自定义时间范围；<br>日期格式：<code>\"yyyy-mm-dd\"</code><br>示例：<br><code>\"2020-03-15\"</code><strong>注意：</strong>不建议对过去一年的日期使用自定义时间范围"
          },
          "search_partners": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "<em>Bing 搜索合作伙伴类型</em><br>可选字段<br>如果指定 <code class=\"prettyprint\">true</code>，结果将涵盖 Bing、Yahoo、AOL 以及托管 Bing、AOL 和 Yahoo 搜索的合作伙伴网站的拥有、运营和联合网络。<br>默认值：<code>false</code> - 结果为 Bing、AOL 和 Yahoo 搜索网络"
          },
          "tag": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>用户自定义任务标识符</em><br>可选字段<br><em>字符数上限为 255</em><br>可使用此参数标识任务，并将其与结果对应<br>可在响应的 <code>data</code> 对象中找到指定的 <code>tag</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": "任务总费用，美元",
      "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_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>表示该关键词历史平均每次点击费用（美元）。<br>若没有数据，则值为 <code>null</code>"
    },
    "search_volume": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>每月平均搜索量<br></em>表示针对给定关键词创意在 Bing 搜索引擎上的（近似）搜索次数，具体取决于用户的定位；<br>搜索量四舍五入到最接近的十位；<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>表示针对指定地点、该关键词创意的（近似）搜索次数（过去十二个月可用的数据）<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": "每月平均搜索量"
    }
  }
}
```