# 相关关键词

**API:** Data API

**Endpoint:** `POST /v1/beta/dataforseo/dataforseo_labs/amazon/related_keywords/live`

**Tags:** DataForSEO

与种子关键词相关的 Amazon 搜索词。使用 `limit`、`offset` 和 `offset_token` 分页；翻过前几页后改用该令牌。采用 DataForSEO 的信封结构：数据位于 `tasks[0].result`，结果状态位于 `tasks[0].status_code`——被拒绝的请求仍会返回 HTTP 200。Google 一侧的对应端点是 `post_dataforseo_labs_google_related_keywords_live`；购物意图与网页意图差异很大，不要把两者互相替代。

### 计费参考

- 计量方式：按上报的响应成本计量。
- 参考请求估算：0.1356 美元。
- 参考客户倍率：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": "<em>关键词</em><br><strong>必填字段</strong><br>UTF-8 编码<br>关键词应使用小写形式指定<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><strong>注意：</strong>必须指定 <code>location_name</code> 或 <code>location_code</code><br>可单独向 <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code> 发起请求，获取可用地点及其 <code>location_name</code> 的列表；<br><strong>注意：</strong>此端点目前仅支持美国、埃及、沙特阿拉伯和阿拉伯联合酋长国的地点；<br>示例：<br><code class=\"long-string\">United States</code>"
          },
          "location_code": {
            "type": "integer",
            "description": "<em>地点代码</em><br><strong>未指定 <code>location_name</code> 时为必填字段</strong><br><strong>注意：</strong>必须指定 <code>location_name</code> 或 <code>location_code</code><br>可单独向 <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code> 发起请求，获取可用地点及其 <code>location_code</code> 的列表；<br><strong>注意：</strong>此端点目前仅支持美国、埃及、沙特阿拉伯和阿拉伯联合酋长国的地点；<br>示例：<br><code class=\"long-string\">2840</code>"
          },
          "language_name": {
            "type": "string",
            "description": "<em>语言全名</em><br><strong>未指定 <code>language_code</code> 时为必填字段</strong><br><strong>注意：</strong>必须指定 <code>language_name</code> 或 <code>language_code</code><br>可单独向 <code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code> 发起请求，获取可用地点及其 <code>language_name</code> 的列表<br>示例：<br><code class=\"long-string\">English</code>"
          },
          "language_code": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>语言代码</em><br><strong>未指定 <code>language_name</code> 时为必填字段</strong><br><strong>注意：</strong>必须指定 <code>language_name</code> 或 <code>language_code</code><br>可单独向 <code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code> 发起请求，获取可用地点及其 <code>language_code</code> 的列表<br>示例：<br><code class=\"long-string\">en</code>"
          },
          "depth": {
            "type": [
              "integer",
              "null"
            ],
            "description": "<em>关键词搜索深度</em><br>可选字段<br>默认值：<code>1</code>；<br>返回结果的数量取决于此字段设置的值；<br>可指定 0 到 4 的层级；<br>各层级的关键词数量估算（最大值）：<br>0 - <code>keyword</code> 字段中设置的关键词<br>1 – 6 个关键词<br>2 – 42 个关键词<br>3 – 258 个关键词<br>4 – 1554 个关键词"
          },
          "include_seed_keyword": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "<em>包含种子关键词的数据</em><br>可选字段<br>如果设为 <code>true</code>，响应中的 <code>seed_keyword_data</code> 数组将提供 <code>keyword</code> 字段所指定种子关键词的数据<br>默认值：<code>false</code>"
          },
          "ignore_synonyms": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "<em>忽略高度相似的关键词</em><br>可选字段<br>如果设为 <code class=\"prettyprint\">true</code>，则只返回核心关键词，所有高度相似的关键词都会被排除；  <br>默认值：<code>false</code>"
          },
          "limit": {
            "type": [
              "integer",
              "null"
            ],
            "description": "<em>返回关键词的最大数量</em><br>可选字段<br>默认值：<code>100</code><br>最大值：<code>1000</code>"
          },
          "offset": {
            "type": [
              "integer",
              "null"
            ],
            "description": "<em>返回的关键词在结果数组中的偏移量</em><br>可选字段<br>默认值：<code>0</code><br>如果指定 <code>10</code>，结果数组中的前十个关键词将被跳过，并返回后续关键词的数据"
          },
          "tag": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>用户自定义任务标识符</em><br>可选字段<br><em>字符数上限为 255</em><br>可使用此参数标识任务，并将其与结果对应<br>可在响应的 <code>data</code> 对象中找到指定的 <code>tag</code> 值"
          }
        },
        "example": [
          {
            "keyword": "computer mouse",
            "language_name": "English",
            "location_code": 2840,
            "limit": 5,
            "include_seed_keyword": true
          }
        ]
      }
    ]
  },
  "example": [
    {
      "keyword": "computer mouse",
      "language_name": "English",
      "location_code": 2840,
      "limit": 5,
      "include_seed_keyword": true
    }
  ]
}
```

## Responses

### 200 — 操作成功

Headers:
- `X-Request-Id` (string) — 联系 Felo 支持时需提供的请求标识符。

**application/json**

Schema: object | null

```json
{
  "type": [
    "object",
    "null"
  ],
  "oneOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_DataforseoLabsAmazonRelatedKeywordsLiveResponseInfo"
    }
  ]
}
```

### 400 — 无法处理该请求。请检查请求参数。

### 401 — 需要有效的 Felo API 密钥。

### 402 — 由于未满足计费要求，请求无法继续。

### 403 — 该账户无权执行此操作。

### 429 — 已达到请求或支出限额。

### 502 — 服务无法完成该请求。

### 503 — API 或计费服务暂时不可用。

### 504 — 服务在处理请求时超时。

### default — 错误响应；上游透传响应可能采用提供方格式

**application/json**

Schema:

```json
{}
```

## Schema definitions

### Response36Afe1097B20_AmazonKeywordData

`#/components/schemas/Response36Afe1097B20_AmazonKeywordData`

```json
{
  "properties": {
    "se_type": {
      "type": [
        "string",
        "null"
      ],
      "description": "搜索引擎类型"
    },
    "keyword": {
      "type": [
        "string",
        "null"
      ],
      "description": "相关关键词"
    },
    "location_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "POST 数组中的地点代码",
      "format": "int64"
    },
    "language_code": {
      "type": [
        "string",
        "null"
      ],
      "description": "POST 数组中的语言代码"
    },
    "keyword_info": {
      "type": [
        "object",
        "null"
      ],
      "oneOf": [
        {
          "$ref": "#/components/schemas/Response36Afe1097B20_AmazonKeywordInfo"
        }
      ],
      "description": "所返回关键词的关键词信息"
    }
  }
}
```

### Response36Afe1097B20_AmazonKeywordInfo

`#/components/schemas/Response36Afe1097B20_AmazonKeywordInfo`

```json
{
  "properties": {
    "se_type": {
      "type": [
        "string",
        "null"
      ],
      "description": "搜索引擎类型"
    },
    "last_updated_time": {
      "type": [
        "string",
        "null"
      ],
      "description": "关键词数据的更新日期和时间\nUTC 格式：“yyyy-mm-dd hh-mm-ss +00:00”\n示例：    '2019-11-15 12:57:46 +00:00'"
    },
    "search_volume": {
      "type": [
        "integer",
        "null"
      ],
      "description": "平均每月搜索量比率\n表示 Amazon 上提供的关键词创意的（近似）搜索次数",
      "format": "int64"
    }
  }
}
```

### 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_DataforseoLabsAmazonRelatedKeywordsLiveItem

`#/components/schemas/Response36Afe1097B20_DataforseoLabsAmazonRelatedKeywordsLiveItem`

```json
{
  "type": "object",
  "properties": {
    "se_type": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>搜索引擎类型</em>"
    },
    "keyword_data": {
      "type": [
        "object",
        "null"
      ],
      "oneOf": [
        {
          "$ref": "#/components/schemas/Response36Afe1097B20_AmazonKeywordData"
        }
      ],
      "description": "<em>返回关键词的关键词数据</em>"
    },
    "depth": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>关键词搜索深度</em>"
    },
    "related_keywords": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": "string"
      },
      "description": "<em>相关关键词列表</em><br>表示与上方数组中返回的关键词相关的搜索查询列表"
    }
  }
}
```

### Response36Afe1097B20_DataforseoLabsAmazonRelatedKeywordsLiveResponseInfo

`#/components/schemas/Response36Afe1097B20_DataforseoLabsAmazonRelatedKeywordsLiveResponseInfo`

```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_DataforseoLabsAmazonRelatedKeywordsLiveTaskInfo"
              }
            ]
          },
          "description": "<em>任务数组</em>"
        }
      }
    }
  ]
}
```

### Response36Afe1097B20_DataforseoLabsAmazonRelatedKeywordsLiveResultInfo

`#/components/schemas/Response36Afe1097B20_DataforseoLabsAmazonRelatedKeywordsLiveResultInfo`

```json
{
  "type": "object",
  "properties": {
    "se_type": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>搜索引擎类型</em>"
    },
    "seed_keyword": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>POST 数组中的关键词</em>"
    },
    "seed_keyword_data": {
      "type": [
        "object",
        "null"
      ],
      "oneOf": [
        {
          "$ref": "#/components/schemas/Response36Afe1097B20_AmazonKeywordData"
        }
      ],
      "description": "<em>种子关键词的关键词数据</em><br>对象中的字段与 <code>keyword_data</code> 相同"
    },
    "location_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>POST 数组中的位置代码</em>"
    },
    "language_code": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>POST 数组中的语言代码</em>"
    },
    "total_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>我们数据库中与你的请求相关的结果总数</em>",
      "format": "int64"
    },
    "items_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em><code>items</code> 数组中返回的结果数</em>",
      "format": "int64"
    },
    "items": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "object",
          "null"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/Response36Afe1097B20_DataforseoLabsAmazonRelatedKeywordsLiveItem"
          }
        ]
      },
      "description": "<em>包含关键词及相关数据的对象</em>"
    }
  }
}
```

### Response36Afe1097B20_DataforseoLabsAmazonRelatedKeywordsLiveTaskInfo

`#/components/schemas/Response36Afe1097B20_DataforseoLabsAmazonRelatedKeywordsLiveTaskInfo`

```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_DataforseoLabsAmazonRelatedKeywordsLiveResultInfo"
              }
            ]
          },
          "description": "<em>结果数组</em>"
        }
      }
    }
  ]
}
```