# 相關關鍵字

**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>，結果陣列中的前 10 個關鍵字將被略過，並傳回後續關鍵字的資料"
          },
          "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>"
        }
      }
    }
  ]
}
```
