Buy Feed API ドキュメント
購入フィード API(Buy Feed API)
Feed API は、eBay の商品と特定のカテゴリ、日付、マーケットプレイスの 1 時間ごとのスナップショット ファイルを含む TSV_GZIP フィード ファイルをダウンロードする機能を提供します。
API に加えて、.NET で書かれたオープンソースの Feed V1 SDK があり、ダウンロードしてファイルを結合し、フィードファイル全体を解凍できます。フィールドフィルターを指定してファイル内のアイテムをキュレートすることも可能です。
バージョン: v1.2.0
ベースURL: https://api.ebay.com/buy/feed/v1
認証(OAuth スコープ)
この API は クライアント資格情報(Client Credentials) フローを使用します。
| スコープ | 説明 |
|---|---|
https://api.ebay.com/oauth/api_scope/buy.item.feed | アイテムフィードの表示 |
リソース一覧
Buy Feed API は以下の 3 リソース、合計 6 エンドポイント(すべて GET)で構成されています。
| リソース | 説明 | 数 |
|---|---|---|
| access | アプリケーション固有のアクセスルール取得 | 1 |
| feed_type | フィードタイプの一覧・詳細取得 | 2 |
| file | フィードファイルの一覧・詳細取得・ダウンロード | 3 |
access — アクセスルール(1 エンドポイント)
GET /access
getAccess — アプリケーションに固有のアクセスルール(権限を持つフィードタイプなど)を取得します。アプリケーションは、特定のマーケットプレイスや、そのマーケットプレイス内の特定の L1 カテゴリに制限される場合があります。この情報を使用して、getFiles メソッドにフィルターを適用できます。
レスポンス: 200 / 204 / 500
feed_type — フィードタイプ(2 エンドポイント)
GET /feed_type
getFeedTypes — ダウンロード可能な 1 つ以上のフィードタイプに関する詳細を取得します。クエリパラメータが未使用の場合は、すべての可能なフィードタイプが返されます。
| パラメータ | 場所 | 必須 | 説明 |
|---|---|---|---|
continuation_token | クエリ | 任意 | 次の結果ページを取得するためのトークン。 |
feed_scope | クエリ | 任意 | フィードファイルの頻度(HOURLY、DAILY、WEEKLY)。現在は DAILY と HOURLY のみサポート。 |
limit | クエリ | 任意 | デフォルト: 20、最小: 20、最大: 100 |
marketplace_ids | クエリ | 任意 | 結果セットに表示するマーケットプレイス。カンマ区切りで複数指定可。 |
レスポンス: 200 / 400 / 500
GET /feed_type/{feed_type_id}
getFeedType — 特定のフィードタイプの詳細を取得し、ニーズへの適用性を判断します。レスポンスを使用して、eBay マーケットプレイスとカテゴリをアプリケーションのアクセス権限と比較できます。
| パラメータ | 場所 | 必須 | 説明 |
|---|---|---|---|
feed_type_id | パス | 必須 | フィードタイプの一意の識別子。getFeedTypes で取得可能。 |
レスポンス: 200 / 400 / 403 / 404 / 500
file — フィードファイル(3 エンドポイント)
GET /file
getFiles — ダウンロード可能なフィードファイルのリストを提供します。各フィードの詳細には、生成日、取得頻度、フィードの種類、fileId、形式(現在は TSV のみ)、適用される eBay マーケットプレイス、スキーマバージョン、バイト単位のサイズ、対象期間が含まれます。
| パラメータ | 場所 | 必須 | 説明 |
|---|---|---|---|
feed_type_id | クエリ | 必須 | フィードタイプの一意の識別子。 |
category_ids | クエリ | 任意 | eBay L1 カテゴリ ID。最大: 20 個。 |
continuation_token | クエリ | 任意 | 次の結果ページ用トークン。 |
feed_scope | クエリ | 任意 | 頻度フィルター(HOURLY、DAILY)。 |
limit | クエリ | 任意 | デフォルト: 20、最小: 20、最大: 100 |
look_back | クエリ | 任意 | 現在から何分前までのフィードファイルを返すか(分単位)。未指定時は約 48 時間以内のファイルを返します。 |
X-EBAY-C-MARKETPLACE-ID | ヘッダー | 必須 | フィードファイルを検索する eBay マーケットプレイス。 |
レスポンス: 200 / 400 / 403 / 500
GET /file/{file_id}
getFile — ファイルの file_id で指定されたダウンロード可能なフィードファイルの詳細を取得します。
| パラメータ | 場所 | 必須 | 説明 |
|---|---|---|---|
file_id | パス | 必須 | フィードファイルの一意の識別子。getFiles で取得可能。 |
X-EBAY-C-MARKETPLACE-ID | ヘッダー | 必須 | フィードファイルが存在する eBay マーケットプレイス。 |
レスポンス: 200 / 400 / 403 / 404 / 500
GET /file/{file_id}/download
downloadFile — 選択した TSV_gzip フィードファイルをダウンロードします。
注: ダウンロードされたファイルは自動的に gzip 圧縮されるため、Accept-Encoding:gzip ヘッダーを指定する必要はありません。指定するとファイルが 2 回圧縮されます。
重要: ファイルが 200 MB を超える場合は、ダウンロードをチャンクでストリーミングする必要があります。Range リクエストヘッダーを使用してチャンクサイズをバイト単位で指定してください。
| パラメータ | 場所 | 必須 | 説明 |
|---|---|---|---|
file_id | パス | 必須 | ダウンロードするフィードファイルの一意の識別子。 |
Range | ヘッダー | 任意 | 部分ダウンロードのバイト範囲。例: bytes=0-102400 |
X-EBAY-C-MARKETPLACE-ID | ヘッダー | 必須 | フィードファイルが属する eBay マーケットプレイス。 |
レスポンス: 200 / 206 / 400 / 403 / 404 / 416 / 500
スキーマ定義(全 16 スキーマ)
ApplicationAccess
| フィールド | 型 | 説明 |
|---|---|---|
accesses | array[Access] | アクセスルールの配列 |
Access
| フィールド | 型 | 説明 |
|---|---|---|
constraints | array[Constraint] | 制約の配列 |
feedType | string | フィードタイプ |
marketplaceId | string | マーケットプレイス ID |
FeedType
| フィールド | 型 | 説明 |
|---|---|---|
description | string | フィードタイプの説明 |
feedTypeId | string | フィードタイプ ID |
lookBack | TimeDuration | ルックバック期間 |
supportedFeeds | array[SupportedFeed] | サポートされるフィード |
supportedSchemas | array[SupportedSchema] | サポートされるスキーマ |
FeedTypeSearchResponse
| フィールド | 型 | 説明 |
|---|---|---|
feedTypes | array[FeedType] | フィードタイプの配列 |
href | string | 現在ページの URI |
next | string | 次ページの URI |
limit | integer | 最大件数 |
total | integer | 総数 |
FileMetadata
| フィールド | 型 | 説明 |
|---|---|---|
access | string | アクセスタイプ |
dimensions | array[Dimension] | ファイルのディメンション |
feedDate | string | フィード日付 |
feedScope | string | フィードスコープ(HOURLY/DAILY) |
feedTypeId | string | フィードタイプ ID |
fileId | string | ファイル ID |
format | string | ファイル形式(TSV) |
marketplaceId | string | マーケットプレイス ID |
schemaVersion | string | スキーマバージョン |
size | integer | バイト単位のサイズ |
span | TimeDuration | 対象期間 |
FileMetadataSearchResponse
| フィールド | 型 | 説明 |
|---|---|---|
fileMetadata | array[FileMetadata] | ファイルメタデータの配列 |
href | string | 現在ページの URI |
next | string | 次ページの URI |
limit | integer | 最大件数 |
total | integer | 総数 |
TimeDuration
| フィールド | 型 | 説明 |
|---|---|---|
unit | string | 時間単位 |
value | integer | 値 |
Dimension / Constraint / SupportedFeed / SupportedSchema / FeedTypeConstraint / ListingMarketplaceFeedTypeConstraint / OutputStream
その他の補助スキーマ(フィードタイプの制約、サポートされるフィード/スキーマの定義など)。詳細は OpenAPI 仕様を参照してください。
Error / ErrorParameter
標準エラースキーマ(他の API と同一構造)。
エンドポイント一覧(全 6 エンドポイント)
| メソッド | エンドポイント | operationId | 説明 |
|---|---|---|---|
| GET | /access | getAccess | アクセスルール取得 |
| GET | /feed_type | getFeedTypes | フィードタイプ一覧 |
| GET | /feed_type/{feed_type_id} | getFeedType | フィードタイプ詳細 |
| GET | /file | getFiles | フィードファイル一覧 |
| GET | /file/{file_id} | getFile | フィードファイル詳細 |
| GET | /file/{file_id}/download | downloadFile | フィードファイルダウンロード |