Developer Analytics API ドキュメント

Analytics API（Developer Analytics API）

Analytics API は、RESTful API および従来の Trading API に設定されている呼び出し制限（レートリミット）データと割り当て（クォータ）を取得します。アプリケーションレベルまたはユーザーレベルの呼び出し制限情報を取得でき、制限に達する前の残りの呼び出し数、クォータがリセットされるまでの残り時間、クォータが適用される時間枠の長さが含まれます。

バージョン: v1_beta.0.1

ベースURL: https://api.ebay.com/developer/analytics/v1_beta

認証（OAuth スコープ）

この API は 2 つの認証フローを使用します:

getRateLimits — クライアント資格情報（Client Credentials）フロー（アプリケーショントークン）
getUserRateLimits — 認可コード（Authorization Code）フロー（ユーザーアクセストークン）

Client Credentials スコープ:

スコープ	説明
`https://api.ebay.com/oauth/api_scope`	eBay の公開データを表示

Authorization Code スコープ:

スコープ	説明
`https://api.ebay.com/oauth/api_scope/sell.inventory`	在庫とオファーの表示と管理
`https://api.ebay.com/oauth/api_scope/sell.inventory.readonly`	在庫とオファーの表示
`https://api.ebay.com/oauth/api_scope/sell.marketing`	マーケティング活動の表示と管理
`https://api.ebay.com/oauth/api_scope/sell.marketing.readonly`	マーケティング活動の表示
`https://api.ebay.com/oauth/api_scope/commerce.catalog.readonly`	カタログデータの読み取り
`https://api.ebay.com/oauth/api_scope/sell.marketplace.insights.readonly`	マーケットプレイスインサイトの読み取り

リソース一覧

Analytics API は以下の 2 リソース、合計 2 エンドポイント（すべて GET）で構成されています。

リソース	説明	数
rate_limit	アプリケーションの呼び出し制限と使用率データを取得	1
user_rate_limit	ユーザーの呼び出し制限と使用率データを取得	1

rate_limit — アプリケーションの呼び出し制限（1 エンドポイント）

GET `/rate_limit/`

getRateLimits — アプリケーションの呼び出し制限と使用率データを取得します。すべての RESTful API と従来の Trading API のデータが返されます。api_name および api_context パラメータで応答をフィルタリングできます。

認証: クライアント資格情報（Client Credentials）フローで生成されたアクセストークンが必要です。

パラメータ	場所	必須	説明
`api_context`	クエリ	任意	API コンテキストでフィルタリング。値: `buy`、`sell`、`commerce`、`developer`、`tradingapi`
`api_name`	クエリ	任意	API 名でフィルタリング。例: `browse`、`inventory`、`taxonomy`、`tradingapi`

レスポンス: 200 → RateLimitsResponse / 204 / 500

user_rate_limit — ユーザーの呼び出し制限（1 エンドポイント）

GET `/user_rate_limit/`

getUserRateLimits — アプリケーションユーザーの呼び出し制限と使用率データを取得します。ユーザーごとに呼び出しを制限するすべての RESTful API と Trading API のデータが返されます。

認証: 認可コード（Authorization Code）フローで生成されたユーザーアクセストークンが必要です。

パラメータ	場所	必須	説明
`api_context`	クエリ	任意	API コンテキストでフィルタリング。値: `buy`、`sell`、`commerce`、`developer`、`tradingapi`
`api_name`	クエリ	任意	API 名でフィルタリング。例: `browse`、`inventory`、`taxonomy`、`tradingapi`

レスポンス: 200 → RateLimitsResponse / 204 / 500

スキーマ定義（全 6 スキーマ）

レートリミット

RateLimitsResponse

フィールド	型	説明
`rateLimits`	array[RateLimit]	レートリミット情報の配列

RateLimit

フィールド	型	説明
`apiContext`	string	API コンテキスト（例: buy, sell, commerce）
`apiName`	string	API 名（例: browse, inventory）
`apiVersion`	string	API バージョン
`resources`	array[Resource]	リソースごとのレートリミット情報

Resource

フィールド	型	説明
`name`	string	リソース名
`rates`	array[Rate]	レート情報の配列

Rate

フィールド	型	説明
`limit`	integer	時間枠内の最大呼び出し数
`remaining`	integer	制限に達する前の残りの呼び出し数
`reset`	string	クォータがリセットされる日時（UTC ISO 8601）
`timeWindow`	integer	クォータが適用される時間枠（秒）
`count`	integer	現在の時間枠内の呼び出し数

共通スキーマ

Error

フィールド	型	説明
`category`	string	エラーカテゴリ
`domain`	string	エラードメイン
`errorId`	integer	エラー ID
`message`	string	短いメッセージ
`longMessage`	string	詳細メッセージ
`inputRefIds`	array[string]	入力参照 ID
`outputRefIds`	array[string]	出力参照 ID
`parameters`	array[ErrorParameter]	エラーパラメータ
`subdomain`	string	エラーサブドメイン

ErrorParameter

フィールド	型	説明
`name`	string	パラメータ名
`value`	string	パラメータ値

エンドポイント一覧（全 2 エンドポイント）

メソッド	エンドポイント	operationId	認証	説明
GET	`/rate_limit/`	getRateLimits	Client Credentials	アプリケーションの呼び出し制限を取得
GET	`/user_rate_limit/`	getUserRateLimits	Authorization Code	ユーザーの呼び出し制限を取得