一括キーワード調査

一括キーワード調査登録

一括キーワード調査登録。 キーワードリストを渡すと非同期で月間検索数・SEO難易度・CPC・競合性などを調査開始する。

処理はバックグラウンドで行われるため、以下の手順で結果を取得すること:

  1. 戻り値の requestId を控える
  2. GET /v1/search-volume/{requestId}/status で完了を待つ(ポーリング推奨: 初回は30秒後、以降30秒間隔)
  3. isCompleted=true になったら POST /v1/search-volume/{requestId}/results で結果を取得する

通常は10秒程度で取得完了するが、seoDifficultyをONにした場合、最大60分程度時間がかかる。 ONの場合、一定の時間が経過してから処理ステータスを確認することを推奨する。 SEO以外の目的で当機能を使う場合、時短のためseoDifficultyをOFFすることを推奨する。

1キーワードあたり0.03クレジットを消費。seoDifficultyがONの場合、追加で1キーワードあたり0.75クレジットを消費する。ただし、1リクエストの消費クレジットの合計が15クレジットに満たない場合は15クレジットを消費する。

post/v1/search-volume

Request body

keywordsstring[] required

キーワード(入力上限50,000件)

seoDifficultyboolean

SEO難易度取得フラグ。true の場合にSEO難易度を取得する。省略時は false。

dataCompletionboolean

データ補完フラグ。true の場合にデータ補完を行う。省略時は true。

locationstring

地域名。省略時は Japan。

  • 指定可能な地域名は metadata の locations 一覧を参照(一覧は国レベルのみ)
  • 市区町村レベルの地域も指定可能。「市区町村名,上位地域名,国名」のようにカンマ区切りの正式名で指定する(例: Shibuya,Tokyo,Japan)
  • 途中の階層のみ(例: 都道府県のみ)の指定は未サポート
languagestring

言語名。指定可能な言語名は metadata の languages 一覧を参照。省略時は Japanese。

deduplicateboolean

キーワードの重複除去を行うかどうか。省略時は true。

Example request

{
  "keywords": [
    "ラッコ",
    "カワウソ"
  ],
  "location": "Japan",
  "language": "Japanese"
}

Response

登録成功

resultboolean required

API 呼び出しの成否。正常時は true、エラー時は false。

errorsstring[] required

エラーメッセージの配列。正常時は空配列。

Example response

{
  "result": true,
  "meta": {
    "consumedCredit": 15
  },
  "data": {
    "requestId": 1234567
  },
  "errors": []
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.