デジタル プラットフォーム API - セグメント読み込みレポート

  • [アーティクル]

セグメント読み込みレポートを使用すると、セグメントのピクセル読み込みの合計数や、特定の時点に含まれる一意のユーザー ID の数など、セグメントに関するメトリックを表示できます。

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

注:

共有セグメントを明示的に選択してレポートする必要があります。

時間枠

JSON 要求のフィールドは report_interval 、次のように設定できます。

  • 今日
  • yesterday
  • last_48_hours
  • last_7_days
  • month_to_date

ヒント

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

Dimensions

Column 種類 フィルター。 例 説明
segment_id int はい 220 セグメントの ID。
segment_name string いいえ "Submitted application" セグメントの名前。
segment string いいえ "Submitted application (220)" 非推奨 (2016 年 10 月 17 日現在)。
day time はい 2011-01-06 メトリックをセグメント化する日。
month time はい 2011-01 セグメント メトリックが必要な月。

指標

Column 型 例 説明
total_loads int 28375 セグメント ピクセルが読み込まれた合計回数。
daily_uniques int 556 特定の日にセグメントに追加された一意のユーザー ID の数。 このメトリックを表示するには、日ディメンションを含める必要があります。
monthly_uniques int 10998 特定の月にセグメントに追加された一意のユーザー ID の数。 このメトリックを表示するには、月ディメンションを含める必要があります。
avg_daily_uniques int 675 特定の月の 1 日あたりのセグメントに追加されたユーザーの平均数。 このメトリックを表示するには、月ディメンションを含める必要があります。

例

すべてのセグメントの月単位と平均日単位のメトリックを表示する

  1. レポートの JSON 要求を作成します。

    $ cat segment_load
{
    "report":
    {
        "report_type": "segment_load",
        "columns": [
            "segment_id",
            "segment_name",
            "month",
            "total_loads",
            "monthly_uniques",
            "avg_daily_uniques"
        ],
        "groups": [
            "segment_id",
            "month"
        ],
        "orders": [
            "month"
        ],
        "emails": ["js@email.com"],
        "format": "csv"
    }
}

  2. POST 要求をレポート サービスに送信します。

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

{
    "response":{
        "status":"OK",
        "report_id":"07af1282c9485adcef49c95fa5d7496b"
    }
}

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

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

    $ curl -b cookies -c cookies 'https://api.appnexus.com/report?id=07af1282c9485adcef49c95fa5d7496b'

{
    "response": {
        "status": "OK",
        "report": {
            "name": null,
            "created_on": "2012-02-10 16:41:39",
            "cache_hit": false,
            "fact_cache_hit": false,
            "fact_cache_error": null,
            "json_request": "{\"report\":{\"report_type\":\"segment_load\",\"columns\":
             [\"segment_id\",\"segment_name\",\"month\",\"total_loads\",\"monthly_uniques\",
             \"avg_daily_uniques\"],\"groups\":[\"segment_id\",\"month\"],\"orders\":
             [\"month\"],\"emails\":[\"js@email.com\"],\"row_per\":[\"segment_id\",
             \"month\"]}}",
            "header_info": "Report type:,segment_load\u000d\u000a,\u000d\u000aRun at:,
             2012-02-10 16:41:39\u000d\u000aStart date:,\u000d\u000aEnd date:,\u000d\u000aTimezone:,
             \u000d\u000aUser:,John Smith (10055)\u000d\u000a",
            "url": "report-download?id=07af1282c9485adcef49c95fa5d7496b"
        },
        "execution_status": "ready"
    }
}

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

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

    curl -b cookies -c cookies 'https://api.appnexus.com/report-download?id=07af1282c9485adcef49c95fa5d7496b' > /temp/segement_load.csv

セグメントの日単位のメトリックを表示する 184531

  1. レポートの JSON 要求を作成します。

    注:

    特定のセグメントのメトリックを取得するには、 で segment_idレポートをフィルター処理する必要があります。

    $ cat segment_daily

{
    "report":
    {
        "report_type": "segment_load",
        "columns": [
            "segment_id",
            "segment_name",
            "day",
            "total_loads",
            "daily_uniques"
        ],
        "filters": [
            {
                "segment_id": 184531
            }
        ],
        "groups": [
            "segment_id",
            "day"
        ],
        "orders": [
            "day"
        ],
        "emails": ["js@email.com"],
        "format": "csv"
    }
}

  2. POST 要求をレポート サービスに送信します。

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

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

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

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

    $ curl -b cookies -c cookies 'https://api.appnexus.com/report?id=c5975474b00c68f3cd1db49b8fe758da'

{
    "response": {
        "status": "OK",
        "report": {
            "name": null,
            "created_on": "2012-02-10 15:52:16",
            "cache_hit": false,
            "fact_cache_hit": false,
            "fact_cache_error": null,
            "json_request": "{\"report\":{\"report_type\":\"segment_load\",\"columns\":
             [\"segment_id\",\"segment_name\",\"day\",\"total_loads\",\"daily_uniques\"],
             \"filters\":[{\"segment_id\":184531}],\"groups\":[\"segment_id\",\"day\"],
             \"orders\":[\"day\"],\"emails\":[\"js@email.com\"],\"row_per\":
             [\"segment_id\",\"day\"]}}",
            "header_info": "Report type:,segment_load\u000d\u000a,\u000d\u000aRun at:,
             2012-02-10 15:52:16\u000d\u000aStart date:,\u000d\u000aEnd date:,
             \u000d\u000aTimezone:,\u000d\u000aUser:,John Smith (10356)\u000d\u000a",
            "url": "report-download?id=c5975474b00c68f3cd1db49b8fe758da"
        },
        "execution_status": "ready"
    }
}

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

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

    curl -b cookies -c cookies 'https://api.appnexus.com/report-download?id=c5975474b00c68f3cd1db49b8fe758da' > /temp/segment_load.csv

    注:

    XLSX および Excel ファイルとしてダウンロードする場合、レポートごとに 100,000 行の制限があります。