Digital Platform API - キュレーター セグメントのパフォーマンス レポート

キュレーターセグメントパフォーマンスレポートは、対象セグメントがキュレーションされた取引の全体的なパフォーマンスにどのように貢献しているかをキュレーターに分析します。 レポートには、取引インプレッションに貢献したすべてのターゲット セグメント (含まれるセグメントと除外セグメント) に関するデータが表示されます。 キュレーターの場合、これにはキュレーションされた取引アクティビティがすべて含まれます。

レポートを取得する手順については、 レポート サービス または以下の 例 を参照してください。

時間枠

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

• last_hour
• last_48_hours
• 今日
• yesterday
• last_7_days
• month_to_date
• quarter_to_date
• last_month
• last_30_days

データ保持期間

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

カスタム時間枠のレポートを実行するには、レポート要求の フィールド start_date と end_date フィールドを設定します。 これらのフィールドの詳細については、「 Report Service」を参照してください。

Dimensions

指標

例

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

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

$ cat curator_segment_performance

{
    "report": {
        "report_type": "curator_segment_performance",
        "columns": [
            "curated_deal_id",
            "cureated_deal_name",
            "segment_id",
            "segment_name",
            "targeting_type",
            "targeted_impressions",
            "targeted_curator_revenue"
        ],
        "report_interval": "today",
        "format": "csv"
    }
}

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

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

{
    "response": {
        "status": "OK",
        "report_id": "a2c95fcff2d8759e69cec123364f9b32"
    }
}

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

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

$ curl -b cookies 'https://api.appnexus.com/report?id=a2c95fcff2d8759e69cec123364f9b32'
{
    "response": {
        "status": "OK",
        "report": {
            "name": null,
            "created_on": "2020-09-04 12:46:08",
            "json_request": "{\"report\":{\"report_type\":\"curator_segment_performance\",\"columns\":[\"curated_deal_id\",\"cureated_deal_name\",\"segment_id\",\"segment_name\",\"targeting_type\",\"targeted_impressions\",\"targeted_curator_revenue\"],\"report_interval\":\"today\",\"format\":\"csv\",\"grouping\":{\"additional_grouping_sets\":[],\"unselected_implicit_groupings\":[],\"additional_groups_on_bottom\":true},\"timezone\":\"UTC\",\"filters\":[{\"curator_member_id\":\"12025\"}],\"reporting_decimal_type\":\"decimal\",\"use_cache\":true},\"extraction_version\":\"refactored\",\"end_date\":1599264000,\"start_date\":1599177600,\"user_id\":\"123456\"}",
            "url": "report-download?id=a2c95fcff2d8759e69cec123364f9b32"
        },
        "execution_status": "ready"
    }
}

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

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

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