次の方法で共有

Bidders - 保存されたレポート サービス

  • [アーティクル]

保存されたレポート サービスを使用して、保存され、いつでも取得できる新しいレポートを作成できます。 これらは、頻繁に実行されるレポートに役立ちます。 保存されたレポート サービスは、 レポート サービスのラッパーとして機能します。

注:

レポートごとに 100,000 行の制限があります。

REST API

HTTP メソッド エンドポイント 説明
DELETE https://api.adnxs.com/saved-report/ID 既存の保存済みレポートを削除します。
取得 https://api.adnxs.com/saved-report メンバーのすべての保存済みレポートを表示します。
取得 https://api.adnxs.com/saved-report/ID 特定の保存されたレポートを表示します。
POST https://api.adnxs.com/saved-report 新しい保存済みレポートを追加します。
PUT https://api.adnxs.com/saved-report/ID 既存の保存済みレポートを変更します。

JSON フィールド

フィールド 種類 説明
category string レポートのカテゴリ。
created_on string 保存されたレポートが作成された日付と時刻。
emails 配列 レポートを送信するメールの一覧。 配列の形式は ["email_address1@domain.com", , "email_address2@domain.com"...] である必要があります。
entity_id int レポートを作成するユーザーのエンティティ ID。 これにより、レポートのスコープが設定されます。
expires_on string 保存されたレポートの有効期限が切れる日付と時刻。 これは現在、1 年後に制限されています。 日付/時刻は、時刻が 24 時間形式で指定されている "YYYY-MM-DD HH:MM:SS" 形式で指定する必要があります。
必須: POST
format 列挙 レポートの結果を保存する形式。
使用可能な値: "excel" または "csv" です。
id int 保存されたレポートに関連付けられている内部 ID。
必須: PUT
last_activity string 保存されたレポートが最後に変更された日付と時刻。
name string に表示されるレポートの名前。 最大長は 100 文字です。
report object レポート サービスで使用されるのと同じ形式で定義された レポート。
scheduling 列挙 レポートが実行される頻度。 使用可能な値: "daily"、"weekly"、または "monthly"。

例

パブリッシャーの新しい保存済みレポートの追加

    {
    "saved-report": {
        "name": "Seller Platform Billing Report 48 Hours JMS",
        "report": {
            "report_type": "seller_platform_billing",
            "columns": [
                "day",
                "imps",
                "seller_revenue"
            ],
            "timezone": "EST",
            "report_interval": "last_48_hours"
        },
        "scheduling": "daily",
        "format": "excel",
        "emails": [
            "ejones@xandr.com",
            "bsmith@xandr.com"
        ],
        "expires_on": "2014-08-05 11:22:33"
    }
}
 
$ curl -b cookies -c cookies -X POST -d @saved-report.json 'https://api.adnxs.com/saved-report' | json-pp
{
    "response":{
        "status":"OK",
        "count":1,
        "start_element":null,
        "num_elements":null,
        "saved_reports":[
            {
                "id":826,
                "name":"Seller Platform Billing Report 48 Hours JMS",
                "report":{
                    "report_type":"seller_platform_billing",
                    "columns":[
                        "day",
                        "imps",
                        "seller_revenue"
                    ],
                    "timezone":"EST",
                    "report_interval":"last_48_hours",
                    "filters":[
                        {
                            "seller_member_id":"7"
                        }
                    ]
                },
                "scheduling":"daily",
                "format":"excel",
                "emails":[
                    "jschneider@xandr.com",
                    "bsmith@xandr.com"
                ],
                "created_on":"2014-04-16 20:55:59",
                "expires_on":"2014-08-05 11:22:33",
                "category":null,
                "entity_id":null,
                "last_activity":"2014-04-16 20:55:59"
            }
        ]
        }
}

保存されたレポートの実行と取得

$ curl -b cookies -c cookies -X POST 'https://api.adnxs.com/report?saved_report_id=826' 
{
    "response":{
        "existing":false,
        "status":"OK",
        "report_id":"5f45fcccc5c4b4ba6fb9747bf6fc33b9"
        }
}
$ curl -b cookies -c cookies "https://api.adnxs.com/report?id=fa16873114e1d5697091069e45bccec0"
{
    "response":{
        "status":"OK",
        "report":{
            "name":null,
            "created_on":"2014-04-16 21:15:04",
            "json_request":
                                "{\"report\":
                                        {\"report_type\":\"seller_platform_billing\",
                    \"columns\":[
                        \"day\",
                        \"imps\",
                        \"seller_revenue\"
                    ],
                    \"timezone\":\"EST\",
                    \"report_interval\":\"last_48_hours\",
                    \"filters\":[
                        {
                            \"seller_member_id\":\"7\"
                        },
                        {
                            \"seller_member_id\":\"7\"
                        }
                    ]
                }
            }
            "data":"day,imps,seller_revenue\r\n",
        },
        "execution_status":"ready",
   }
}
 
$ curl -b cookies -c cookies -s "https://api.adnxs.com/report-download?id=fa16873114e1d5697091069e45bccec0" > report.csv

既存のレポートの更新

$ cat add-columns-saved-report.json
{
    "saved_report": {
            "report":{
                "report_type":"seller_platform_billing",
                "columns":[
                    "day",
                    "imps",
                    "seller_revenue",
                    "bidder_id"       
                ],
                "timezone":"EST",
                "report_interval":"last_48_hours",
                "filters":[
                    {
                        "seller_member_id":"7"
                    }
                ]
            }
    }
}
 
$ curl -b cookies -c cookies -X PUT -d @add-column-saved-report.json 'https://api.adnxs.com/saved-report?id=826'
{
 "response": {
        "status":"OK",
        "count":1,
        "start_element":null,
        "num_elements":null,
        "id":"826",
        "saved_report":{
            "id":826,
            "name":"Seller Platform Billing Report 48 Hours JMS",
            "report":{
                "report_type":"seller_platform_billing",
                "columns":[
                    "day",
                    "imps",
                    "seller_revenue",
                    "bidder_id"
                ],
                "timezone":"EST",
                "report_interval":"last_48_hours",
                "filters":[
                    {
                        "seller_member_id":"7"
                    }
                ]
            },
            "scheduling":"daily",
            "format":"excel",
            "emails":[
                "jschneider@xandr.com",
                "bsmith@xandr.com"
            ],
            "created_on":"2014-04-16 20:55:59",
            "expires_on":"2014-08-05 11:22:33",
            "category":null,
            "entity_id":null,
            "last_activity":"2014-04-17 16:00:27"
        },
        "dbg":{
            ...
        }
    }
}