デジタル プラットフォーム API - 購入者エンゲージメント レポート

購入者エンゲージメント レポートでは、ディスプレイおよびビデオ クリエイティブの表示可能な期間について分析情報を得ることができます。

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

期限

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

• カスタム
• yesterday
• last_7_days
• last_14_days
• month_to_yesterday
• last_30_days

データ保持期間

このレポートのデータは 1 日の時間細分性を持ち、5 週間保持されます。 このレポートには、UTC/GMT タイム ゾーンの下にデータも表示されます。

Dimensions

指標

例

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

JSON ファイルには、 report_type"engagement_report_for_buyers"と、取得する列 (ディメンションとメトリック) と report_interval が含まれている必要があります。 また、特定のディメンションをフィルター処理し、粒度 (年、月、日) を定義し、データを返す形式 (csv、excel、または html) を指定することもできます。 JSON ファイルに含めることができるフィールドの詳細については、「 Report Service」を参照してください。

$ cat engagement_report_for_buyers
  {
    "report":
    {
        "report_type":"engagement_report_for_buyers",
        "columns":[
            "line_item_id",
            "line_item_name",
            "creative_name",
            "viewable_completion_rate",
            "average_viewable_duration",
            "ctr",
            "clicks",
            "imps"
        ],
        "report_interval":"last_7_days",
        "format":"csv"
    }
}

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

$ curl -b cookies -c cookies -X POST -d @engagement_report_for_buyers 'https://api.appnexus.com/report'
{
   "response":{
      "status":"OK",
      "report_id":"097f59fc3ab7d02c5d60db42081d9b69"
   }
}

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

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

$ curl -b cookies -c cookies 'https://api.appnexus.com/report?id=097f59fc3ab7d02c5d60db42081d9b69'
{
   "response":{
      "status":"OK",
      "report":{
         "name":null,
         "created_on":"2021-05-25 19:19:53",
         "json_request":"{\"report\":{\"report_type\":\"engagement_report_for_buyerss\",\"columns\":[\"line_item_id\",
            \"line_item_name\",\"creative_name\",\"viewable_completion_rate\",\"average_viewable_duration\",\"ctr\",\"clicks\",\"imps\"],
            \"report_interval\":\"last_7_days\"}}",
         "url": "report-download?id=b97897a7864dd8f34e7457226c7af592"
      },
      "execution_status":"ready"
   }
}

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

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

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