API Description
SEO データ
SEO API データ は、はSE Rankingで有効なプロジェクトを作成することなく、主要なフレーズ（URL、スニペット、サイト順位含む）に関してトップ100位のSERPを取得することを目的としています。
「キーワードの追加」エンドポイントを使用するには費用がかかります:
$0.003キーワード追加
このメソッドは、検索結果を取得する為のクエリをキューに追加する事ができます。
パラメータ
| 名称 | 必須 | 説明 |
| query | はい | 検索クエリ、またはクエリ配列 (1クエリあたりの最大文字数 – 255、配列内の最大クエリ数 – 1000) |
| engine_id | はい | ユニーク 検索エンジン ID。 検索エンジンや、そのユニークIDの完全なリストを取得するには、GET /system/search-engines を使用します。(必ずGoogle または Yandexと入力してください) |
| region_name | いいえ | 検索の リージョン 名 (Google検索エンジンのみ) |
| region_id | いいえ | Yandex 検索エンジンのユニーク リージョン ID。GET /system/yandex-regions を使用して、Yandexの地域IDの完全なリストを取得する事ができます。 |
リクエスト フォーマット
POST /parsing/serp/tasks
{
"engine_id": 1,
"region_id": 140,
"query": "text"
or
"query": ["text", "text2"]
}結果
成功すると、サーバーはキューに追加された各クエリのユニークIDを返します。
| 名称 | 必須 | 説明 |
| task_id | はい | ユニーク クエリ ID |
レスポンス例
[
{
"query": :"text",
"task_id": 123456
}
]エラー
| HTTP コード | エラーメッセージ |
| 403 | Empty balance |
| 400 | Invalid engine_id |
| 400 | Invalid regione_id |
| 400 | Empty query |
| 400 | Query $query too long |
ステータス確認と確認結果の取得
このメソッドは、前回キューに追加されたキーワードの結果を取得する事ができます。キーワード順位がまだ記録されていない場合は、呼び出されたメソッドはそのステータスを返します。結果は24時間保持され、その後削除されます。
パラメータ
| 名称 | 必須 | 説明 |
| task_id | はい | ユニーク クエリ ID |
リクエスト フォーマット
GET /parsing/serp/tasks/{task_id}結果
成功すると、サーバーはクエリのステータスを返します。
クエリがキュー待ちの場合は、サーバーは次のステータスを返します: processing.
レスポンス例
{
"status": "processing"
}確認が完了すると、その結果が返されます。 成功すると、サーバーは TOP 100 検索結果のクエリ結果を含む配列を返します。
| 名称 | 必須 | 説明 |
| position | はい | TOP 100 のページ順位 |
| url | はい | TOP 100 にランクされているページのURL |
| title | はい | TOP 100 のページのタイトル |
| snippet | はい | TOP 100 のページにスニペット文 |
| cache_url | No | TOP 100 にランクされているページのキャッシュコピーへのリンク |
レスポンス例
{
"results": [
{
"position": "1",
"url": "https://www.pizzahut.com/",
"title": "Pizza Hut: Pizza Delivery",
"snippet": "Order pizza online for fast delivery or carryout from a store near you. View our full menu, see nutritional information, find store locations, and more.",
"cache_url": "https://webcache.googleusercontent.com/search?q=cache:oiTvlHsuOeEJ:https://www.pizzahut.com/+&cd=4&hl=en&ct=clnk&gl=us"
},
...
"position": "99",
"url": "https://techcrunch.com/2018/08/20/google-doctor-fork/",
"title": "Google created a fake pizza brand to test out creative strategies for ...",
"snippet": "Aug 20, 2018 - Google's Unskippable Labs team has been testing ad effectiveness in a compelling new way: It created a fake pizza brand called Doctor Fork, ...",
"cache_url": "https://webcache.googleusercontent.com/search?q=cache:wi5sKCy0ResJ:https://techcrunch.com/2018/08/20/google-doctor-fork/+&cd=120&hl=en&ct=clnk&gl=us"
}
]
}エラー
| HTTP コード | エラーメッセージ |
| 404 | Task not found |
全てのユーザー クエリのリスト
このメソッドは、直近24時間以内にキューに追加された全てのユーザー クエリのリストを取得する事ができます。
リクエスト フォーマット
GET /parsing/serp/tasks
結果
成功すると、サーバーはキューに追加されたクエリの配列とそのステータスを返します。
| 名称 | 説明 |
| id | ユニーク クエリ ID |
| query | キーワード または フレーズ (クエリ) |
| region_name | 検索の リージョン 名 (Google検索エンジンのみ) |
| engine_id | ユニーク 検索エンジン ID。 検索エンジンや、そのユニークIDの完全なリストを取得するには、GET /system/search-engines を使用します。(必ずGoogle または Yandexと入力してください) |
| region_id | Yandex 検索エンジンのユニーク リージョン ID。GET /system/yandex-regions を使用して、Yandexのリージョン IDの完全なリストを取得する事ができます。 |
| added | キューにクエリが追加された時の日付 |
| is_completed | クエリ確認ステータス (1 – チェック済, 0 – 未チェック) |
レスポンス例
{
"tasks": [
{
"id": "18638740",
"query": "book",
"region_name": null,
"engine_id": "411",
"region_id": "213",
"added": "2018-08-28 10:25:29",
"is_completed": "0"
},
...
{
"id": "18639398",
"query": "pizza",
"region_name": "New York",
"engine_id": "200",
"region_id": "0",
"added": "2018-08-28 12:25:52",
"is_completed": "1"
}
]
}