Digital Platform API - 在庫可用性レポート

在庫可用性レポートは、プラットフォームで利用可能なインベントリの種類に関する洞察を提供します。 これらのレポートは、リクエストによってのみ入手できます。 Microsoft 広告カスタマー サポート ポータルを使用します。 インプレッション可用性データベースの構造上、レポートのサイズは以下に示すものに制限されています。 以下の点にもご注意ください。

  • 当社のデータベースには、30 日間分の過去の在庫可用性データが含まれています。 したがって、レポートはこの期間に制限されます。
  • モバイル インプレッションには、追加のレポート制限が適用される場合があります。 詳細については、Xandr の担当者にお問い合わせください。

時間枠

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

データ保持期間

このレポートのデータは 30 日間保持されます。

Dimensions

種類 フィルター? 説明
day date はい "2023-04-18" インプレッションの日。
month date はい "2023-04" インプレッションの月。
seller_member_id int はい 9876 販売メンバーの内部 ID。
seller_member_name 文字列 いいえ "CNN" 販売者メンバーの表示名。
size string はい "120"x"600" クリエイティブの標準サイズ。 サイズの詳細については、「メンバー サービスから返されるstandard_sizes」を参照してください。
geo_country string はい "US" インプレッションに関連付けられている地理的な国/地域のコード。
imp_type_id int はい 5 インプレッションの種類の ID。 使用可能な値 (かっこ内の関連付けられた型):
- 1 ("Blank"): クリエイティブは提供されません。
- 2 ("PSA"): 有効な入札額がなく、既定のクリエイティブが提供されていなかったために提供された公共サービス広告。
- 3 ("Default Error"): タイムアウトの問題で提供される既定のクリエイティブ。
- 4 ("Default"): 有効な入札単価がなかったために提供されたデフォルトのクリエイティブ。
- 5 ("保持"): 発行元のサイトで提供される広告主のクリエイティブ。
- 6 ("転売"): パブリッシャーのインプレッションが第三者の購入者に販売されました。
- 7 ("RTB"): サードパーティのインベントリで提供される広告主のクリエイティブ。
- 8 ("PSA エラー"): タイムアウトの問題または既定のクリエイティブがないために配信された公共サービスアナウンス。
- 9 ("外部インプレッション"): インプレッション トラッカーからのインプレッション。
- 10 ("外部クリック"): クリック トラッカーからのクリック。
media_type_id int はい 5 特定のメディアの種類に関連付けられた ID。 たとえば、ビデオなどです。 詳細については、「 Media Type Service」を参照してください。
audit_type_id int はい 2 監査の優先順位の整数コード。 有効な値は次のとおりです。
- 1: Standard
- 2: 優先度
browser_id int はい 3 特定のブラウザーに関連付けられている ID。 たとえば、Microsoft Edge などです。 詳細については、「 ブラウザ サービス」を参照してください。
mobile_application 文字列 いいえ "Angry Birds (com.rovio.angrybirds)" モバイル アプリケーションの名前の後に Xandr 形式の ID が続きます。
language_id int はい 1 特定のブラウザーに関連付けられている ID。 たとえば、英語などです。 詳細については、「 言語サービス」を参照してください。
operating_system_family_id int はい 5 特定のオペレーティング システム ファミリに関連付けられている ID。 たとえば、Microsoft Windows などです。 詳細については、「 オペレーティング システム ファミリ サービス」を参照してください。
datacenter_id int はい 001 要求をデマンド パートナーにルーティングするために使用されるデータ センターの ID。
seller_join_date int はい 20220901 販売者メンバーが追加された日付。 1 年未満の場合は、正確な日付が表示されます。1 年を超える場合、参加日は +1 年と表示されます。
mobile_application_id string はい "343200656" (iOS) または "com.rovio.angrybirds" (Android) ターゲット可能な Apple App Store ID、Google Play パッケージ名、または Windows アプリケーション ID。
device_type int はい 1 インプレッションが配信されたデバイス タイプ ID。 使用可能な値は次のとおりです。
- 0 (その他のデバイス)
- 1 (デスクトップ & ノート PC)
- 2 (携帯電話)
- 3 (tablets)
- 4 (tv)
- 5 (ゲーム機)
- 6 (メディア プレーヤー)
- 7 (セットトップボックス)

指標

説明
imps int 1000 imps 獲得可能インプレッション数。

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

JSON ファイルには、取得するcolumns (サイズとメトリック) とreport_intervalだけでなく、"platform_inventory_avail"report_typeを含める必要があります。 また、特定のディメンションをフィルター処理したり、粒度 (yearmonthday) を定義したり、データを返す形式 (csvexcelhtml) を指定したりすることもできます。 JSON ファイルに含めることができるフィールドの詳細については、「 レポート サービス」を参照してください。

$ cat platform_inventory_avail

{
    "report": {
        "columns": [
            "day",
            "seller_member_name",
            "audit_type",
            "size",
            "device_type",
            "operating_system_family",
            "geo_country",
            "imps"
        ],
        "format": "csv",
        "report_interval": "today",
        "report_type": "platform_inventory_avail"
    }
}

POST リクエストをレポート サービスに送信します

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

{
   "response":{
      "status":"OK",
      "report_id":"6b177543a9411ffa67b09bdf5e76cac1"
   }
}

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

$ curl -b cookies 'https://api.appnexus.com/report?id=6b177543a9411ffa67b09bdf5e76cac1'
{
   "response":{
      "status":"OK",
      "report":{
         "name":null,
         "created_on":"2020-08-25 13:03:37",
         "json_request":"{\"report\":{\"report_type\":\"platform_inventory_avail\",\"columns\":[\"day\",\"seller_member_name\",\"audit_type\",\"imps\",\"size\",\"device_type\,\"operating_system_family\,\"geo_country\"],\"report_interval\":\"today\",\"format\":\"csv\",\"grouping\":{\"additional_grouping_sets\":[],\"unselected_implicit_groupings\":[],\"additional_groups_on_bottom\":true},\"timezone\":\"UTC\",\"filters\":[{\"device_type\":\"123456\"}],\"reporting_decimal_type\":\"decimal\",\"use_cache\":true},\"extraction_version\":\"refactored\",\"end_date\":1598400000,\"start_date\":1598313600,\"user_id\":\"987654\"}",
         "url": "report-download?id=6b177543a9411ffa67b09bdf5e76cac1"
      },
      "execution_status":"ready"
   }
}

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

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

注:

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

curl -b cookies 'https://api.appnexus.com/report-download?id=6b177543a9411ffa67b09bdf5e76cac1' > /tmp/platform_inventory_avail.csv

注:

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