Deal API

Deal API 概要 (Deal API Overview)

バージョン：1.3.0

Deal API を使用すると、サードパーティの開発者は eBay のディール（特価商品）やイベント、およびそれらに関連付けられた商品の詳細を検索・取得できます。

注: これは限定リリース (Limited Release) APIであり、ビジネスユニットによって承認された一部の開発者のみが利用可能です。本番環境（Production）でのアクセス権取得方法については、Buy API Requirements を参照してください。

技術概要 (Technical overview)

Deal APIは、マーケットプレイスごとのイベント発見、ならびにディールおよび商品の取得を促進するために、以下のリソースを活用しています：

  • deal_item – getDealItems メソッドは、ページ分割されたディール商品のセットを返します。結果セットには、指定された検索基準とマーケットプレイスIDに関連付けられたすべてのディール商品が含まれます。
  • event – getEvent メソッドは、適用可能なクーポン、開始日と終了日、イベント規約など、eBayイベントの詳細を取得します。getEvents メソッドは、指定されたマーケットプレイスのすべてのeBayイベントを含む、ページ分割された結果を返します。
  • event_item – getEventItems メソッドは、ページ分割されたイベント商品のセットを返します。結果セットには、指定された検索基準とマーケットプレイスIDに関連付けられたすべてのイベント商品が含まれます。
ヒント: RESTful APIの使用方法の詳細については、Using eBay Restful APIs を参照してください。

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

このセクションでは、Deal APIを使用した高レベルのユースケースの概要を説明します。

ディール商品の取得

getDealItems メソッドを使用して、eBayディールに関連付けられた商品のセットを取得できます。結果セットには、指定されたマーケットプレイスで利用可能なディール商品が含まれます。

注: このメソッドを使用する際は、マーケットプレイスIDが必須です。カテゴリIDによるフィルタリングもサポートされています。

マーケットプレイスのイベント取得

getEvents メソッドを使用して、指定されたマーケットプレイスのすべてのeBayイベントを取得できます。結果セットには、以下のような詳細が含まれます：

  • 適用可能なクーポン
  • イベントの説明
  • 開始日および終了日
  • イベント規約

イベント商品の取得

getEventItems メソッドを使用して、eBayイベントに関連付けられた商品のセットを取得できます。結果セットには、指定されたマーケットプレイスで利用可能なイベント商品が含まれます。

注: このメソッドを使用する際は、マーケットプレイスIDが必須です。カテゴリIDおよび/またはイベントIDによるフィルタリングもサポートされています。

API制限 (API restrictions)

Deal APIに関する以下の制約事項に注意してください。

商品識別子の非互換性

Buy APIの商品識別子は、eBayサイトで使用されている識別子とは一致しません。そのため、Buy APIのRESTfulな商品識別子を、Finding APIなどのeBayレガシーAPIで使用することはできません。ただし、レガシーな商品識別子をお持ちの場合は、Browse APIの getItemByLegacyId メソッドを使用して、対応するRESTfulな商品識別子を見つけることができます。

地域/サイトの制約

すべてのBuy APIがサポートされているeBayサイトのリストについては、Buy API Support by Marketplace を参照してください。

サイトを指定するには、X-EBAY-C-MARKETPLACE-ID リクエストヘッダーにサイト（マーケットプレイスID）を設定します。例：
X-EBAY-C-MARKETPLACE-ID = EBAY_GB

eBay Buy APIの要件

eBay Buy APIは、eBayのサンドボックス環境では誰でも使用できますが、本番環境（Production）での使用は制限されています。本番環境でBuy APIにアクセスするには、標準の適格性要件を満たし、eBayサポート組織からの承認を得て、eBayと契約を締結する必要があります。本番アクセスの詳細については、Production eligibility requirements を参照してください。

レート制限

Deal APIは、アプリケーションに代わって1日に行える呼び出し回数を制限しています。現在のアプリケーションレート制限については、eBay API Call Limits ページを参照してください。

トップに戻る