Browse API

Browse API 概要 (Browse API Overview)

バージョン：1.20.4

Browse APIを使用すると、キーワード、カテゴリ、さらには画像などのさまざまな基準でeBayの商品（アイテム）を検索したり、特定の1つまたは複数の商品の詳細を取得したりできます。

技術概要 (Technical overview)

Browse APIを使用することで、キーワード検索やカテゴリ検索を通じて、バイヤーが閲覧するための豊富な商品セレクションを作成できます。

Browse API リソース

Browse APIには以下のリソースが含まれています：

  • item_summary :
    • 商品の検索。キーワード、画像ID（Base64文字列）、カテゴリ、製品、GTIN、またはチャリティIDで検索できます。
    • ヒストグラム（分布図）の作成を可能にする絞り込み情報（refinements）を返します。
    • フィールド値、商品アスペクト、および適合性（compatibility）によって結果をフィルタリングします。
    • 画像ID（Base64文字列）に基づいて、1つの商品または商品グループを検索します。
  • item :
    • 特定の商品（アイテム）の詳細を取得します。
    • アイテムグループ（バリエーション）内のすべての個別商品の詳細を取得します。アイテムグループとは、色、サイズ、ストレージ容量などのアスペクトに違いがある商品の集合です。
    • itemEndDate および estimatedAvailabilityStatus フィールドを確認することで、その出品が購入可能かどうかをチェックします。終了日（EndDate）が過去である場合、その出品情報は取り込むべきではありません。
    • 製品が指定されたアイテムと適合するかどうか（例：特定の車が特定の部品と適合するか）を確認します。
    • 支払い方法のタイプ、ブランド、バイヤー向けの指示など、その商品で利用可能な支払い方法を取得します。
    • レガシーAPIの商品IDを使用して、RESTful APIの商品IDを取得します。

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

Browse APIは、他のBuy API群と組み合わせて使用するように設計されており、一貫性のあるショッピング、ブラウジング、購入アプリケーションを作成できます。例えば、SNSアプリケーションの中にシームレスな購買体験を組み込むことが可能です。詳細については、Integration Guide を参照してください。

検索によるeBay商品の発見

キーワード、カテゴリ、eBayプロダクトID (ePID)、GTIN、画像、チャリティIDを使用して商品を検索し、買い物客に表示したい商品を正確に見つけることができます。適合する商品を検索したり、特定の商品の適合性を確認したりすることも可能です。

検索結果の絞り込み

fieldgroups フィールドを使用して、検索で返される内容を制御できます。デフォルトでは検索条件に一致する商品が返されますが、商品の代わりに（または商品に加えて）、発見された商品の属性（色やサイズなどのすべてのバリエーション）、購入オプション（即決またはオークション）、コンディション、カテゴリを返すように選択できます。これらは「絞り込み（refinements）」と呼ばれます。この情報を使用してヒストグラムを作成することで、買い物客は各絞り込み項目をドリルダウンして検索結果を絞り込むことができます。

商品アスペクトによる検索結果のフィルタリング

aspectDistributions で返された情報を使用して、特定の属性（aspect_filter、例：ブランド）で結果をフィルタリングできます。また、特定の製品と適合する商品（compatibility_filter）で結果を絞り込むこともできます。

フィールド値による検索結果のフィルタリング

フィールドフィルタを使用して、出品形式、商品の状態、価格帯、UPC値、出品終了日、場所、セラーなどのフィールド値を基に結果を絞り込むことができます。1つのメソッドで複数のフィルタを併用可能です。詳細については、Buy API Field Filters を参照してください。

グループ内の各商品または特定商品の詳細取得

商品にバリエーションがある場合、アイテムグループ内の個々の商品の詳細を取得できます。もちろん、特定の1つの商品の詳細を取得することも可能です。

レガシー商品IDまたはSKUを使用した商品詳細の取得

Shopping APIやFinding APIなどのeBayレガシーAPIから返された商品IDを使用して、商品の詳細および、すべてのBuy APIメソッドで使用できるRESTfulな商品IDを取得できます。

API制限 (API restrictions)

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

識別子の非互換性

Buy APIの商品および注文の識別子は、eBayサイトやバイヤー宛のメールで使用されている識別子とは一致しません。そのため、Buy APIの識別子をFinding APIなどのeBayレガシーAPIで使用することはできません。ただし、Browse APIの getItemByLegacyId メソッドでは、eBayレガシーの商品識別子を使用して商品を取得することができます。詳細はBuying Integration Guideの Legacy API compatibility を参照してください。

地域/サイトの制約

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

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

検索メソッドの制限

search および searchByImage メソッドには以下の制限が適用されます：

  • デフォルトでは FIXED_PRICE（即決）商品のみが返されます。ただし、即決とオークションの両方が利用可能な商品は返されます。入札が行われるとアクティブなオークション商品となり、デフォルトでは返されなくなりますが、AUCTION 購入オプションでフィルタリングすることで引き続きアクセス可能です。
  • 検索メソッドが1つの結果セットで返せる商品は最大10,000件です。
  • 検索リクエストでワイルドカード（*）を使用することはできません。例えば、以下のリクエストは許可されません：
    /buy/browse/v1/item_summary/search?q=*phones

eBayのポリシーとルール

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

詳細については、Buying Integration Guideの Production eligibility requirements を参照してください。

レート制限

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

トップに戻る