Digital Platform API - インベントリ可用性レポート
インベントリ可用性レポートでは、プラットフォームで使用可能なインベントリの種類に関する分析情報が提供されます。 これらのレポートは、要求によってのみ使用できます。 サポート ポータルを使用します。 インプレッションの可用性データベースの構造により、レポートのディメンションは以下に示すものに制限されます。 以下の点にもご注意ください。
- Microsoft のデータベースには、30 日分の履歴インベントリ可用性データが含まれています。 したがって、レポートはこの期間に制限されます。
- モバイルインプレッションには、追加のレポート制限が適用される場合があります。 詳細については、Xandr の担当者にお問い合わせください。
時間枠
このレポートは、カスタム時間枠に対して実行し、レポート要求の フィールド start_date
と end_date
フィールドを設定できます。 これらのフィールドの詳細については、「 Report Service」を参照してください。
データ保持期間
このレポートのデータは 30 日間保持されます。
Dimensions
Column | 種類 | フィルター。 | 例 | 説明 |
---|---|---|---|---|
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 ("既定のエラー"): タイムアウトの問題が原因で配信された既定のクリエイティブ。- 4 ("Default"): 有効な入札がないため、既定のクリエイティブが配信されました。- 5 ("保持"): 広告主のクリエイティブがパブリッシャーのサイトで配信されました。- 6 ("Resold"): 発行元の印象がサード パーティの購入者に販売されました。- 7 ("RTB"): 広告主のクリエイティブがサード パーティの広告枠で配信されました。- 8 ("PSA エラー"): タイムアウトの問題または既定のクリエイティブがないため、パブリック サービスのお知らせが提供されました。- 9 ("外部インプレッション"): インプレッション トラッカーからのインプレッション。- 10 ("外部クリック"): クリック トラッカーからのクリック。 |
media_type_id |
int | はい | 5 |
特定のメディアの種類に関連付けられている ID。 たとえば、ビデオです。 詳細については、「 Media Type Service」を参照してください。 |
audit_type_id |
int | はい | 2 |
監査の優先順位の整数コード。 有効な値は次のとおりです。 - 1 :標準- 2 :優先 順位 |
browser_id |
int | はい | 3 |
特定のブラウザーに関連付けられている ID。 たとえば、Microsoft Edge などです。 詳細については、「 ブラウザー サービス」を参照してください。 |
mobile_application |
文字列 | いいえ | "Angry Birds (com.rovio.angrybirds)" |
モバイル アプリケーションの名前の後に、Xandr の形式の ID が続きます。 |
language_id |
int | はい | 1 |
特定のブラウザーに関連付けられている ID。 たとえば、英語です。 詳細については、「 Language Service」を参照してください。 |
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 (タブレット)- 4 (テレビ)- 5 (ゲーム コンソール)- 6 (メディア プレーヤー)- 7 (トップ ボックスの設定) |
指標
Column | 型 | 例 | 式 | 説明 |
---|---|---|---|---|
imps |
int | 1000 |
Imps | 使用可能なインプレッションの数。 |
例
JSON 形式のレポート要求を作成する
JSON ファイルには、 report_type
"platform_inventory_avail"
と、取得する columns
(ディメンションとメトリック) が report_interval
含まれている必要があります。 また、特定のディメンションをフィルター処理し、粒度 (year
、、) を定義し、month
day
データを返す形式 (csv
、、excel
またはhtml
) を指定することもできます。 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
Report サービスへの要求
$ 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
Report Download サービスからのレポート データ
レポート データをファイルにダウンロードするには、レポート ID を使用して別 GET
の呼び出しを行いますが、今回は report-download サービスに対して呼び出します。 サービスとレポート 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 行の制限があります。