デジタル プラットフォーム API - 購入者取引メトリック

  • [アーティクル]

購入者取引メトリック レポートには、購入者に関連する取引メトリック、パフォーマンス、拒否の理由に関する重要な情報が表示されます。

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

期限

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

  • yesterday
  • last_2_days
  • last_7_days (現在は含まれません)
  • last_14_days
  • last_30_days

データ保持期間

このレポートのデータ保持期間は 30 日間です。

注:

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

Dimensions

Column フィルター。 説明
ask_price はい 取引の要求価格。
deal_alias いいえ 購入者によって取引に割り当てられた名前で、通常は販売者が所有し、名前を付ける購入者固有の名前付け規則があります。
deal_auction_type_name はい 取引のオークションの種類。 取引には、最初の価格、2 番目の価格、固定価格のオークションの種類を指定できます。
deal_id はい インプレッションのトランザクションに関連付けられた取引の ID。
deal_name はい インプレッションのトランザクションに関連付けられた取引。
deal_type_name はい 特定の取引の取引の種類。 取引の種類のオプションは、オープン オークション、プライベート オークション、キュレーション、ファースト ルック、またはプログラムによる保証です。
end_date はい 取引が買い手に提供されなくなった日と時刻。
line_item_id はい 明細の ID。
package_id はい 取引がパッケージに関連付けられている場合は、パッケージの ID。 取引が作成されたパッケージの整数値。 取引がパッケージから作成されなかった場合、この値は 0 になります。
priority はい プライベート オークションの場合のみ、売り手が取引に割り当てた優先順位。
seller_member_id はい 取引を販売した販売者の ID。
seller_member_name はい 取引を販売した販売者。
start_date はい 取引が買い手に提供され始める日時。

指標

Column 種類 フィルター。 説明
ask_price 通貨 はい 取引の要求価格
bid_rate int はい 取引に対する入札率。
bid_requests int はい 入札要求の数。
bids int はい 完了した入札の数。
buyer_media_cost 通貨 はい 購入者への合計コスト。
buyer_cost_ecpm int はい eCPM での買い手への取引のコスト。
buyer_member_id int はい 購入メンバーの ID。 インプレッションが購入されなかった場合、このフィールドには、 229 = PSA、 0 = 空白、または 319 = 既定値のいずれかの値が表示されます。
buyer_member_name 文字列 いいえ 購入メンバーの名前。

注: 名前は "Default" または "Default Error"である可能性があります。つまり、インプレッションの購入者がいず、既定のクリエイティブが配信されました。
day time いいえ オークションの日。
deal_type_name string はい 特定の取引の取引の種類。 取引の種類のオプションは、オープン オークション、プライベート オークション、キュレーション、ファースト ルック、またはプログラムによる保証です。
gross_win_rate int はい 取引の総勝率。
hour time いいえ オークションの時間。

注: 100 日を超えるインプレッションの場合、1 時間ではなく日が返されます。
imps_matched int はい 取引の販売者の設定 (購入者ではなく) に一致するインプレッションの合計数。
imps_won int はい 獲得したインプレッションの合計数。
ineligible_bid_rate int はい 取引に対する不適格な入札のレート。
month time いいえ オークションの月。
net_win_rate int はい 取引の純勝率。
reject_below_floor_count int はい オークションで設定された予約価格を下回るため、拒否された入札の数。
reject_below_floor_ym_count int はい 案件の利回り管理フロア セットを下回るため、拒否された入札の数。
reject_bidder_error_count int はい 入札者エラーが原因で拒否された入札の数。
reject_bidder_error_deal_not_available_count int はい 取引が利用できなくなったために拒否された入札の数。
reject_blocked_by_ad_profile_adserver_count int はい 購入者が入札するクリエイティブに関連付けられている広告サーバーがブロックされているため、入札が拒否された数。
reject_blocked_by_ad_profile_audit_status_count int はい 広告プロファイルが監査状態のためにブロックした入札の数。 これは通常、購入者が未監査のクリエイティブで入札していて、販売者が広告品質の監査されていないクリエイティブをブロックした場合に発生します。
reject_blocked_by_ad_profile_brand_count int はい ブランドの除外が原因で広告プロファイルによってブロックされた入札の数。
reject_blocked_by_ad_profile_category_count int はい 広告プロファイルでクリエイティブのカテゴリが許可されていないために拒否された入札の数。
reject_blocked_by_ad_profile_count int はい 広告プロファイルによって拒否されたすべての入札の合計。
reject_blocked_by_ad_profile_creative_count int はい クリエイティブ広告サーバーが広告プロファイルによってブロックされたために拒否された入札の数。
reject_blocked_by_ad_profile_language_count int はい 広告プロファイルによって広告の言語がブロックされたために拒否された入札の数。
reject_blocked_by_ad_profile_member_count int はい メンバーが広告プロファイルによってブロックされたために拒否された入札の数。
reject_blocked_by_ad_profile_tech_attribute_count int はい 広告プロファイルによって広告の技術属性がブロックされたために拒否された入札の数。
reject_blocked_by_deal_adserver_count int はい 取引に対する広告サーバーの制約によりブロックされた入札の数。
reject_blocked_by_deal_below_floor_count int はい 取引のフロア価格を下回るため、拒否された入札の数。
reject_blocked_by_deal_brand_count int はい 取引によってブランドがブロックされたために拒否された入札の数。
reject_blocked_by_deal_category_count int はい 取引でクリエイティブのカテゴリが許可されていないために拒否された入札の数。
reject_blocked_by_deal_count int はい 取引の制約により拒否されたすべての入札の合計。
reject_blocked_by_deal_creative_count int はい 言語設定が原因で取引によってブロックされた入札の数。
reject_blocked_by_deal_language_count int はい 言語設定が原因で取引によってブロックされた入札の数。
reject_blocked_by_deal_media_subtype_count int はい メディア サブタイプが原因で拒否された入札の数。
reject_blocked_by_deal_payment_type_count int はい 支払いタイプが取引で許可されていないために拒否された入札の数。
reject_blocked_by_deal_size_count int はい 案件のサイズ要件と一致しなかったために拒否された入札の数。
reject_blocked_by_deal_tech_attribute_count int はい 技術的属性が取引によってブロックされたために拒否された入札の数。
reject_blocked_by_dynamic_adserver_count int はい インプレッションリクエスト時に販売者が動的に渡した広告サーバーの制約により拒否された入札の数。
reject_blocked_by_dynamic_brand_count int はい 販売者が渡した入札要求によってブランドが動的にブロックされるため、拒否された入札の数。
reject_blocked_by_dynamic_category_count int はい クリエイティブ カテゴリが販売者によって渡された入札要求によって動的にブロックされるため、拒否された入札の数。
reject_blocked_by_dynamic_language_count int はい 販売者が渡した入札要求によって言語が動的にブロックされるため、拒否された入札の数。
reject_blocked_by_dynamic_tech_attribute_count int はい 売り手によって渡された入札要求によって技術的属性が動的にブロックされるため、拒否された入札の数。
reject_count int はい 拒否された入札の合計数。
reject_invalid_creative_count int はい 購入者が入札した無効なクリエイティブが原因で拒否された入札の数。
reject_invalid_creative_not_ssl_count int はい クリエイティブが SSL で安全なオークションに承認されていないために拒否された入札の数。
reject_other_advertiser_exclusion_count int はい 上記に記載されていない広告主の除外が原因で拒否された入札の合計数。
reject_other_count int はい ここに記載されていない理由で拒否された入札の数。
reject_other_data_protection_count int はい ここに記載されていないデータ セキュリティ上の理由で拒否された入札の合計数。
submitted_bids int はい 送信された入札の数。

例

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

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

$ cat buyer_deal_metrics_report

{
    "report":
    {
        "report_type":"buyer_deal_metrics_report",
        "columns":[
            "hour",
            "seller_member_name",
            "deal_name",
            "start_date",
            "end_date",
            "bids",
            "imps_won",
            "reject_count",
            "media_cost"
        ],
        "report_interval":"last_7_days",
        "format":"csv"
    }
}

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

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

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

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

$ curl -b cookies 'https://api.appnexus.com/report?id=097f59fc3ab7d02c5d60db42081d9b69'
{
   "response":{
      "status":"OK",
      "report":{
         "name":null,
         "created_on":"2010-05-25 19:19:53",
         "json_request":"{\"report\":{\"report_type\":\"buyer_deal_metrics_report\",\"columns\":[\"hour\",
            \"buyer_member_name\",\"deal_name\",\"start_date\",\"end_date\",\"bids\",\"imps_won\",\"media_cost\"],
            \"row_per\":[\"hour\",\"buyer_member_id\",\"deal_id\"],
            \"report_interval\":\"last_7_days\"}}",
         "url": "report-download?id=b97897a7864dd8f34e7457226c7af592"
      },
      "execution_status":"ready"
   }
}

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

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

注:

ダウンロード中にエラーが発生した場合、応答ヘッダーには HTTP エラー コードとメッセージが含まれます。 応答ヘッダーを公開するには、呼び出しで -i または -v を使用します。

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

ヒント

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