Feedback API
Feedback API 概要 (Feedback API Overview)
Feedback API には、フィードバック待ちのアイテムの取得、フィードバックエントリの取得と送信、フィードバック評価の概要の提供、およびフィードバックへの返信を行うためのリソースが含まれています。これらのメソッドにより、ユーザーは購入および販売活動全体にわたってフィードバックを管理できます。
RESTful APIの使用方法の詳細については、Using eBay Restful APIs を参照してください。
技術概要 (Technical overview)
このAPIにより、サードパーティの開発者は、バイヤーおよびセラーのフィードバックを取得、返信、および提供することができます。このAPIは、フィードバックのフィルタリングおよびソートされた取得をサポートし、関連性または日付で結果を並べ替えるオプションを提供します。また、ログインステータスに基づいてバイヤーまたはセラーの身元のプライバシーマスキングも提供します。詳細なパフォーマンス分析のために、集計された指標も利用可能です。
メソッド
Feedback API のメソッドは、リソース別に以下の通りです:
awaiting_feedback
- getItemsAwaitingFeedback: このメソッドは、ユーザーの役割に基づいて、ユーザーからのフィードバックが保留中となっている品目(ラインアイテム)のフィルタリングされたリストを取得します。
feedback
- getFeedback: このメソッドは、ユーザーの役割に基づいて、ユーザーからフィードバックが利用可能な品目のフィルタリングされたリストを取得します。
- leaveFeedback: このメソッドは、取引相手(オーダーパートナー)の品目に関連付けられたフィードバックを送信し、追跡および参照目的のための一意のIDを生成します。
feedback_rating_summary
- getFeedbackRatingSummary: このメソッドは、基準によってフィルタリングされた、eBayセラーのフィードバック指標の分類された要約を返します。
respond_to_feedback
- respondToFeedback: このメソッドは、注文内の特定の品目について取引相手から提供されたフィードバックに返信します。
主要なフィールド
以下の主要なフィールドは、複数のリソースで使用されます。
- listingId : このフィールドは、取引に関連付けられた出品の一意の識別子を提供します。getFeedback および getItemsAwaitingFeedback メソッドのレスポンス、および leaveFeedback メソッドのリクエストで使用されます。
- orderLineItemId : このフィールドは、取引に関連するフィードバックの正確な品目を特定します。getFeedback および getItemsAwaitingFeedback メソッドのレスポンス、および leaveFeedback メソッドのリクエストで使用されます。
他のリソースの主要なフィールドは以下の通りです。
awaiting_feedback
- filter : このクエリパラメータは、特定の出品ID、取引に関与したユーザー名、またはフィードバックを提供するユーザーの役割などの指定されたフィルタパラメータに基づいてレスポンスを制限します。getItemsAwaitingFeedback メソッドで使用されます。
feedback
- feedbackId : このパラメータは leaveFeedback メソッドによって返され、respondToFeedback メソッドで必須となります。
- listing_id : getFeedback メソッドの結果を絞り込むためのクエリパラメータとして使用されます。
- order_line_item_id : 注文品目IDに関連する特定のフィードバックエントリを取得するために、このフィールドを使用します。
- userId : このフィールドは、フィードバックを行ったユーザーの一意の識別子を示し、getFeedback メソッドのレスポンスで取得されます。
- user_id : getFeedback メソッドの結果を絞り込むためのクエリパラメータとして使用されます。
- transaction_id : このフィールドは、getFeedback メソッドで指定された取引IDに関連付けられた結果に絞り込むためのクエリパラメータとして使用されます。
feedback_rating_summary
- feedbackMetrics : この配列には、getFeedbackRatingSummary メソッドのレスポンス内の metricName および metricValue フィールドに集計されたフィードバックが含まれます。
respond_to_feedback
- feedback_id : このパラメータは、respondToFeedback メソッドで必須です。
ビジネスユースケース (Business use cases)
セラーとバイヤーは、Feedback API を使用して、購入および販売活動全体のフィードバックを管理できます。以下のリストは、Feedback API が対応する高レベルのユースケースの概要です。詳細については、Handling feedback を参照してください。
- フィードバック待ちアイテムの取得
- フィードバックの取得
- AIフィルタリングされたフィードバックの取得
- フィードバックを残す
- フィードバック評価の概要を取得
- 受け取ったフィードバックへの返信
- 評価テンプレートの使用