Amazon順位の概要API
POST
APIの稼働状況
- 24時間の稼働状況
- 正常
- 24時間の平均応答時間
- —
- 良好/正常
- 利用可能
- 制限あり
- ほぼ停止
正常
過去24時間
過去30日間
最大20件のAmazon US商品について、検索結果での露出度を比較します。asinsに指定したASINごとに1件を返します。各件では、その商品がオーガニック結果およびスポンサー結果として順位を得ているキーワード数、そのうち1位・上位3位・上位10位のキーワード数、各セットの月間検索ボリュームを集計します。キーワードデータのないASINは返りません。
料金は1,000リクエストあたり$11.51(1回あたり$0.01151)です。失敗した呼び出しと空の結果には課金されません。 同期処理です。時間のかかるジョブでは、ボディに"mode": "async"を追加し、job_idを取得してポーリングしてください。
AIプロンプト
EveryInfraのAmazon 順位の概要エンドポイント(amazon/rank_overview)を使ったデータ収集スクリプトの作成を手伝ってください。
エンドポイントの仕組み:
- リクエスト:ヘッダーにAuthorization: Bearer <API key>を指定して、https://api.everyinfra.com/api/v1/socialにPOSTします。APIキーは環境変数EVERYINFRA_API_KEYから読み込み、ハードコードしないでください。
- リクエストボディでplatformにamazon、actionにrank_overviewを指定し、パラメータはparamsの中に入れます。
- 必須パラメータ:
- asins: rank_overview(1〜20個)またはkeyword_intersections(2〜10個)に渡すASINで、配列またはカンマ区切りの文字列で指定します。各ASINはB0C2JXSHSKのような大文字英字または数字の10文字です。対象はUSマーケットプレイス(amazon.com)のみです。rank_overviewではASINごとに1件が返り、キーワードデータのないASINは除外されます。
- 任意パラメータ:
- limit: この呼び出しで返す最大行数で、1以上の整数で指定します。省略するとデフォルト値が適用されます。また、返される行数がこれより少なくなる場合があります。
- レコードのリストを返します。各レコードの主なフィールド: asin(Amazon標準識別番号(Amazon Standard Identifica…)、url、organic_keywords(競合商品がオーガニック結果としてランクインしているすべてのキーワード)、organic_top1_keywords、organic_top3_keywords、organic_top10_keywords、organic_search_volume、sponsored_keywords(競合商品がスポンサー結果としてランクインしているすべてのキーワード)、sponsored_top1_keywords、sponsored_top3_keywords、sponsored_top10_keywords、sponsored_search_volume.
- リクエストボディの例:
{
"platform": "amazon",
"action": "rank_overview",
"params": {
"asins": [
"B0C2JXSHSK",
"B0CM8STPNH"
]
}
}
- 料金:1,000リクエストあたり$11.51。失敗時および結果が空の場合は課金されません。
- 対象が数十〜数百件ある場合は、ボディに"mode": "async"を追加します。すぐにjob_idが返されるので、GET https://api.everyinfra.com/api/v1/jobs/{job_id}をポーリングして結果を取得します。
- 422の場合は、エラーに含まれる推奨パラメータ名と指定可能な値を使ってリクエストを修正します。429または503の場合は、Retry-Afterの指定に従って待ってから再試行します。
コードを書く前に、必要な対象とその件数、必要なフィールド、希望する出力形式を私に質問してください。そのうえで、計画と概算費用を私に確認してください。リクエストパラメータ
| 名前 | 場所 | 型 | 必須 | デフォルト | 説明 |
|---|---|---|---|---|---|
Authorization | header | string | はい | - | Bearerの後にAPIキーを続けます。APIキーはコンソールで作成してください。URLやコードリポジトリには絶対に含めないでください。 |
platform | body | string | はい | amazon | プラットフォームの識別子です。値は固定です。 |
action | body | string | はい | rank_overview | 機能の識別子です。値は固定です。 |
asins | body.params | array | はい | - | rank_overview(1〜20個)またはkeyword_intersections(2〜10個)に渡すASINで、配列またはカンマ区切りの文字列で指定します。各ASINはB0C2JXSHSKのような大文字英字または数字の10文字です。対象はUSマーケットプレイス(amazon.com)のみです。rank_overviewではASINごとに1件が返り、キーワードデータのないASINは除外されます。keyword_intersectionsでは各件が、すべての商品が順位を得ているキーワード1つに対応します。それ以外の個数は、呼び出しの実行前に拒否されます。 |
limit | body.params | integer (1–) | いいえ | - | この呼び出しで返す最大行数で、1以上の整数で指定します。省略するとデフォルト値が適用されます。また、返される行数がこれより少なくなる場合があります。 |
コードサンプル
bash
curl -X POST 'https://api.everyinfra.com/api/v1/social' \
-H "Authorization: Bearer $EVERYINFRA_API_KEY" \
-H 'Content-Type: application/json' \
--data-raw '{
"platform": "amazon",
"action": "rank_overview",
"params": {
"asins": [
"B0C2JXSHSK",
"B0CM8STPNH"
]
}
}'OpenAPI定義(JSON)サンプルは環境変数EVERYINFRA_API_KEYからAPIキーを読み込みます。コピーしたコードにAPIキーが含まれることはありません。
レスポンス例
フィールドプレビュー
このパラメータのサンプルレスポンスはまだありません。このプレビューはAPI定義に基づくレスポンスの構造とフィールドを示したもので、値は…で表しています。実際の呼び出し結果ではありません。
json
{
"id": "req_…",
"platform": "amazon",
"action": "rank_overview",
"results": [
{
"asin": …,
"url": …,
"organic_keywords": …,
"organic_top1_keywords": …,
"organic_top3_keywords": …,
"organic_top10_keywords": …,
"organic_search_volume": …,
"sponsored_keywords": …,
"sponsored_top1_keywords": …,
"sponsored_top3_keywords": …,
"sponsored_top10_keywords": …,
"sponsored_search_volume": …,
"platform": …
}
],
"count": …,
"billing": {
"charged": …,
"charged_usd": …,
"balance_after_usd": …,
…
},
"quota": { … }
}レスポンスフィールド
業務データはresultsに含まれます。この表はレコードに含まれうるフィールドの一覧です。プラットフォームに表示されない値を作り出すことはありません。
| フィールド | 意味 |
|---|---|
asin | Amazon標準識別番号(Amazon Standard Identification Number)。ストア内で商品を一意に識別するIDです。 |
url | プラットフォーム上のレコードへのリンクです。 |
organic_keywords | 競合商品がオーガニック結果としてランクインしているすべてのキーワード。共通キーワードに限りません(product_competitors)。 |
organic_top1_keywords | プラットフォーム上の意味のまま |
organic_top3_keywords | プラットフォーム上の意味のまま |
organic_top10_keywords | プラットフォーム上の意味のまま |
organic_search_volume | プラットフォーム上の意味のまま |
sponsored_keywords | 競合商品がスポンサー結果としてランクインしているすべてのキーワード。共通キーワードに限りません(product_competitors)。 |
sponsored_top1_keywords | プラットフォーム上の意味のまま |
sponsored_top3_keywords | プラットフォーム上の意味のまま |
sponsored_top10_keywords | プラットフォーム上の意味のまま |
sponsored_search_volume | プラットフォーム上の意味のまま |
platform | 取得元プラットフォームの識別子で、リクエストのplatformと同じです(例:xiaohongshu、tiktok)。 |
エラーと課金
- 401
- キーが未指定か無効です。
- 402
- 残高が不足しています。先にチャージしてください。
- 422
- パラメータ名または値が無効です。エラーに含まれる候補を参考に修正してください。課金はされません。
- 429
- 1分あたりのリクエスト上限に達しました。Retry-Afterの指定に従って待ってから再試行してください。
- 503
- 処理を完了できませんでした。保留中の請求額は残高に戻されます。結果が不明な場合は、再試行する前に確認してください。
- 200(空)
- データがありません。課金はされません。