# キーワード密度

**API:** Data API

**Endpoint:** `POST /v1/beta/dataforseo/on_page/keyword_density`

**Tags:** DataForSEO

1 回のクロールにおける単語とフレーズの頻度です。`keyword_length` で n-gram のサイズを指定します。`total_items_count`、`items_count`、`items` を返します。完了したクロールを読み取るため、`post_dataforseo_on_page_submit` が返す `id` が必要です。`crawl_progress` と、`max_crawl_pages`・`pages_in_queue`・`pages_crawled` を含む `crawl_status` を返します。少ない結果を信じる前にこれらを確認してください。実行中のクロールは報告できる内容が少ないだけです。ここでわかるのはサイトが自身について述べている内容です。ウェブがそのサイトをどう評価しているかは `post_dataforseo_backlinks_anchors_live`、人々が何を検索しているかは `post_dataforseo_keywords_gads_search_volume_live` を使用してください。💰 アップストリームは無料：完了したクロールの照会には費用がかからず、費用がかかるのはクロール自体だけです。

### 料金の参考情報

- 計測方法：報告されたレスポンスコスト。
- 参考リクエスト見積もり：0.012 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": {
          "id": {
            "type": "string",
            "description": "<em>タスクの ID</em><br><strong>必須フィールド</strong><br>この ID は、<a href=\"/v3/on_page/task_post/\">Task POST</a> エンドポイントのレスポンスで取得できます<br>例：<br>\"07131248-1535-0216-1000-17384017ad04\""
          },
          "keyword_length": {
            "type": "integer",
            "description": "<em>キーワードの単語数</em><br><strong>必須フィールド</strong><br>可能な値：<br><code>1</code>、<code>2</code>、<code>3</code>、<code>4</code>、<code>5</code>"
          },
          "url": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>ページ URL</em><br>任意フィールド<br><strong>ここでページを指定しない場合、ウェブサイト全体の結果が返されます</strong><br>このフィールドを使用すると、API レスポンスには指定したページのキーワードのみが含まれます<br>ページは絶対 URL（<code>http://</code> または <code>https://</code> を含む）で指定する必要があります"
          },
          "limit": {
            "type": [
              "integer",
              "null"
            ],
            "description": "<em>返されるキーワードの最大数</em><br>任意フィールド<br>デフォルト値：<code>100</code><br>最大値：<code>1000</code>"
          },
          "filters": {
            "type": [
              "array",
              "null"
            ],
            "items": {
              "type": [
                "object",
                "null"
              ]
            },
            "description": "<em>結果フィルターパラメーターの配列</em><br>任意フィールド<br><strong>複数のフィルターを同時に追加できます（最大 8 個）</strong><br>条件の間には論理演算子 <code>and</code>、<code>or</code> を設定してください<br>次の演算子がサポートされています：<br><code>regex</code>、<code>not_regex</code>、<code>=</code>、<code>&lt;&gt;</code>、<code>in</code>、<code>not_in</code>、<code>like</code>、<code>not_like</code><br><code>like</code> と <code>not_like</code> で <code>%</code> 演算子を使用すると、0 文字以上の任意の文字列に一致させられます<br>例：<br><code>[\"keyword\",\"=\",\"%seo%\"]</code><p><code>[[\"keyword\",\"=\",\"%seo%\"],<br>\"and\",<br>[\"frequency\",\"&lt;\",\"6\"]]</code><p><code>[[\"keyword\",\"not_like\",\"%seo%\"],<br>\"and\",<br>[[\"frequency\",\"&gt;\",\"6\"],\"or\",[\"density\",\"&gt;\",\"0.02\"]]]</code><p>利用可能なフィルターの完全なリストは<a href=\"/v3/on_page/filters_and_thresholds/?bash\" target=\"_blank\" rel=\"noopener noreferrer\">このリンク</a>から確認できます。"
          },
          "order_by": {
            "type": [
              "array",
              "null"
            ],
            "items": {
              "type": "string"
            },
            "description": "<em>結果の並び替えルール</em><br>任意フィールド<br><code>filters</code> 配列と同じ値を使用して結果を並び替えられます<br>指定可能な並び替えの種類：<br><code>asc</code> - 結果を昇順で並び替えます<br><code>desc</code> - 結果を降順で並び替えます<br>並び替えの種類はカンマで設定します<br>例：<br><code>[\"frequency,desc\"]</code><br><strong>1 回のリクエストで設定できる並び替えルールは 3 つまでです</strong><br>複数の並び替えルールはカンマで区切ります<br>例：<br><code>[\"keyword,asc\",\"frequency,desc\"]</code>"
          },
          "tag": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>ユーザー定義のタスク識別子</em><br>任意フィールド<br><em>文字数上限は 255 です</em><br>このパラメーターを使ってタスクを識別し、結果と照合できます<br>指定した <code>tag</code> の値は、レスポンスの <code>data</code> オブジェクトに含まれます"
          }
        },
        "example": [
          {
            "id": "09101923-1535-0216-0000-2389a8854b70",
            "url": "https://dataforseo.com/",
            "keyword_length": 2,
            "filters": [
              "frequency",
              ">",
              5
            ]
          }
        ]
      }
    ]
  },
  "example": [
    {
      "id": "09101923-1535-0216-0000-2389a8854b70",
      "url": "https://dataforseo.com/",
      "keyword_length": 2,
      "filters": [
        "frequency",
        ">",
        5
      ]
    }
  ]
}
```

## Responses

### 200 — 操作成功

Headers:
- `X-Request-Id` (string) — Felo サポートに問い合わせる際に伝えるリクエスト識別子。

**application/json**

Schema: object | null

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

### 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": "タスクの総コスト（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_CrawlStatusInfo

`#/components/schemas/Response36Afe1097B20_CrawlStatusInfo`

```json
{
  "type": "object",
  "properties": {
    "max_crawl_pages": {
      "type": [
        "integer",
        "null"
      ],
      "description": "クロールするページ数の上限\n タスク設定時に指定した max_crawl_pages の制限を示します",
      "format": "int64"
    },
    "pages_in_queue": {
      "type": [
        "integer",
        "null"
      ],
      "description": "現在クロールキューにあるページ数",
      "format": "int64"
    },
    "pages_crawled": {
      "type": [
        "integer",
        "null"
      ],
      "description": "クロール済みのページ数",
      "format": "int64"
    }
  }
}
```

### Response36Afe1097B20_OnPageKeywordDensityItem

`#/components/schemas/Response36Afe1097B20_OnPageKeywordDensityItem`

```json
{
  "type": "object",
  "properties": {
    "keyword": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>返されたキーワード</em>"
    },
    "frequency": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>キーワードの出現頻度</em><br>キーワードがウェブサイト（<code>url</code> を指定した場合はウェブページ）に表示される回数"
    },
    "density": {
      "type": [
        "number",
        "null"
      ],
      "description": "<em>キーワード密度</em><br><code>frequency</code> と、ウェブページまたはウェブサイト上で <code>keyword_length</code> が設定されたキーワードの総数との比率で計算されます"
    }
  }
}
```

### Response36Afe1097B20_OnPageKeywordDensityResponseInfo

`#/components/schemas/Response36Afe1097B20_OnPageKeywordDensityResponseInfo`

```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_OnPageKeywordDensityTaskInfo"
              }
            ]
          },
          "description": "<em>タスクの配列</em>"
        }
      }
    }
  ]
}
```

### Response36Afe1097B20_OnPageKeywordDensityResultInfo

`#/components/schemas/Response36Afe1097B20_OnPageKeywordDensityResultInfo`

```json
{
  "type": "object",
  "properties": {
    "crawl_progress": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>クロールセッションのステータス</em><br>可能な値：<code>in_progress</code>、<code>finished</code>"
    },
    "crawl_status": {
      "type": [
        "object",
        "null"
      ],
      "oneOf": [
        {
          "$ref": "#/components/schemas/Response36Afe1097B20_CrawlStatusInfo"
        }
      ],
      "description": "<em>クロールセッションの詳細</em>"
    },
    "total_items_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>関連項目の総数</em><br>指定したウェブサイトまたはウェブページ上で、設定した <code>keyword_length</code> と <code>filters</code> に一致するキーワードの総数",
      "format": "int64"
    },
    "items_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>結果配列内の項目数</em>",
      "format": "int64"
    },
    "items": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "object",
          "null"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/Response36Afe1097B20_OnPageKeywordDensityItem"
          }
        ]
      },
      "description": "<em>項目の配列</em>"
    }
  }
}
```

### Response36Afe1097B20_OnPageKeywordDensityTaskInfo

`#/components/schemas/Response36Afe1097B20_OnPageKeywordDensityTaskInfo`

```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_OnPageKeywordDensityResultInfo"
              }
            ]
          },
          "description": "<em>結果の配列</em>"
        }
      }
    }
  ]
}
```