推奨 API(Recommendation API)
Recommendation API は、セラーが eBay の出品設定を最適化するために使用できる情報を返します。現在は findListingRecommendations メソッドのみが含まれており、Promoted Listings 広告キャンペーンの設定に役立つ推奨情報を提供します。
バージョン: v1.1.0
ベースURL: https://api.ebay.com/sell/recommendation/v1
認証(OAuth スコープ)
この API は 認可コード(Authorization Code) フローを使用します。
| スコープ | 説明 |
https://api.ebay.com/oauth/api_scope/sell.inventory | 在庫とオファーの表示と管理 |
リソース一覧
Recommendation API は以下の 1 リソース、合計 1 エンドポイント(POST)で構成されています。
listing_recommendation(1 エンドポイント)
POST /find
findListingRecommendations — 推奨タイプ AD の情報を返します。
レスポンスには販売者のリスティング ID の配列が含まれ、各要素に以下の推奨情報が含まれます:
- promoteWithAd — eBay が Promoted Listings キャンペーンへの追加を推奨するかどうか(
RECOMMENDED または UNDETERMINED)。
- bidPercentage — マーケットプレイスで同様に宣伝されている商品の現在のトレンド入札率(広告率)。
| パラメータ | 場所 | 必須 | 説明 |
X-EBAY-C-MARKETPLACE-ID | ヘッダー | 必須 | 推奨を取得する eBay マーケットプレイス。 |
filter | クエリ | 任意 | フィルター。現在は recommendationTypes:{AD} のみ。デフォルト: recommendationTypes:{AD} |
limit | クエリ | 任意 | デフォルト: 10、最大: 500 |
offset | クエリ | 任意 | デフォルト: 0 |
リクエストボディ: リスティング ID の配列(任意)
レスポンス: 200 / 204 / 400 / 500
スキーマ定義(全 8 スキーマ)
Ad
| フィールド | 型 | 説明 |
bidPercentages | array[BidPercentages] | 入札率の配列 |
promoteWithAd | string | 推奨ステータス(RECOMMENDED / UNDETERMINED) |
BidPercentages
| フィールド | 型 | 説明 |
basis | string | 入札率の基準 |
value | string | 入札率の値 |
ListingRecommendation
| フィールド | 型 | 説明 |
listingId | string | 出品 ID |
marketing | Ad | マーケティング推奨情報 |
PagedListingRecommendationCollection
| フィールド | 型 | 説明 |
listingRecommendations | array[ListingRecommendation] | 推奨の配列 |
href | string | 現在のページの URI |
next | string | 次ページの URI |
prev | string | 前ページの URI |
offset | integer | オフセット |
limit | integer | 最大件数 |
total | integer | 総数 |
FindListingRecommendationRequest
| フィールド | 型 | 説明 |
listingIds | array[string] | 推奨を取得するリスティング ID の配列 |
Error
| フィールド | 型 | 説明 |
category | string | エラーカテゴリ |
domain | string | エラードメイン |
errorId | integer | エラー ID |
message | string | 短いメッセージ |
longMessage | string | 詳細メッセージ |
inputRefIds | array[string] | 入力参照 ID |
outputRefIds | array[string] | 出力参照 ID |
parameters | array[ErrorParameter] | エラーパラメータ |
subdomain | string | サブドメイン |
ErrorParameter
| フィールド | 型 | 説明 |
name | string | パラメータ名 |
value | string | パラメータ値 |
エンドポイント一覧(全 1 エンドポイント)
| メソッド | エンドポイント | operationId | 説明 |
| POST | /find | findListingRecommendations | 出品の広告推奨を取得 |