Digital Platform API - キュレーター分析レポート

キュレーター分析レポートは、キュレーターに、キュレーションされた市場内で需要から供給にお金がどのように流れているかについての洞察を提供します。

レポートを取得する手順については、「 Report Service 」または次の 例 を参照してください。

時間枠

JSON 要求の report_interval フィールドは、次のいずれかに設定できます。

• last_hour
• 今日
• yesterday
• month_to_date
• last_month
• 有効期間

データ保持期間

このレポートのデータは、1100 日間保持されます。

45 日より前の日付を含む時間範囲

report_intervalを "lifetime" に設定してキュレーター分析レポートを作成すると、そのレポートは (含まれているメトリックに関係なく) "リソース集中型" レポート用の特別なキューに追加されます。 その結果、レポートの完成に通常より時間がかかる場合があります。 また、リソースを大量に消費するこれらのレポートは、要求されるデータの量が原因で、完了する前に失敗する可能性があります。 レポートを完了できなかった場合は、通知が届きます。 レポート要求が失敗するか削除された場合は、次の操作を実行できます。

• 後でレポートを再実行します。
• curator_analytics 以外のレポートの種類を使用します。
• レポートの構成方法を変更し (可能であれば)、45 日前よりも前の日付を含めないようにします。

Dimensions

指標

例

JSON 形式のレポート要求を作成する

JSON ファイルには、取得するcolumns (サイズとメトリック) とreport_intervalだけでなく、"curator_analytics"のreport_typeを含める必要があります。 また、特定のディメンションをフィルター処理したり、粒度 (year、 month、 day) を定義したり、データを返す形式 (csv、 excel、 html) を指定したりすることもできます。 JSON ファイルに含めることができるフィールドの詳細については、「 レポート サービス」を参照してください。

$ cat curator_analytics

{
    "report": {
        "columns": [
            "hour",
            "buyer_member_name",
            "curated_deal",
            "imps",
            "curator_revenue",
            "curator_margin"
        ],
        "format": "csv",
        "report_interval": "today",
        "report_type": "curator_analytics"
    }
}

POST レポート サービスへの要求

$ curl -b cookies -X POST -d @curator_analytics 'https://api.appnexus.com/report'

{
   "response":{
      "status":"OK",
      "report_id":"6b177543a9411ffa67b09bdf5e76cac1"
   }
}

GET レポート サービスからのレポートの状態

レポート ID を使用して GET 呼び出しを行い、レポートの状態を取得します。 execution_statusが"ready"されるまで、このGET呼び出しを続けます。 次に、次の手順で説明するように、 レポート ダウンロード サービスを使用して、レポート データをファイルに保存します。

$ curl -b cookies 'https://api.appnexus.com/report?id=6b177543a9411ffa67b09bdf5e76cac1'
{
   "response":{
      "status":"OK",
      "report":{
         "name":null,
         "created_on":"2020-08-25 13:03:37",
         "json_request":"{\"report\":{\"report_type\":\"curator_analytics\",\"columns\":[\"hour\",\"buyer_member_name\",\"curated_deal\",\"imps\",\"curator_revenue\",\"curator_margin\"],\"report_interval\":\"today\",\"format\":\"csv\",\"grouping\":{\"additional_grouping_sets\":[],\"unselected_implicit_groupings\":[],\"additional_groups_on_bottom\":true},\"timezone\":\"UTC\",\"filters\":[{\"member_id\":\"123456\"}],\"reporting_decimal_type\":\"decimal\",\"use_cache\":true},\"extraction_version\":\"refactored\",\"end_date\":1598400000,\"start_date\":1598313600,\"user_id\":\"987654\"}",
         "url": "report-download?id=6b177543a9411ffa67b09bdf5e76cac1"
      },
      "execution_status":"ready"
   }
}

GET レポート ダウンロード サービスからのレポート データ

レポート データをファイルにダウンロードするには、レポート ID を使用して別の GET 呼び出しを行います。今回は レポート ダウンロード サービスに対して呼び出します。 サービスとレポート ID は、前のGET応答の url フィールドにあります。 保存するファイルを特定する際は、最初のPOSTで指定した"format"のファイル拡張子を使用してください。

$ curl -b cookies 'https://api.appnexus.com/report-download?id=6b177543a9411ffa67b09bdf5e76cac1' > /tmp/curator_analytics.csv