購入マーケティング API(Buy Marketing API)
Marketing API は、ベストセラーなどの指標に基づいて eBay 製品を取得するほか、購入され閲覧された製品も取得します。返される epid を Browse API の search メソッドで使用して、該当製品のアイテムを取得できます。
バージョン: v1_beta.2.0
ベースURL: https://api.ebay.com/buy/marketing/v1_beta
認証(OAuth スコープ)
この API は クライアント資格情報(Client Credentials) フローを使用します。
| スコープ | 説明 |
https://api.ebay.com/oauth/api_scope/buy.marketing | マーケティングデータの表示 |
リソース一覧
Buy Marketing API は以下の 1 リソース、合計 1 エンドポイント(GET)で構成されています。
merchandised_product(1 エンドポイント)
GET /merchandised_product
getMerchandisedProducts — 指定されたカテゴリとメトリックに基づいて製品の配列を返します。eBay 製品 ID(EPID)、タイトル、ユーザーレビューと評価などの製品詳細が含まれます。
制限事項:
- サンドボックスでテストするには、カテゴリ ID
9355 を使用してください。レスポンスはモックデータになります。
- サポートされているサイトとその他の制限事項については、API 制限事項を参照してください。
| パラメータ | 場所 | 必須 | 説明 |
aspect_filter | クエリ | 任意 | アスペクト名/値のペアで製品結果を絞り込みます。例: aspect_filter=Brand:Canon |
category_id | クエリ | 必須 | 返される製品を特定の eBay カテゴリに限定します。最大: 1 |
limit | クエリ | 任意 | 結果セットで返される製品の最大数。デフォルト: 8、最大: 100 |
metric_name | クエリ | 必須 | 結果セットをフィルタリングするメトリック。現在は BEST_SELLING のみサポート。 |
レスポンス: 200 / 400 / 409 / 500
スキーマ定義(全 9 スキーマ)
BestSellingProductResponse
| フィールド | 型 | 説明 |
merchandisedProducts | array[MerchandisedProduct] | 製品の配列 |
MerchandisedProduct
| フィールド | 型 | 説明 |
averageRating | string | 平均評価 |
epid | string | eBay 製品 ID |
image | Image | 製品画像 |
marketPriceDetails | array[MarketPriceDetail] | 市場価格の詳細 |
ratingAspects | array[RatingAspect] | 評価アスペクト |
ratingCount | integer | 評価の総数 |
reviewCount | integer | レビューの総数 |
title | string | 製品タイトル |
MarketPriceDetail
| フィールド | 型 | 説明 |
conditionGroup | string | コンディショングループ |
conditionIds | array[string] | コンディション ID の配列 |
estimatedStartPrice | Amount | 推定開始価格 |
RatingAspect
| フィールド | 型 | 説明 |
count | integer | この評価アスペクトの数 |
description | string | 評価アスペクトの説明 |
name | string | 評価アスペクト名 |
ratingAspectDistributions | array[RatingAspectDistribution] | 分布 |
RatingAspectDistribution
| フィールド | 型 | 説明 |
count | integer | カウント |
value | string | 値 |
Amount
| フィールド | 型 | 説明 |
currency | string | 通貨コード |
value | string | 金額 |
Image
| フィールド | 型 | 説明 |
height | integer | 高さ(ピクセル) |
imageUrl | string | 画像 URL |
width | integer | 幅(ピクセル) |
Error / ErrorParameter
標準エラースキーマ(他の API と同一構造)。
エンドポイント一覧(全 1 エンドポイント)
| メソッド | エンドポイント | operationId | 説明 |
| GET | /merchandised_product | getMerchandisedProducts | 指標に基づく製品の取得 |