App Storeメトリクス一括取得API
一時的に利用できません
この機能は現在復旧作業中です。復旧までは呼び出しが失敗するか、結果が返されないことがほとんどです。失敗した呼び出しと空の結果には課金されません。
APIの稼働状況
- 24時間の稼働状況
- 一時的に利用できません
- 良好/正常
- 利用可能
- 制限あり
- ほぼ停止
過去24時間
過去30日間
app_idsに数値IDを指定して、最大20件のApp Storeアプリのキーワードランキング集計を一度に取得します。各行には、アプリのkeyword_count、そのうち1位、トップ3、トップ10に入っているキーワード数、それらのキーワードの検索ボリュームを示すkeywords_search_volumeが含まれます。対象はUSストアのみで、キーワードデータがないアプリの行は返されません。
POST https://api.everyinfra.com/api/v1/socialを送信し、platformにapp_store、actionにbulk_metricsを指定します。 料金は1,000リクエストあたり$11.51(1回あたり$0.01151)です。失敗した呼び出しと空の結果には課金されません。 同期処理です。時間のかかるジョブでは、ボディに"mode": "async"を追加し、job_idを取得してポーリングしてください。
AIプロンプト
#EveryInfraのApp Store メトリクス一括取得エンドポイント(app_store/bulk_metrics)を使ったデータ収集スクリプトの作成を手伝ってください。
エンドポイントの仕組み:
- リクエスト:ヘッダーにAuthorization: Bearer <API key>を指定して、https://api.everyinfra.com/api/v1/socialにPOSTします。APIキーは環境変数EVERYINFRA_API_KEYから読み込み、ハードコードしないでください。
- リクエストボディでplatformにapp_store、actionにbulk_metricsを指定し、パラメータはparamsの中に入れます。
- 必須パラメータ:
- app_ids: bulk_metrics(1〜20個)またはkeyword_intersection(2〜10個)に渡すアプリで、配列またはカンマ区切りの文字列でAppleの数値IDを指定します。数値IDはアプリのリンクでidの後に続く数字です(例:324684580)。対象は米国ストアのみです。bulk_metricsではアプリごとに1件が返り、データのないアプリは除外されます。
- 任意パラメータ:
- country: bulk_metricsのストアフロントです。対応しているのは米国ストアのみです。省略するかusを指定してください。それ以外の国は呼び出しの実行前に拒否されます。
- limit: この呼び出しで返す最大行数で、1以上の整数で指定します。省略するとデフォルト値が適用されます。また、返される行数がこれより少なくなる場合があります。
- レコードのリストを返します。各レコードの主なフィールド: app_id、keyword_count、top1_keywords、top3_keywords、top10_keywords、keywords_search_volume.
- リクエストボディの例:
{
"platform": "app_store",
"action": "bulk_metrics",
"params": {
"app_ids": [
"324684580",
"1017492454"
]
}
}
- 料金: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 | はい | app_store | プラットフォームの識別子です。値は固定です。 |
action | body | string | はい | bulk_metrics | 機能の識別子です。値は固定です。 |
app_ids | body.params | array | はい | - | bulk_metrics(1〜20個)またはkeyword_intersection(2〜10個)に渡すアプリで、配列またはカンマ区切りの文字列でAppleの数値IDを指定します。数値IDはアプリのリンクでidの後に続く数字です(例:324684580)。対象は米国ストアのみです。bulk_metricsではアプリごとに1件が返り、データのないアプリは除外されます。keyword_intersectionでは各件が、すべてのアプリが順位を得ているキーワード1つに対応します。それ以外の個数は、呼び出しの実行前に拒否されます。 |
country | body.params | string | いいえ | - | bulk_metricsのストアフロントです。対応しているのは米国ストアのみです。省略するかusを指定してください。それ以外の国は呼び出しの実行前に拒否されます。 |
limit | body.params | integer (1–) | いいえ | - | この呼び出しで返す最大行数で、1以上の整数で指定します。省略するとデフォルト値が適用されます。また、返される行数がこれより少なくなる場合があります。 |
コードサンプル
#curl -X POST 'https://api.everyinfra.com/api/v1/social' \
-H "Authorization: Bearer $EVERYINFRA_API_KEY" \
-H 'Content-Type: application/json' \
--data-raw '{
"platform": "app_store",
"action": "bulk_metrics",
"params": {
"app_ids": [
"324684580",
"1017492454"
]
}
}'OpenAPI定義(JSON)サンプルは環境変数EVERYINFRA_API_KEYからAPIキーを読み込みます。コピーしたコードにAPIキーが含まれることはありません。
レスポンス例
#{ "id": "req_…", "platform": "app_store", "action": "bulk_metrics", "results": [ { "app_id": …, "keyword_count": …, "top1_keywords": …, "top3_keywords": …, "top10_keywords": …, "keywords_search_volume": …, "platform": … } ], "count": …, "billing": { "charged": …, "charged_usd": …, "balance_after_usd": …, … }, "quota": { … }}
レスポンスフィールド
#業務データはresultsに含まれます。この表はレコードに含まれうるフィールドの一覧です。プラットフォームに表示されない値を作り出すことはありません。
| フィールド | 意味 |
|---|---|
app_id | プラットフォーム上の意味のまま |
keyword_count | プラットフォーム上の意味のまま |
top1_keywords | プラットフォーム上の意味のまま |
top3_keywords | プラットフォーム上の意味のまま |
top10_keywords | プラットフォーム上の意味のまま |
keywords_search_volume | プラットフォーム上の意味のまま |
platform | 取得元プラットフォームの識別子で、リクエストのplatformと同じです(例:xiaohongshu、tiktok)。 |
エラーと課金
#- 401
- キーが未指定か無効です。
- 402
- 残高が不足しています。先にチャージしてください。
- 422
- パラメータ名または値が無効です。エラーに含まれる候補を参考に修正してください。課金はされません。
- 429
- 1分あたりのリクエスト上限に達しました。Retry-Afterの指定に従って待ってから再試行してください。
- 503
- 処理を完了できませんでした。保留中の請求額は残高に戻されます。結果が不明な場合は、再試行する前に確認してください。
- 200(空)
- データがありません。課金はされません。