Buy Marketing API ドキュメント

マーケティング API（Buy Marketing API）

Marketing API は eBay Buy API の一部です。ベストセラーなどの指標に基づいて eBay 商品を取得します。この API は買い物客が商品を比較し、購入意欲を高めるのに役立ちます。他の Buy API と組み合わせて、eBay サイトを訪問せずに eBay セラーから購入できるアプリケーションを構築できます。

バージョン: 1.1.0

ベースURL: https://api.ebay.com/buy/marketing/v1

認証（OAuth スコープ）

この API は クライアント資格情報（Client Credentials） フローを使用します。

スコープ説明
https://api.ebay.com/oauth/api_scope/buy.marketingマーケティングデータの表示

リソース一覧

Buy Marketing API は 3 リソース、合計 3 エンドポイント（すべて GET）で構成されています。

リソース説明数
merchandised_product指標に基づく商品の取得1
most_watched_items最もウォッチされているアイテムの取得1
similar_items類似アイテムの取得1

merchandised_product（1 エンドポイント）

GET /merchandised_product

getMerchandisedProducts — 指定されたカテゴリとメトリックに基づいて商品の配列を返します。eBay 商品 ID（EPID）、タイトル、ユーザーレビューと評価などの商品詳細が含まれます。返された epid を Browse API の search メソッドで使用して商品アイテムを取得できます。

制限事項:

  • サンドボックスでテストするには、カテゴリ ID 9355 を使用してください。レスポンスはモックデータになります。
  • サポートされているサイトとその他の制限事項については、Buy API Support by Marketplace を参照してください。
パラメータ場所必須説明
category_idクエリ必須eBay カテゴリ ID。最大: 1
metric_nameクエリ必須メトリック名。現在は BEST_SELLING のみサポート。
aspect_filterクエリ任意アスペクト名/値のペアで結果を絞り込み。例: Brand:Canon
limitクエリ任意最大結果数。デフォルト: 8、最大: 100

レスポンス: 200 / 400 / 500

most_watched_items（1 エンドポイント）

GET /most_watched_items

getMostWatchedItems — 指定されたカテゴリで最もウォッチされているアイテムを取得します。特定のカテゴリに対して最大 50 件のアイテムを返します。

パラメータ場所必須説明
category_idクエリ必須リーフカテゴリ ID
max_resultsクエリ任意最大結果数。デフォルト: 12、最大: 50
X-EBAY-C-MARKETPLACE-IDヘッダー条件付きマーケットプレイス ID。US 以外では必須。
X-EBAY-C-ENDUSERCTXヘッダー任意アフィリエイト情報を渡すために使用。
Accept-Languageヘッダー任意優先言語とロケール。

レスポンス: 200 / 400 / 500

similar_items（1 エンドポイント）

GET /similar_items

getSimilarItems — 指定されたアイテムに類似するアイテムを取得します。カタログの類似アイテムは同じ商品に関連付けられています。商品に関連付けられていないアイテムは、タイトル、説明、カテゴリなどの属性に基づいて類似アイテムが特定されます。

パラメータ場所必須説明
item_idクエリ必須アイテムの RESTful 識別子。
buying_optionクエリ任意購入オプション: FIXED_PRICE / AUCTION
excluded_category_idsクエリ任意除外するカテゴリ ID（カンマ区切り）
filterクエリ任意フィルタ。現在 itemEndDate のみサポート。
max_resultsクエリ任意最大結果数。デフォルト: 12
X-EBAY-C-MARKETPLACE-IDヘッダー条件付きマーケットプレイス ID。US 以外では必須。
X-EBAY-C-ENDUSERCTXヘッダー任意アフィリエイト情報。
Accept-Languageヘッダー任意優先言語とロケール。

レスポンス: 200 / 400 / 500

主要スキーマ定義（全 23 スキーマ）

BestSellingProductResponse

フィールド型説明
merchandisedProductsarray[MerchandisedProduct]商品の配列

MerchandisedProduct

フィールド型説明
averageRatingstring平均評価
epidstringeBay 商品 ID
imageImage商品画像
marketPriceDetailsarray[MarketPriceDetail]市場価格の詳細
ratingAspectsarray[RatingAspect]評価アスペクト
ratingCountinteger評価の総数
reviewCountintegerレビューの総数
titlestring商品タイトル

MostWatchedItemsResponse

フィールド型説明
mostWatchedItemsarray[MostWatchedItem]最もウォッチされているアイテムの配列

MostWatchedItem

フィールド型説明
buyingOptionsarray[string]購入オプション
categoriesarray[Category]カテゴリ一覧
imageImageアイテム画像
itemHrefstringアイテム URI
itemIdstringアイテム ID
itemLocationItemLocationアイテムの所在地
priceAmount現在価格
shippingOptionsarray配送オプション
titlestringアイテムタイトル
watchCountintegerウォッチ数

SimilarItemsResponse

フィールド型説明
similarItemsarray[SimilarItem]類似アイテムの配列

SimilarItem

フィールド型説明
buyingOptionsarray[string]購入オプション
categoriesarray[Category]カテゴリ一覧
imageImageアイテム画像
itemHrefstringアイテム URI
itemIdstringアイテム ID
priceAmount現在価格
titlestringアイテムタイトル

MarketPriceDetail

フィールド型説明
conditionGroupstringコンディショングループ
conditionIdsarray[string]コンディション ID の配列
estimatedStartPriceAmount推定開始価格

RatingAspect / RatingAspectDistribution

フィールド型説明
countintegerカウント
descriptionstring説明
namestring名前
ratingAspectDistributionsarray[RatingAspectDistribution]分布（value + count）

Amount / Image / Category / ItemLocation

スキーマ主なフィールド
Amountcurrency (string), value (string)
Imageheight (integer), imageUrl (string), width (integer)
CategorycategoryId (string), categoryName (string)
ItemLocationcity (string), country (CountryCodeEnum), postalCode (string), stateOrProvince (string)

その他のスキーマ: FilterField, RangeValue, MarketingAspectFilter, MarketplaceIdEnum, CountryCodeEnum, CurrencyCodeEnum, Error, ErrorDetailV3, ErrorParameter, ErrorParameterV3

エンドポイント一覧（全 3 エンドポイント）

メソッドエンドポイントoperationId説明
GET/merchandised_productgetMerchandisedProducts指標に基づく商品の取得
GET/most_watched_itemsgetMostWatchedItems最もウォッチされているアイテムの取得
GET/similar_itemsgetSimilarItems類似アイテムの取得
トップに戻る