Feed Beta API ドキュメント

アイテムフィードサービス API(Buy Feed API v1_beta)

限定リリース! これは限定リリース API であり、ビジネスユニットによって承認された一部の開発者のみが利用できます。本番環境でのアクセス取得については、Buy APIs の要件を参照してください。

Feed API は、eBay アイテムを含む TSV_GZIP(タブ区切り値 gzip)フィードファイルと、特定のカテゴリ、日付、マーケットプレイスの 1 時間以内に変更されたアイテムの時間別スナップショットファイルをダウンロードする機能を提供します。

API に加えて、フィードファイルのダウンロード、複数ファイルの結合、解凍を行うオープンソースの Feed SDK(Java)も利用可能です。フィールドフィルターを指定して、ファイル内のアイテムをキュレートすることもできます。

バージョン: v1_beta.35.2

ベースURL: https://api.ebay.com/buy/feed/v1_beta

認証(OAuth スコープ)

この API は OAuth 2.0 認証を使用します。

スコープ説明
https://api.ebay.com/oauth/api_scope/buy.item.feedアイテムフィードへのアクセス

リソース一覧

Buy Feed API (v1_beta) は以下の 4 リソース、各 1 GET エンドポイント、合計 4 エンドポイントで構成されています。

リソース説明
item日次/週次アイテムフィードファイルのダウンロード1
item_groupアイテムグループ(バリエーション)フィードファイルのダウンロード1
item_snapshot時間別スナップショットフィードファイルのダウンロード1
item_priorityアイテムプライオリティ(デルタ)フィードファイルのダウンロード1

フィードファイルの共通事項

  • フィードファイルはバイナリ gzip ファイルです。ファイルが 100 MB を超える場合、Range ヘッダーを使用してチャンクでストリーミングする必要があります。
  • ダウンロードされたファイルは自動的に gzip 圧縮されるため、Accept-Encoding:gzip ヘッダーを指定する必要はありません。
  • フィルターがフィードファイルに適用されます。将来変更される可能性があるため、フィルターが適用されていないかのようにコーディングしてください。
  • レスポンスヘッダー Content-range はデータチャンクの位置を示し、Last-Modified はファイル生成日を示します。

item — アイテムフィード(1 エンドポイント)

GET /item

getItemFeed — TSV_GZIP アイテムフィードファイルをダウンロードします。指定されたカテゴリのすべての子カテゴリのアイテムが含まれます。

2 種類のフィードファイルが生成されます:

  • 日次アイテムフィードfeed_scope = NEWLY_LISTED): 特定の日に出品されたすべての Good 'Til Cancelled アイテム
  • 週次アイテムブートストラップフィードfeed_scope = ALL_ACTIVE): カテゴリ内のすべての Good 'Til Cancelled アイテム

注: ブートストラップファイルは毎週火曜日に生成され、水曜日に利用可能。木曜日のダウンロードを推奨。日次フィードは MST 9AM 以降に利用可能(48〜72 時間の遅延あり)。

パラメータ場所必須説明
Acceptヘッダー必須レスポンス形式。デフォルト: application/json,text/tab-separated-values
X-EBAY-C-MARKETPLACE-IDヘッダー必須eBay マーケットプレイス ID(大文字小文字区別)。例: EBAY_US
Rangeヘッダー必須gzip ファイルのバイト範囲。形式: bytes=startpos-endpos。最大: 100 MB
feed_scopeクエリ必須フィードタイプ。有効値: NEWLY_LISTEDALL_ACTIVE
category_idクエリ必須eBay トップレベル(L1)カテゴリ ID。不動産カテゴリは除外。
dateクエリ条件付き日次フィードの日付(NEWLY_LISTED 時は必須)。形式: yyyyMMdd。3〜14 日前。

レスポンス: 200 / 204 / 206 / 400 / 403 / 404 / 409 / 416 / 500

item_group — アイテムグループフィード(1 エンドポイント)

GET /item_group

getItemGroupFeed — TSV_GZIP アイテムグループフィードファイルをダウンロードします。アイテムグループは、色、サイズ、容量などのアスペクトが異なるアイテムです。

対応する日次/週次のアイテムフィードファイルのコンテンツに基づいて生成されます。アイテムフィード内のアイテムに primaryItemGroupId 値がある場合、その値を使用してアイテムグループ情報が返されます。

パラメータ場所必須説明
Acceptヘッダー必須レスポンス形式。
X-EBAY-C-MARKETPLACE-IDヘッダー必須マーケットプレイス ID。
Rangeヘッダー任意バイト範囲。最大: 100 MB。
feed_scopeクエリ必須フィードタイプ。有効値: NEWLY_LISTEDALL_ACTIVE
category_idクエリ必須トップレベルカテゴリ ID。
dateクエリ条件付き日次フィードの日付(NEWLY_LISTED 時は必須)。形式: yyyyMMdd

レスポンス: 200 / 204 / 206 / 400 / 403 / 404 / 409 / 416 / 500

item_snapshot — 時間別スナップショットフィード(1 エンドポイント)

GET /item_snapshot

getItemSnapshotFeed — 時間別スナップショット TSV_GZIP フィードファイルをダウンロードします。指定された日と時間内に変更されたすべてのアイテムの詳細が含まれます。

スナップショットフィードには新規出品も含まれます。itemCreationDate で識別可能。

重要! availability 列が UNAVAILABLE の場合、itemIdavailability 列のみが入力されます。

スナップショットファイルの生成には 2 時間かかります(例: 9AM のファイルは 11AM 以降に取得可能)。7 日間分のファイルが利用可能。

パラメータ場所必須説明
Acceptヘッダー必須レスポンス形式。
X-EBAY-C-MARKETPLACE-IDヘッダー必須マーケットプレイス ID。
Rangeヘッダー必須バイト範囲。最大: 100 MB。
category_idクエリ必須トップレベルカテゴリ ID。
snapshot_dateクエリ必須スナップショットの日時(UTC)。形式: yyyy-MM-ddThh:00:00.000Z。Feed API は GMT を使用。

レスポンス: 200 / 204 / 206 / 400 / 403 / 404 / 409 / 416 / 500

item_priority — アイテムプライオリティフィード(1 エンドポイント)

GET /item_priority

getItemPriorityFeed — TSV_GZIP アイテムプライオリティフィードファイルをダウンロードします。キャンペーンへのアイテムの追加・削除など、優先アイテムのステータス変更(デルタ)を追跡できます。

重要! 日次フィード(アイテム、アイテムグループ)を消費してからアイテムプライオリティフィードを消費する必要があります。

パラメータ場所必須説明
Acceptヘッダー必須レスポンス形式。
X-EBAY-C-MARKETPLACE-IDヘッダー必須マーケットプレイス ID。
Rangeヘッダー必須バイト範囲。
category_idクエリ必須トップレベルカテゴリ ID。
dateクエリ必須フィードの日付。形式: yyyyMMdd。14 日前まで。

レスポンス: 200 / 204 / 206 / 400 / 403 / 404 / 409 / 416 / 500

主要スキーマ

Buy Feed API (v1_beta) は以下の主要なレスポンススキーマを定義しています。フィードファイルは TSV 形式で返されるため、スキーマはフィールド(列)の定義として機能します。

Item(アイテムフィードの列定義)

アイテムフィードファイルの各行に含まれる主要フィールド:

フィールド説明
itemIdstringアイテムの一意の識別子(RESTful 形式)
titlestringセラーが作成したアイテムのタイトル
imageUrlstringアイテムのプライマリ画像 URL
categorystringカテゴリのラベル(例: Toys & Hobbies|Action Figures)
categoryIdstringカテゴリ ID
sellerUsernamestringセラーの eBay ユーザー名
sellerFeedbackPercentagestringセラーのポジティブフィードバック率
sellerFeedbackScorestringセラーのフィードバックスコア
gtinstringGTIN(UPC/EAN/ISBN)
brandstringブランド名
mpnstringメーカー部品番号
epidstringeBay 製品 ID
conditionIdstringコンディション ID(例: 1000 = 新品)
conditionstringコンディションのテキスト説明
priceValuestringアイテム価格(割引後の場合あり)
priceCurrencystring価格の通貨コード
primaryItemGroupIdstringアイテムグループの一意の識別子
availabilitystringアイテムの利用可能状態: AVAILABLETEMPORARILY_UNAVAILABLEUNAVAILABLE
estimatedAvailableQuantityinteger推定利用可能数量
deliveryOptionsstring利用可能な配送オプション
shippingCoststring最終送料
originalPriceValuestring元の販売価格(取消線価格用)
discountAmountstring割引額
discountPercentagestring割引率
qualifiedProgramsstring対象プログラム(eBay Plus、Authenticity Guarantee 等)

※ 上記は主要フィールドの抜粋です。完全なフィールド一覧は OpenAPI 仕様を参照してください。

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

メソッドエンドポイントoperationId説明
GET/itemgetItemFeedアイテムフィードダウンロード
GET/item_groupgetItemGroupFeedアイテムグループフィードダウンロード
GET/item_snapshotgetItemSnapshotFeed時間別スナップショットダウンロード
GET/item_prioritygetItemPriorityFeedアイテムプライオリティフィードダウンロード
トップに戻る