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クエリ任意フィードファイルの頻度(HOURLYDAILYWEEKLY)。現在は DAILYHOURLY のみサポート。
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クエリ任意頻度フィルター(HOURLYDAILY)。
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

フィールド説明
accessesarray[Access]アクセスルールの配列

Access

フィールド説明
constraintsarray[Constraint]制約の配列
feedTypestringフィードタイプ
marketplaceIdstringマーケットプレイス ID

FeedType

フィールド説明
descriptionstringフィードタイプの説明
feedTypeIdstringフィードタイプ ID
lookBackTimeDurationルックバック期間
supportedFeedsarray[SupportedFeed]サポートされるフィード
supportedSchemasarray[SupportedSchema]サポートされるスキーマ

FeedTypeSearchResponse

フィールド説明
feedTypesarray[FeedType]フィードタイプの配列
hrefstring現在ページの URI
nextstring次ページの URI
limitinteger最大件数
totalinteger総数

FileMetadata

フィールド説明
accessstringアクセスタイプ
dimensionsarray[Dimension]ファイルのディメンション
feedDatestringフィード日付
feedScopestringフィードスコープ(HOURLY/DAILY)
feedTypeIdstringフィードタイプ ID
fileIdstringファイル ID
formatstringファイル形式(TSV)
marketplaceIdstringマーケットプレイス ID
schemaVersionstringスキーマバージョン
sizeintegerバイト単位のサイズ
spanTimeDuration対象期間

FileMetadataSearchResponse

フィールド説明
fileMetadataarray[FileMetadata]ファイルメタデータの配列
hrefstring現在ページの URI
nextstring次ページの URI
limitinteger最大件数
totalinteger総数

TimeDuration

フィールド説明
unitstring時間単位
valueinteger

Dimension / Constraint / SupportedFeed / SupportedSchema / FeedTypeConstraint / ListingMarketplaceFeedTypeConstraint / OutputStream

その他の補助スキーマ(フィードタイプの制約、サポートされるフィード/スキーマの定義など)。詳細は OpenAPI 仕様を参照してください。

Error / ErrorParameter

標準エラースキーマ(他の API と同一構造)。

エンドポイント一覧(全 6 エンドポイント)

メソッドエンドポイントoperationId説明
GET/accessgetAccessアクセスルール取得
GET/feed_typegetFeedTypesフィードタイプ一覧
GET/feed_type/{feed_type_id}getFeedTypeフィードタイプ詳細
GET/filegetFilesフィードファイル一覧
GET/file/{file_id}getFileフィードファイル詳細
GET/file/{file_id}/downloaddownloadFileフィードファイルダウンロード
トップに戻る