# 関連キーワード

**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 USD。
- 参考顧客乗数：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>keyword</code> フィールドで指定したシードキーワードのデータがレスポンスの <code>seed_keyword_data</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>tag</code> の値は、レスポンスの <code>data</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": "月平均の検索量レート\nAmazon で提供されたキーワードアイデアの検索回数（概算）を表します",
      "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": "タスクの総コスト（USD）",
      "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": "タスクのステータスコード\nDataForSEO によって生成され、次の範囲の値になります: 10000-60000\nレスポンスコードの完全な一覧はこちらです"
    },
    "status_message": {
      "type": [
        "string",
        "null"
      ],
      "description": "タスクの情報メッセージ\n一般的な情報メッセージの完全な一覧はこちらです"
    },
    "time": {
      "type": [
        "string",
        "null"
      ],
      "description": "実行時間（秒）"
    },
    "cost": {
      "type": [
        "number",
        "null"
      ],
      "description": "タスクの総コスト（USD）",
      "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>"
        }
      }
    }
  ]
}
```