Bidders - レポート サービス

Report Service は、関心のあるレポート データを購入者と販売者の両方に提供します。 これは、次のような質問に回答するために使用されます。

• どのくらいのお金が費やされましたか?
• 何個の印象が見られましたか?
• 販売されたインプレッション数はいくつですか?
• 収益はどのくらいですか?

これは 読み取り専用サービスです 。 JSON 形式のレポート要求は POST 行われますが、Imp Bus キャッシュ内のデータは変更されません。 レポートを実行するには、ユーザーの "bidder" 種類として認証する必要があります。 各レポートの種類には、独自のメトリック、フィルター処理、およびグループ化オプションが用意されています。

レポートの種類

主なレポートの種類は次のとおりです。

• Bidder Platform 購入者レポート
• プラットフォーム販売者レポート
• Bidder Billing Report API
• 販売者プラットフォーム課金レポート
• 完了したクリエイティブ監査レポート
• Bidder Bid Error Report API

メタデータを表示するための REST API

レポート サービスには、メタデータと実際のデータという 2 つのレイヤーのデータがあります。 メタデータは、使用可能なレポート パラメーターの一覧です。

カスタム レポートを実行するには、JSON 形式の要求が必要です。 フィルター、グループ、または列でデータを要求できます。 フィルターによって結果が除外されます。 などの dayフィルターを持つ要求は、集計されたデータに基づいてフィルター処理されます。 などの個々のパラメーター imps_soldで検索することもできます。

report?meta=report_type

GET https://api.adnxs.com/report?meta=platform_buyer

メタデータの形式は次のとおりです。

{"column":"day","type":"time"}
{"column":"month","type":"time"}
{"column":"geo_country","type":"string"}

メタデータの例

$ curl "https://api.adnxs.com/report/meta/platform_buyer"
  "response": {
    "status": "OK",
 "meta": {
      "columns": [
        {
          "column": "month",
          "type": "time"
        },
        {
          "column": "day",
          "type": "date"
        },
        {
          "column": "hour",
          "type": "date"
        },
      ...
      ],
      "filters": [
        {
          "column": "hour",
          "type": "date"
        },
        {
          "column": "day",
          "type": "date"
        },
        {
          "column": "year",
          "type": "date"
        },
        ...
      ],
      "havings": [
        {
          "column": "clicks"
        },
        {
          "column": "buyer_spend"
        },
        {
          "column": "imps_bought"
        },
        {
          "column": "buyer_ecpm"
        },
        {
          "column": "click_rate_sold"
        }
      ],
      "time_intervals": [
        "current_hour",
        "last_hour",
        "last_48_hours",
        "today",
        "yesterday",
        "last_7_days",
        "month_to_date",
        "quarter_to_date",
        "last_month",
        "lifetime",
        "mtd"
      ]
    }
}

データ取得のための REST API

JSON フィールド

レポートを取得する方法

• 手順 1. JSON 形式のレポート要求を作成する
• 手順 2. 要求をレポート サービスに投稿する
• 手順 3. レポート サービスからレポートの状態を取得する
• 手順 4. レポート ダウンロード サービスからレポート データを取得する

手順 1. JSON 形式のレポート要求を作成する

JSON ファイルには、実行する特定report_typeのファイルと、columns取得する (ディメンションとメトリック) と report_interval ("today"、、"yesterday""month_to_date"など) が含まれている必要があります。 ディメンションにを含 filters め、粒度 (年、月、日) を定義し、データを format 返す必要がある を指定することもできます。 オプションは format 次のとおりです。

• "csv" - コンマ区切りファイル
• "xls" - タブ区切りの M.S. Excel ファイル
• "xlsx" - ネイティブ M.S. Excel 形式

"filters": [{"bid_type": ["learn","optimized"]}, {"geo_country":"US"}]

"filters": [{"bid_type":"learn"}, {"bid_type":"optimized"}, {"geo_country":"US"}]

要求 に 含めることができるフィールドの詳細については、上記の JSON フィールドを参照してください。 使用可能なディメンションとメトリックの完全な一覧については、「 メタデータを表示するための REST API」で説明されているように、実行する特定のレポートの種類に関するドキュメントを参照するか、そのレポートのメタデータをプルします。

$ cat report_request
{
    "report": {
        "report_type": "platform_buyer",
        "report_interval": "last_48_hours",
        "columns": ["day","imps_bought"],
        "filters": [{"geo_country":"US"}],
        "orders": [{"order_by":"day", "direction":"ASC"}],
        "format": "csv"
    }
}

手順 2. POST レポート サービスへの要求

POST JSON 要求を実行し、レポート ID を取得します。

$ curl -b cookies -c cookies -X POST -d @report_request 'https://api.adnxs.com/report?member_id=255'
{
    "response": {
        "status": "OK",
        "report_id": "ca9955709eade9a0e89f5cda5345c12r",
        "dbg_info": {
            ...
        }
    }
}

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

レポート ID を GET 使用して呼び出しを行って、レポートの状態を取得します。 が "ready"になるまでこの呼び出しを"execution_status"続けます。 次に、サービスを report-download 使用して、レポート データをファイルに保存します。 (これについては、次の手順で説明します)。

$ curl -b cookies -c cookies 'https://api.adnxs.com/report/ca9955709eade9a0e89f5cda5345c12r'
{
    "response": {
        "status": "OK",
        "report": {
            "name": null,
            "created_on": "2012-03-13 18:15:48",
            "cache_hit": false,
            "fact_cache_hit": false,
            "json_request": "{\"report\":{\"report_type\":\"network_analytics\",\"report_interval\":
                \"last_48_hours\",\"columns\":[\"day\",\"imps\",\"clicks\"],\"filters\":[{\"geo_country\":
                \"US\"},{\"entity_member_id\":\"514\"},{\"entity_member_id\":null}],\"orders\":
                [{\"order_by\":\"day\",\"direction\":\"ASC\"},{\"order_by\":\"imps\",\"direction\":
                \"DESC\"}]}}",
            "header_info": "Report type:,network_analytics\r\n,\r\nRun at:,2012-03-13 18:15:48\r\nStart date:,
                \r\nEnd date:,\r\nTimezone:,\r\nUser:,John Smith (9385)\r\n",
            "report_size": "10",
            "row_count": "35",
            "url": "report-download?id=ca9955709eade9a0e89f5cda5345c12r"
        },
        "execution_status": "ready",
        "dbg_info": {
            ...
        }
    }
}

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

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

$ curl -b cookies -c cookies 'https://api.appnexus.com/report-download?id=<download_id>

その後、ファイルを開くことができます。

定期的なレポートをスケジュールする

気になるレポートの保存済みバージョンを作成し、指定した間隔でシステムからデータを電子メールで送信することで、レポート プロセスを自動化できます。 これらの自動レポートを設定する方法の詳細については、 保存されたレポート サービスに関するページを参照してください。

関連項目

• 保存されたレポート サービス
• 完了したクリエイティブ監査レポート
• Bidder Platform 購入者レポート
• Bidder Billing Report API
• プラットフォーム販売者レポート
• 販売者プラットフォーム課金レポート
• Bidder Bid Error Report API
• インベントリ可用性レポート
• タイムゾーンのレポート