レビュー – REST API

レビューはEDD REST APIと統合されており、JSONまたはXML形式でレビューを取得できます。

EDD REST APIは/reviews/というエンドポイントを提供します。このレビューエンドポイントを使用すると、データベースにクエリを実行し、ストアのすべての製品に寄せられたレビューのリストを取得できます。基本的なレビューのクエリは次のようになります。

https://yoursite.com/edd-api/reviews/?key=c281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70

返される各レビューには、次の情報が含まれます。

• id – レビューの一意のID
• title – レビューのタイトル
• parent – レビューが返信の場合、これは親レビューのIDを示します
• download_id – このレビューが作成されたダウンロードのID
• download_title – このレビューが作成されたダウンロードのタイトル
• rating – レビュアーによって付けられた評価。返信の場合はnullになります。
• author – レビューの作成者の名前
• email – レビュー作成者のメールアドレス
• IP – レビューが送信されたIPアドレス
• date – レビューが送信された日付
• date_gmt – レビューが送信された日付（GMT形式）
• content – レビューの内容
• status – レビューのステータス。1は承認済み、0は未承認（保留中）を表します。ステータスは「spam」または「trash」になることもあります。
• user_id – レビュー作成者のWordPressユーザーID
• type – レビューか返信かを示します
• votes – このレビューが役に立ったか役に立たなかったかに投票した人の数。返信の場合はnullになります。レビューの場合は、yesとnoのサブキーを持ちます。

レビューのクエリ応答は次のようになります。

{
    "reviews": {
        "total": "2",
        "most_recent": [
            {
                "id": "63",
                "title": null,
                "parent": "60",
                "download_id": "1568",
                "download_title": "Endless Possibilities",
                "rating": null,
                "author": "Sunny Ratilal",
                "email": "[email protected]",
                "IP": "172.17.0.1",
                "date": "2016-07-20 17:24:48",
                "date_gmt": "2016-07-20 17:24:48",
                "content": "Replying to test review",
                "status": "1",
                "user_id": "1",
                "type": "reply",
                "votes": null
            },
            {
                "id": "61",
                "title": "Great read",
                "parent": "0",
                "download_id": "1566",
                "download_title": "eBook",
                "rating": "4",
                "author": "Sunny Ratilal",
                "email": "[email protected]",
                "IP": "172.17.0.1",
                "date": "2016-07-19 19:25:22",
                "date_gmt": "2016-07-19 19:25:22",
                "content": "Well written book",
                "status": "1",
                "user_id": "1",
                "type": "review",
                "votes": {
                    "yes": "3",
                    "no": "0"
                }
            },
        ]
    },
    "request_speed": 0.08372688293457
}

基本クエリには特定のクエリ変数を追加できます。単一のレビューのデータを受信したい場合は、&review_id={identifier}パラメータを追加できます。例：

https://yoursite.com/edd-api/reviews/?key=c281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70&review_id=61

単一レビューの応答は次のようになります。

{
    "reviews": {
        "id": "61",
        "title": "Great read",
        "parent": "0",
        "download_id": "1566",
        "download_title": "eBook",
        "rating": "4",
        "author": "Sunny Ratilal",
        "email": "[email protected]",
        "IP": "172.17.0.1",
        "date": "2016-07-19 19:25:22",
        "date_gmt": "2016-07-19 19:25:22",
        "content": "Well written book",
        "status": "1",
        "user_id": "1"
    },
    "request_speed": 0.0022079944610596
}

単一ダウンロードのすべてのレビューを表示したい場合は、&download_id={identifier}パラメータを追加できます。例：

https://yoursite.com/edd-api/reviews/?key=c281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70&download_id=1568

上記のクエリは、上記と同様の応答を生成しますが、reviewsキーの下に複数のサブキーが含まれます。