Apinoa Docs

Suggestions

获取 Yahoo! JAPAN 搜索框针对查询给出的联想词。

查看原始 .mdx
GET | POST /v1/yahoo-japan/suggestions

参数可以用 GET 的查询字符串发送,也可以用 POST 的 JSON 请求体发送,两者等价。

请求

curl -G "https://gateway.apinoa.com/v1/yahoo-japan/suggestions" \
  --data-urlencode "q=東京" \
  -H "x-api-key: $APINOA_API_KEY"

参数

参数类型必填说明
qstring是The query, search operators included.
countryenumThe market, as an ISO 3166 country code. JP

这些参数及所有响应类型也写在OpenAPI 文档中。

响应

在 data 中返回 Suggestions。 真实响应的节选:数组只保留前几项,长文本已截断。

{
  "success": true,
  "data": {
    "engine": "yahoo-japan",
    "query": "東京",
    "country": "JP",
    "suggestions": [
      {
        "text": "東京電力",
        "type": "query",
        "ext": {
          "url": "https://search.yahoo.co.jp/search?ei=UTF-8&p=%E6%9D%B1%E4%BA%AC%E9%9B%BB%E5%8A%9B&ai=2bec0c7d-70e8-4738-81cd-17060a283ad3&at=s"
        }
      },
      {
        "text": "東京ガス",
        "type": "query",
        "ext": {
          "url": "https://search.yahoo.co.jp/search?ei=UTF-8&p=%E6%9D%B1%E4%BA%AC%E3%82%AC%E3%82%B9&ai=2bec0c7d-70e8-4738-81cd-17060a283ad3&at=s"
        }
      }
    ]
  }
}

错误

状态代码含义
400INVALID_PARAMS参数缺失、未知、超出范围,或该引擎不接受。消息中会指出是哪一个。
401UNAUTHORIZED缺少 x-api-key 请求头,或密钥已吊销或未知。
402INSUFFICIENT_BALANCE余额不足以支付本次调用。请在控制台充值。
429MARKETPLACE_SATURATED并发调用过多。请等待 Retry-After 秒后重试。
502UPSTREAM_ERROR引擎返回了无法使用的内容。请退避后重试。
503SERVICE_UNAVAILABLE临时故障。请退避后重试。

全部错误代码见 Errors。失败的调用不计费。

价格

价格 每次调用 $0.0012。标价;单日调用超过 1,000 次后单价下调。

本页内容