Developer Analytics API

Developer Analytics API 概要 (Analytics API Overview)

バージョン：v1_beta.0.1

Developer Analytics API は、ユーザーに対してRESTful APIおよびTrading APIの使用状況に関する重要な情報を提供します。また、それらの使用状況を、各APIまたはAPIメソッド/コールごとに設定された呼び出し割当（コールクォータ）と比較した情報も提供します。

特定のメソッドやコールの制限に対する使用状況に関連するデータは、「レート制限（rate-limit）」データと呼ばれます。Developer Analytics APIを使用することで、ユーザー単位またはアプリケーション単位でこのレート制限データを取得できます。

技術概要 (Technical overview)

Developer Analytics APIの主なリソースは以下の通りです：

  • rate_limit
  • user_rate_limit

これらのリソースに含まれる GET メソッドは、それぞれアプリケーションおよびユーザーのレート制限データを返します。レート制限データは以下の情報で構成されます：

  • count - 指定された時間枠内にユーザーが関連リソースに対して行った呼び出しの数。
  • limit - クォータ。指定された時間枠内にリソースに対して行うことができるリクエストの総数。
  • remaining - クォータに達するまでに、ユーザーまたはアプリケーションが関連リソースに対して行うことができる残りのリクエスト数。
  • reset - limit および remaining の値がリセットされる日時。
  • timeWindow - クォータが適用される時間枠の長さ（秒単位で表示）。

ビジネスユースケース (Business use cases)

以下は、Developer Analytics APIの主なユースケースです：

  • アプリケーションの呼び出し制限データを取得する
  • ユーザーの呼び出し制限データを取得する

このAPIのメソッドによって返されるデータを使用することで、ユーザーは現在のリソース使用状況を確認し、各リソースに与えられたクォータと比較できます。開発者は、クォータがリセットされるまでの残りリクエスト数に応じてアクションを実行できます。もしユーザーまたはアプリケーションが呼び出し制限に達する恐れがある場合、開発者は少なくとも時間枠がリセットされるまで、プログラムによってリクエストレートを制限（スロットリング）することができます。

アプリケーションの呼び出し制限データの取得

各アプリケーションは、eBayが指定した時間枠内に、任意のリソースに対して設定された回数のリクエストを行うことができます。getRateLimits メソッドは、一連のリソースの呼び出し制限データを返します。返される各リソースについて、呼び出し制限データには、指定された時間枠内にアプリケーションがそのリソースに対して行える呼び出し数、ユーザーがそのリソースに行った呼び出し数、現在の時間枠での残り呼び出し数、リセット日時、およびリソースに指定された時間枠の長さが含まれます。

注: 1日あたりの呼び出し制限に加えて、一部のAPIメソッドには「短時間呼び出しレート制限」が適用されます。これらのメソッドでは、timeWindow の値が 86400（秒、1日に相当）であるものと、300（秒）などの非常により短い timeWindow の値が表示されます。

以下は、1日あたりの呼び出し制限と短時間呼び出し制限を持つ getRateLimits メソッドのレスポンス例です。 

 {
  "apiContext": "sell",
  "apiName": "fulfillment",
  "apiVersion": "v1",
  "resources": 
    [{
    "name": "sell.fulfillment.payment_dispute_detail",
    "rates":[{
      "limit": 250000,
      "remaining": 249940,
      "reset": "2026-09-01T07:00:00.000Z",
      "timeWindow": 86400
      },
      { 
      "limit": 5000,
      "remaining": 5000,
      "reset": "2026-09-01T02:00:00.000Z",
      "timeWindow": 300
      }]
    }]
}

ユーザーの呼び出し制限データの取得

アプリケーション固有の呼び出し制限データを取得するために getRateLimits を使用するのと同様に、getUserRateLimits メソッドを使用して、アプリケーションの特定のユーザーに関する呼び出し制限データを取得します。

API制限 (API restrictions)

Developer Analytics APIは、マーケットプレイスやユーザーによる制限はありません。

トップに戻る