一括キーワード調査

一括キーワード調査ステータス取得

一括キーワード調査処理ステータス確認。POST /v1/search-volume で登録した一括キーワード調査の処理ステータスを確認する。 isCompleted が true になるまでポーリングすること(推奨間隔: 30秒)。 isCompleted=true になったら POST /v1/search-volume/{requestId}/results で結果を取得できる。

何回かステータスをチェックしてもisCompletedがtrueにならない場合は一定の時間が経ってから再度結果をチェックすることを推奨する。 (利用が混雑している場合は、取得完了まで数時間以上時間がかかるケースがあるため)

クレジットは消費しない。

get/v1/search-volume/{requestId}/status

Path parameters

requestIdnumber required
Example:1234567

POST /v1/search-volume で取得したリクエストID

Response

ステータス取得成功

resultboolean required

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

errorsstring[] required

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

Example response

{
  "result": true,
  "data": {
    "isCompleted": true,
    "statuses": {
      "searchVolume": "processed",
      "noiseReduction": "processing",
      "seoDifficulty": "skip"
    }
  },
  "errors": []
}

Changes